pax_global_header00006660000000000000000000000064130062275570014521gustar00rootroot0000000000000052 comment=f19307d2079e3c3854cac887f059655a66c49896 google-api-python-client-1.5.5/000077500000000000000000000000001300622755700163475ustar00rootroot00000000000000google-api-python-client-1.5.5/.coveragerc000066400000000000000000000002231300622755700204650ustar00rootroot00000000000000[report] omit = */samples/* exclude_lines = # Re-enable the standard pragma pragma: NO COVER # Ignore debug-only repr def __repr__ google-api-python-client-1.5.5/.github/000077500000000000000000000000001300622755700177075ustar00rootroot00000000000000google-api-python-client-1.5.5/.github/ISSUE_TEMPLATE.md000066400000000000000000000005501300622755700224140ustar00rootroot00000000000000**Heads up!** We appreciate any bug reports or other contributions, but please note that this issue tracker is only for this client library. We do not maintain the APIs that this client library talks to. If you have an issue or questions with how to use a particular API, you may be better off posting on Stackoverflow under the `google-api` tag. Thank you! google-api-python-client-1.5.5/.gitignore000066400000000000000000000002271300622755700203400ustar00rootroot00000000000000# Build artifacts *.py[cod] google_api_python_client.egg-info/ build/ dist/ # Test files .tox/ # Coverage files .coverage coverage.xml nosetests.xml google-api-python-client-1.5.5/.gitmodules000066400000000000000000000000001300622755700205120ustar00rootroot00000000000000google-api-python-client-1.5.5/.hgignore000066400000000000000000000004361300622755700201550ustar00rootroot00000000000000syntax: glob *.pyc *.pyc-2.4 *.dat .*.swp */.git/* */.cache/* .gitignore .tox samples/buzz/*.dat samples/moderator/*.dat htmlcov/* .coverage database.sqlite3 build/* googlecode_upload.py google_api_python_client.egg-info/* dist/* snapshot/* MANIFEST .project .pydevproject .settings/* google-api-python-client-1.5.5/.travis.yml000066400000000000000000000004151300622755700204600ustar00rootroot00000000000000language: python python: 2.7 sudo: false cache: pip env: matrix: - TOX_ENV=py26 - TOX_ENV=py27 - TOX_ENV=py33 - TOX_ENV=py34 install: - pip install tox - pip install coveralls script: - tox -e $TOX_ENV after_success: coveralls notifications: email: false google-api-python-client-1.5.5/CHANGELOG000066400000000000000000000231611300622755700175640ustar00rootroot00000000000000v1.5.5 Version 1.5.5 Bugfix release - Allow explicit MIME type specification with media_mime_type keyword argument. - Fix unprintable representation of BatchError with default constructor. (#165) - Refresh all discovery docs, not just the preferred ones. (#298) - Update minimum httplib2 dependency to >=0.9.2. v1.5.4 Version 1.5.4 Bugfix release - Properly handle errors when the API returns a mapping or sequence. (#289) - Upgrade to unified uritemplate 3.0.0. (#293) - Allow oauth2client 4.0.0, with the caveat that file-based discovery caching is disabled. v1.5.3 Version 1.5.3 Bugfix release - Fixed import error with oauth2client >= 3.0.0. (#270) v1.5.2 Version 1.5.2 Bugfix release - Allow using oauth2client >= 1.5.0, < 4.0.0. (#265) - Fix project_id argument description. (#257) - Retry chunk uploaded on rate limit exceeded errors. (#255) - Obtain access token if necessary in BatchHttpRequest.execute(). (#232) - Warn when running tests using HttpMock without having a cache. (#261) v1.5.1 Version 1.5.1 Bugfix release - Allow using versions of oauth2client < 2.0.0. (#197) - Check both current and new API discovery URL. (#202) - Retry http requests on connection errors and timeouts. (#218) - Retry http requests on rate limit responses. (#201) - Import guards for ssl (for Google App Engine). (#220) - Use named loggers instead of the root logger. (#206) - New search console example. (#212) v1.5.0 Version 1.5.0 Release to support oauth2client >= 2.0.0. - Fix file stream recognition in Python 3 (#141) - Fix non-resumable binary uploads in Python 3 (#147) - Default to 'octet-stream' if mimetype detection fails (#157) - Handle SSL errors with retries (#160) - Fix incompatibility with oauth2client v2.0.0 (#182) v1.4.2 Version 1.4.2 Add automatic caching for the discovery docs. v1.4.1 Version 1.4.1 Add the googleapiclient.discovery.Resource.new_batch_http_request method. v1.4.0 Version 1.4.0 Python 3 support. v1.3.2 Version 1.3.2 Small bugfix release. - Fix an infinite loop for downloading small files. - Fix a unicode error in error encoding. - Better handling of `content-length` in media requests. - Add support for methodPath entries containing colon. v1.3.1 Version 1.3.1 Quick release for a fix around aliasing in v1.3. v1.3 Version 1.3 Add support for the Google Application Default Credentials. Require python 2.6 as a minimum version. Update several API samples. Finish splitting out oauth2client repo and update tests. Various doc cleanup and bugfixes. Two important notes: * We've added `googleapiclient` as the primary suggested import name, and kept `apiclient` as an alias, in order to have a more appropriate import name. At some point, we will remove `apiclient` as an alias. * Due to an issue around in-place upgrades for Python packages, it's not possible to do an upgrade from version 1.2 to 1.3. Instead, setup.py attempts to detect this and prevents it. Simply remove the previous version and reinstall to fix this. v1.2 Version 1.2 The use of the gflags library is now deprecated, and is no longer a dependency. If you are still using the oauth2client.tools.run() function then include gflags as a dependency of your application or switch to oauth2client.tools.run_flow. Samples have been updated to use the new apiclient.sample_tools, and no longer use gflags. Added support for the experimental Object Change Notification, as found in the Cloud Storage API. The oauth2client App Engine decorators are now threadsafe. - Use the following redirects feature of httplib2 where it returns the ultimate URL after a series of redirects to avoid multiple hops for every resumable media upload request. - Updated AdSense Management API samples to V1.3 - Add option to automatically retry requests. - Ability to list registered keys in multistore_file. - User-agent must contain (gzip). - The 'method' parameter for httplib2 is not positional. This would cause spurious warnings in the logging. - Making OAuth2Decorator more extensible. Fixes Issue 256. - Update AdExchange Buyer API examples to version v1.2. v1.1 Version 1.1 Add PEM support to SignedJWTAssertionCredentials (used to only support PKCS12 formatted keys). Note that if you use PEM formatted keys you can use PyCrypto 2.6 or later instead of OpenSSL. Allow deserialized discovery docs to be passed to build_from_document(). - Make ResumableUploadError derive from HttpError. - Many changes to move all the closures in apiclient.discovery into real - classes and objects. - Make from_json behavior inheritable. - Expose the full token response in OAuth2Client and OAuth2Decorator. - Handle reasons that are None. - Added support for NDB based storing of oauth2client objects. - Update grant_type for AssertionCredentials. - Adding a .revoke() to Credentials. Closes issue 98. - Modify oauth2client.multistore_file to store and retrieve credentials using an arbitrary key. - Don't accept 403 challenges by default for auth challenges. - Set httplib2.RETRIES to 1. - Consolidate handling of scopes. - Upgrade to httplib2 version 0.8. - Allow setting the response_type in OAuth2WebServerFlow. - Ensure that dataWrapper feature is checked before using the 'data' value. - HMAC verification does not use a constant time algorithm. v1.0 Version 1.0 - Changes to the code for running tests and building releases. v1.0c3 Version 1.0 Release Candidate 3 - In samples and oauth2 decorator, escape untrusted content before displaying it. - Do not allow credentials files to be symlinks. - Add XSRF protection to oauth2decorator callback 'state'. - Handle uploading chunked media by stream. - Handle passing streams directly to httplib2. - Add support for Google Compute Engine service accounts. - Flows no longer need to be saved between uses. - Change GET to POST if URI is too long. Fixes issue #96. - Add a keyring based Storage. - More robust picking up JSON error responses. - Make batch errors align with normal errors. - Add a Google Compute sample. - Token refresh to work with 'old' GData API - Loading of client_secrets JSON file backed by a cache. - Switch to new discovery path parameters. - Add support for additionalProperties when printing schema'd objects. - Fix media upload parameter names. Reviewed in http://codereview.appspot.com/6374062/ - oauth2client support for URL-encoded format of exchange token response (e.g. Facebook) - Build cleaner and easier to read docs for dynamic surfaces. v1.0c2 Version 1.0 Release Candidate 2 - Parameter values of None should be treated as missing. Fixes issue #144. - Distribute the samples separately from the library source. Fixes issue #155. - Move all remaining samples over to client_secrets.json. Fixes issue #156. - Make locked_file.py understand win32file primitives for better awesomeness. v1.0c1 Version 1.0 Release Candidate 1 - Documentation for the library has switched to epydoc: http://google-api-python-client.googlecode.com/hg/docs/epy/index.html - Many improvements for media support: * Added media download support, including resumable downloads. * Better handling of streams that report their size as 0. * Update Media Upload to include io.Base and also fix some bugs. - OAuth bug fixes and improvements. * Remove OAuth 1.0 support. * Added credentials_from_code and credentials_from_clientsecrets_and_code. * Make oauth2client support Windows-friendly locking. * Fix bug in StorageByKeyName. * Fix None handling in Django fields. Reviewed in http://codereview.appspot.com/6298084/. Fixes issue #128. - Add epydoc generated docs. Reviewed in http://codereview.appspot.com/6305043/ - Move to PEP386 compliant version numbers. - New and updated samples * Ad Exchange Buyer API v1 code samples. * Automatically generate Samples wiki page from README files. * Update Google Prediction samples. * Add a Tasks sample that demonstrates Service accounts. * new analytics api samples. Reviewed here: http://codereview.appspot.com/5494058/ - Convert all inline samples to the Farm API for consistency. v1.0beta8 - Updated meda upload support. - Many fixes for batch requests. - Better handling for requests that don't require a body. - Fix issues with Google App Engine Python 2.7 runtime. - Better support for proxies. - All Storages now have a .delete() method. - Important changes which might break your code: * apiclient.anyjson has moved to oauth2client.anyjson. * Some calls, for example, taskqueue().lease() used to require a parameter named body. In this new release only methods that really need to send a body require a body parameter, and so you may get errors about an unknown 'body' parameter in your call. The solution is to remove the unneeded body={} parameter. v1.0beta7 - Support for batch requests. http://code.google.com/p/google-api-python-client/wiki/Batch - Support for media upload. http://code.google.com/p/google-api-python-client/wiki/MediaUpload - Better handling for APIs that return something other than JSON. - Major cleanup and consolidation of the samples. - Bug fixes and other enhancements: 72 Defect Appengine OAuth2Decorator: Convert redirect address to string 22 Defect Better error handling for unknown service name or version 48 Defect StorageByKeyName().get() has side effects 50 Defect Need sample client code for Admin Audit API 28 Defect better comments for app engine sample Nov 9 63 Enhancement Let OAuth2Decorator take a list of scope google-api-python-client-1.5.5/LICENSE000066400000000000000000000013771300622755700173640ustar00rootroot00000000000000 Copyright 2014 Google Inc. All Rights Reserved. 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. Dependent Modules ================= This code has the following dependencies above and beyond the Python standard library: uritemplates - Apache License 2.0 httplib2 - MIT License google-api-python-client-1.5.5/MANIFEST.in000066400000000000000000000001701300622755700201030ustar00rootroot00000000000000recursive-include apiclient *.json *.py include CHANGELOG include LICENSE include README include FAQ include setpath.sh google-api-python-client-1.5.5/Makefile000066400000000000000000000023741300622755700200150ustar00rootroot00000000000000pep8: find googleapiclient samples -name "*.py" | xargs pep8 --ignore=E111,E202 APP_ENGINE_PATH=../google_appengine test: tox .PHONY: coverage coverage: coverage erase find tests -name "test_*.py" | xargs --max-args=1 coverage run -a runtests.py coverage report coverage html .PHONY: docs docs: cd docs; ./build mkdir -p docs/dyn python describe.py .PHONY: wiki wiki: python samples-index.py > ../google-api-python-client.wiki/SampleApps.wiki .PHONY: prerelease prerelease: -rm -rf dist/ -sudo rm -rf dist/ -rm -rf snapshot/ -sudo rm -rf snapshot/ python expandsymlinks.py cd snapshot; python setup.py clean cd snapshot; python setup.py sdist --formats=gztar,zip bdist_wheel --universal 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 bdist_wheel --universal cd snapshot; twine upload dist/* google-api-python-client-1.5.5/README.md000066400000000000000000000031431300622755700176270ustar00rootroot00000000000000# About This is the Python client library for Google's discovery based APIs. To get started, please see the [full documentation for this library](http://google.github.io/google-api-python-client). Additionally, [dynamically generated documentation](http://api-python-client-doc.appspot.com/) is available for all of the APIs supported by this library. # Installation To install, simply use `pip` or `easy_install`: ```bash $ pip install --upgrade google-api-python-client ``` or ```bash $ easy_install --upgrade google-api-python-client ``` See the [Developers Guide](https://developers.google.com/api-client-library/python/start/get_started) for more detailed instructions and additional documentation. # Python Version Python 2.6 or 2.7 are fully supported. Python 3.3+ is also now supported! However, this library has not yet been used as thoroughly with Python 3, so we'd recommend testing before deploying with Python 3 in production. # Third Party Libraries and Dependencies The following libraries will be installed when you install the client library: * [httplib2](https://github.com/httplib2/httplib2) * [uritemplate](https://github.com/sigmavirus24/uritemplate) For development you will also need the following libraries: * [WebTest](http://pythonpaste.org/webtest/) * [pycrypto](https://pypi.python.org/pypi/pycrypto) * [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL) # Contributing Please see the [contributing page](http://google.github.io/google-api-python-client/contributing.html) for more information. In particular, we love pull requests - but please make sure to sign the contributor license agreement. google-api-python-client-1.5.5/apiclient/000077500000000000000000000000001300622755700203175ustar00rootroot00000000000000google-api-python-client-1.5.5/apiclient/__init__.py000066400000000000000000000022211300622755700224250ustar00rootroot00000000000000"""Retain apiclient as an alias for googleapiclient.""" from six import iteritems import googleapiclient try: import oauth2client except ImportError: raise RuntimeError( 'Previous version of google-api-python-client detected; due to a ' 'packaging issue, we cannot perform an in-place upgrade. To repair, ' 'remove and reinstall this package, along with oauth2client and ' 'uritemplate. One can do this with pip via\n' ' pip install -I google-api-python-client' ) from googleapiclient import channel from googleapiclient import discovery from googleapiclient import errors from googleapiclient import http from googleapiclient import mimeparse from googleapiclient import model from googleapiclient import sample_tools from googleapiclient import schema __version__ = googleapiclient.__version__ _SUBMODULES = { 'channel': channel, 'discovery': discovery, 'errors': errors, 'http': http, 'mimeparse': mimeparse, 'model': model, 'sample_tools': sample_tools, 'schema': schema, } import sys for module_name, module in iteritems(_SUBMODULES): sys.modules['apiclient.%s' % module_name] = module google-api-python-client-1.5.5/describe.py000077500000000000000000000234611300622755700205120ustar00rootroot00000000000000#!/usr/bin/python # # Copyright 2014 Google Inc. All Rights Reserved. # # 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 json import os import re import string import sys from googleapiclient.discovery import DISCOVERY_URI from googleapiclient.discovery import build from googleapiclient.discovery import build_from_document from googleapiclient.discovery import UnknownApiNameOrVersion import httplib2 import uritemplate CSS = """ """ METHOD_TEMPLATE = """
$name($params) 
$doc
""" COLLECTION_LINK = """

$name()

Returns the $name Resource.

""" METHOD_LINK = """

$name($params)

$firstline

""" BASE = 'docs/dyn' DIRECTORY_URI = 'https://www.googleapis.com/discovery/v1/apis' 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. """ try: service = build(name, version) except UnknownApiNameOrVersion as e: print 'Warning: {} {} found but could not be built.'.format(name, version) return response, content = http.request( uritemplate.expand( FLAGS.discovery_uri_template, { 'api': name, 'apiVersion': version}) ) discovery = json.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 = json.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 = json.loads(content)['items'] for api in directory: document_api(api['name'], api['version']) else: sys.exit("Failed to load the discovery document.") google-api-python-client-1.5.5/docs/000077500000000000000000000000001300622755700172775ustar00rootroot00000000000000google-api-python-client-1.5.5/docs/build000077500000000000000000000021061300622755700203230ustar00rootroot00000000000000#!/bin/bash # # Copyright 2014 Google Inc. All Rights Reserved. # # 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. # # Author: jcgregorio@google.com (Joe Gregorio) # # Creates the documentation set for the library by # running pydoc on all the files in apiclient. # # 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 googleapiclient google-api-python-client-1.5.5/docs/dyn/000077500000000000000000000000001300622755700200715ustar00rootroot00000000000000google-api-python-client-1.5.5/docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html000066400000000000000000000061051300622755700300150ustar00rootroot00000000000000

Accelerated Mobile Pages (AMP) URL API . ampUrls

Instance Methods

batchGet(body, x__xgafv=None)

Returns AMP URL(s) and equivalent

Method Details

batchGet(body, x__xgafv=None) 
Returns AMP URL(s) and equivalent
[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # AMP URL request for a batch of URLs.
    "lookupStrategy": "A String", # The lookup_strategy being requested.
    "urls": [ # List of URLs to look up for the paired AMP URLs.
        # The URLs are case-sensitive. Up to 50 URLs per lookup
        # (see [Usage Limits](/amp/cache/reference/limits)).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Batch AMP URL response.
    "ampUrls": [ # For each URL in BatchAmpUrlsRequest, the URL response. The response might
        # not be in the same order as URLs in the batch request.
        # If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated
        # only once.
      { # AMP URL response for a requested URL.
        "ampUrl": "A String", # The AMP URL pointing to the publisher's web server.
        "cdnAmpUrl": "A String", # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
            # the cached document in the Google AMP Cache.
        "originalUrl": "A String", # The original non-AMP URL.
      },
    ],
    "urlErrors": [ # The errors for requested URLs that have no AMP URL.
      { # AMP URL Error resource for a requested URL that couldn't be found.
        "errorCode": "A String", # The error code of an API call.
        "errorMessage": "A String", # An optional descriptive error message.
        "originalUrl": "A String", # The original non-AMP URL.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/acceleratedmobilepageurl_v1.html000066400000000000000000000042041300622755700263710ustar00rootroot00000000000000

Accelerated Mobile Pages (AMP) URL API

Instance Methods

ampUrls()

Returns the ampUrls Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html000066400000000000000000000505331300622755700310070ustar00rootroot00000000000000

Ad Exchange Buyer API II . accounts . clients

Instance Methods

invitations()

Returns the invitations Resource.

users()

Returns the users Resource.

create(accountId=None, body, x__xgafv=None)

Creates a new client buyer.

get(accountId, clientAccountId, x__xgafv=None)

Gets a client buyer with a given client account ID.

list(accountId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the clients for the current sponsor buyer.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(accountId=None, clientAccountId, body, x__xgafv=None)

Updates an existing client buyer.

Method Details

create(accountId=None, body, x__xgafv=None) 
Creates a new client buyer.

Args:
  accountId: string, Unique numerical account ID for the buyer of which the client buyer
is a customer; the sponsor buyer to create a client for. (required) (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A client resource represents a client buyer—an agency,
      # a brand, or an advertiser customer of the sponsor buyer.
      # Users associated with the client buyer have restricted access to
      # the Ad Exchange Marketplace and certain other sections
      # of the Ad Exchange Buyer UI based on the role
      # granted to the client buyer.
      # All fields are required unless otherwise specified.
    "status": "A String", # The status of the client buyer.
    "clientAccountId": "A String", # The globally-unique numerical ID of the client.
        # The value of this field is ignored in create and update operations.
    "entityName": "A String", # The name of the entity. This field is automatically fetched based on
        # the type and ID.
        # The value of this field is ignored in create and update operations.
    "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
    "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
        # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
        # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
    "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
    "entityId": "A String", # Numerical identifier of the client entity.
        # The entity can be an advertiser, a brand, or an agency.
        # This identifier is unique among all the entities with the same type.
        # 
        # A list of all known advertisers with their identifiers is available in the
        # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
        # file.
        # 
        # A list of all known brands with their identifiers is available in the
        # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
        # file.
        # 
        # A list of all known agencies with their identifiers is available in the
        # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
        # file.
    "clientName": "A String", # Name used to represent this client to publishers.
        # You may have multiple clients that map to the same entity,
        # but for each client the combination of `clientName` and entity
        # must be unique.
        # You can specify this field as empty.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client resource represents a client buyer—an agency,
        # a brand, or an advertiser customer of the sponsor buyer.
        # Users associated with the client buyer have restricted access to
        # the Ad Exchange Marketplace and certain other sections
        # of the Ad Exchange Buyer UI based on the role
        # granted to the client buyer.
        # All fields are required unless otherwise specified.
      "status": "A String", # The status of the client buyer.
      "clientAccountId": "A String", # The globally-unique numerical ID of the client.
          # The value of this field is ignored in create and update operations.
      "entityName": "A String", # The name of the entity. This field is automatically fetched based on
          # the type and ID.
          # The value of this field is ignored in create and update operations.
      "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
      "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
          # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
          # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
      "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
      "entityId": "A String", # Numerical identifier of the client entity.
          # The entity can be an advertiser, a brand, or an agency.
          # This identifier is unique among all the entities with the same type.
          #
          # A list of all known advertisers with their identifiers is available in the
          # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
          # file.
          #
          # A list of all known brands with their identifiers is available in the
          # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
          # file.
          #
          # A list of all known agencies with their identifiers is available in the
          # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
          # file.
      "clientName": "A String", # Name used to represent this client to publishers.
          # You may have multiple clients that map to the same entity,
          # but for each client the combination of `clientName` and entity
          # must be unique.
          # You can specify this field as empty.
    }
get(accountId, clientAccountId, x__xgafv=None) 
Gets a client buyer with a given client account ID.

Args:
  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
  clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client resource represents a client buyer—an agency,
        # a brand, or an advertiser customer of the sponsor buyer.
        # Users associated with the client buyer have restricted access to
        # the Ad Exchange Marketplace and certain other sections
        # of the Ad Exchange Buyer UI based on the role
        # granted to the client buyer.
        # All fields are required unless otherwise specified.
      "status": "A String", # The status of the client buyer.
      "clientAccountId": "A String", # The globally-unique numerical ID of the client.
          # The value of this field is ignored in create and update operations.
      "entityName": "A String", # The name of the entity. This field is automatically fetched based on
          # the type and ID.
          # The value of this field is ignored in create and update operations.
      "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
      "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
          # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
          # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
      "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
      "entityId": "A String", # Numerical identifier of the client entity.
          # The entity can be an advertiser, a brand, or an agency.
          # This identifier is unique among all the entities with the same type.
          #
          # A list of all known advertisers with their identifiers is available in the
          # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
          # file.
          #
          # A list of all known brands with their identifiers is available in the
          # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
          # file.
          #
          # A list of all known agencies with their identifiers is available in the
          # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
          # file.
      "clientName": "A String", # Name used to represent this client to publishers.
          # You may have multiple clients that map to the same entity,
          # but for each client the combination of `clientName` and entity
          # must be unique.
          # You can specify this field as empty.
    }
list(accountId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all the clients for the current sponsor buyer.

Args:
  accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required)
  pageSize: integer, Requested page size. The server may return fewer clients than requested.
If unspecified, the server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListClientsResponse.nextPageToken
returned from the previous call to the
accounts.clients.list method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the
        # ListClientsRequest.pageToken
        # field in the subsequent call to the
        # accounts.clients.list method
        # to retrieve the next page of results.
    "clients": [ # The returned list of clients.
      { # A client resource represents a client buyer—an agency,
            # a brand, or an advertiser customer of the sponsor buyer.
            # Users associated with the client buyer have restricted access to
            # the Ad Exchange Marketplace and certain other sections
            # of the Ad Exchange Buyer UI based on the role
            # granted to the client buyer.
            # All fields are required unless otherwise specified.
          "status": "A String", # The status of the client buyer.
          "clientAccountId": "A String", # The globally-unique numerical ID of the client.
              # The value of this field is ignored in create and update operations.
          "entityName": "A String", # The name of the entity. This field is automatically fetched based on
              # the type and ID.
              # The value of this field is ignored in create and update operations.
          "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
          "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
              # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
              # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
          "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
          "entityId": "A String", # Numerical identifier of the client entity.
              # The entity can be an advertiser, a brand, or an agency.
              # This identifier is unique among all the entities with the same type.
              #
              # A list of all known advertisers with their identifiers is available in the
              # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
              # file.
              #
              # A list of all known brands with their identifiers is available in the
              # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
              # file.
              #
              # A list of all known agencies with their identifiers is available in the
              # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
              # file.
          "clientName": "A String", # Name used to represent this client to publishers.
              # You may have multiple clients that map to the same entity,
              # but for each client the combination of `clientName` and entity
              # must be unique.
              # You can specify this field as empty.
        },
    ],
  }
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(accountId=None, clientAccountId, body, x__xgafv=None) 
Updates an existing client buyer.

Args:
  accountId: string, Unique numerical account ID for the buyer of which the client buyer
is a customer; the sponsor buyer to update a client for. (required) (required)
  clientAccountId: string, Unique numerical account ID of the client to update. (required) (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A client resource represents a client buyer—an agency,
      # a brand, or an advertiser customer of the sponsor buyer.
      # Users associated with the client buyer have restricted access to
      # the Ad Exchange Marketplace and certain other sections
      # of the Ad Exchange Buyer UI based on the role
      # granted to the client buyer.
      # All fields are required unless otherwise specified.
    "status": "A String", # The status of the client buyer.
    "clientAccountId": "A String", # The globally-unique numerical ID of the client.
        # The value of this field is ignored in create and update operations.
    "entityName": "A String", # The name of the entity. This field is automatically fetched based on
        # the type and ID.
        # The value of this field is ignored in create and update operations.
    "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
    "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
        # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
        # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
    "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
    "entityId": "A String", # Numerical identifier of the client entity.
        # The entity can be an advertiser, a brand, or an agency.
        # This identifier is unique among all the entities with the same type.
        # 
        # A list of all known advertisers with their identifiers is available in the
        # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
        # file.
        # 
        # A list of all known brands with their identifiers is available in the
        # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
        # file.
        # 
        # A list of all known agencies with their identifiers is available in the
        # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
        # file.
    "clientName": "A String", # Name used to represent this client to publishers.
        # You may have multiple clients that map to the same entity,
        # but for each client the combination of `clientName` and entity
        # must be unique.
        # You can specify this field as empty.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client resource represents a client buyer—an agency,
        # a brand, or an advertiser customer of the sponsor buyer.
        # Users associated with the client buyer have restricted access to
        # the Ad Exchange Marketplace and certain other sections
        # of the Ad Exchange Buyer UI based on the role
        # granted to the client buyer.
        # All fields are required unless otherwise specified.
      "status": "A String", # The status of the client buyer.
      "clientAccountId": "A String", # The globally-unique numerical ID of the client.
          # The value of this field is ignored in create and update operations.
      "entityName": "A String", # The name of the entity. This field is automatically fetched based on
          # the type and ID.
          # The value of this field is ignored in create and update operations.
      "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
      "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
          # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
          # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
      "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
      "entityId": "A String", # Numerical identifier of the client entity.
          # The entity can be an advertiser, a brand, or an agency.
          # This identifier is unique among all the entities with the same type.
          #
          # A list of all known advertisers with their identifiers is available in the
          # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
          # file.
          #
          # A list of all known brands with their identifiers is available in the
          # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
          # file.
          #
          # A list of all known agencies with their identifiers is available in the
          # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
          # file.
      "clientName": "A String", # Name used to represent this client to publishers.
          # You may have multiple clients that map to the same entity,
          # but for each client the combination of `clientName` and entity
          # must be unique.
          # You can specify this field as empty.
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html000066400000000000000000000204201300622755700333450ustar00rootroot00000000000000

Ad Exchange Buyer API II . accounts . clients . invitations

Instance Methods

create(accountId, clientAccountId=None, body, x__xgafv=None)

Creates and sends out an email invitation to access

get(accountId, clientAccountId=None, invitationId, x__xgafv=None)

Retrieves an existing client user invitation.

list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the client users invitations for a client

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(accountId, clientAccountId=None, body, x__xgafv=None) 
Creates and sends out an email invitation to access
an Ad Exchange client buyer account.

Args:
  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
  clientAccountId: string, Numerical account ID of the client buyer that the user
should be associated with. (required) (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An invitation for a new client user to get access to the Ad Exchange
      # Buyer UI.
      # All fields are required unless otherwise specified.
    "clientAccountId": "A String", # Numerical account ID of the client buyer
        # that the invited user is associated with.
        # The value of this field is ignored in create operations.
    "email": "A String", # The email address to which the invitation is sent. Email
        # addresses should be unique among all client users under each sponsor
        # buyer.
    "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
        # The value of this field is ignored in create operations.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An invitation for a new client user to get access to the Ad Exchange
        # Buyer UI.
        # All fields are required unless otherwise specified.
      "clientAccountId": "A String", # Numerical account ID of the client buyer
          # that the invited user is associated with.
          # The value of this field is ignored in create operations.
      "email": "A String", # The email address to which the invitation is sent. Email
          # addresses should be unique among all client users under each sponsor
          # buyer.
      "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
          # The value of this field is ignored in create operations.
    }
get(accountId, clientAccountId=None, invitationId, x__xgafv=None) 
Retrieves an existing client user invitation.

Args:
  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
  clientAccountId: string, Numerical account ID of the client buyer that the user invitation
to be retrieved is associated with. (required) (required)
  invitationId: string, Numerical identifier of the user invitation to retrieve. (required) (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An invitation for a new client user to get access to the Ad Exchange
        # Buyer UI.
        # All fields are required unless otherwise specified.
      "clientAccountId": "A String", # Numerical account ID of the client buyer
          # that the invited user is associated with.
          # The value of this field is ignored in create operations.
      "email": "A String", # The email address to which the invitation is sent. Email
          # addresses should be unique among all client users under each sponsor
          # buyer.
      "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
          # The value of this field is ignored in create operations.
    }
list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all the client users invitations for a client
with a given account ID.

Args:
  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
  clientAccountId: string, Numerical account ID of the client buyer to list invitations for.
(required)
You must either specify a string representation of a
numerical account identifier or the `-` character
to list all the invitations for all the clients
of a given sponsor buyer. (required)
  pageSize: integer, Requested page size. Server may return fewer clients than requested.
If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListClientUserInvitationsResponse.nextPageToken
returned from the previous call to the
clients.invitations.list
method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the
        # ListClientUserInvitationsRequest.pageToken
        # field in the subsequent call to the
        # clients.invitations.list
        # method to retrieve the next
        # page of results.
    "invitations": [ # The returned list of client users.
      { # An invitation for a new client user to get access to the Ad Exchange
            # Buyer UI.
            # All fields are required unless otherwise specified.
          "clientAccountId": "A String", # Numerical account ID of the client buyer
              # that the invited user is associated with.
              # The value of this field is ignored in create operations.
          "email": "A String", # The email address to which the invitation is sent. Email
              # addresses should be unique among all client users under each sponsor
              # buyer.
          "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
              # The value of this field is ignored in create operations.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html000066400000000000000000000235351300622755700321510ustar00rootroot00000000000000

Ad Exchange Buyer API II . accounts . clients . users

Instance Methods

get(accountId, clientAccountId=None, userId, x__xgafv=None)

Retrieves an existing client user.

list(accountId=None, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the known client users for a specified

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(accountId, clientAccountId=None, userId, body, x__xgafv=None)

Updates an existing client user.

Method Details

get(accountId, clientAccountId=None, userId, x__xgafv=None) 
Retrieves an existing client user.

Args:
  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
  clientAccountId: string, Numerical account ID of the client buyer
that the user to be retrieved is associated with. (required) (required)
  userId: string, Numerical identifier of the user to retrieve. (required) (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client user is created under a client buyer and has restricted access to
      # the Ad Exchange Marketplace and certain other sections
      # of the Ad Exchange Buyer UI based on the role
      # granted to the associated client buyer.
      #
      # The only way a new client user can be created is via accepting an
      # email invitation
      # (see the
      # accounts.clients.invitations.create
      # method).
      #
      # All fields are required unless otherwise specified.
    "status": "A String", # The status of the client user.
    "clientAccountId": "A String", # Numerical account ID of the client buyer
        # with which the user is associated; the
        # buyer must be a client of the current sponsor buyer.
        # The value of this field is ignored in an update operation.
    "userId": "A String", # The unique numerical ID of the client user
        # that has accepted an invitation.
        # The value of this field is ignored in an update operation.
    "email": "A String", # User's email address. The value of this field
        # is ignored in an update operation.
  }
list(accountId=None, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all the known client users for a specified
sponsor buyer account ID.

Args:
  accountId: string, Numerical account ID of the sponsor buyer of the client to list users for.
(required) (required)
  clientAccountId: string, The account ID of the client buyer to list users for. (required)
You must specify either a string representation of a
numerical account identifier or the `-` character
to list all the client users for all the clients
of a given sponsor buyer. (required)
  pageSize: integer, Requested page size. The server may return fewer clients than requested.
If unspecified, the server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListClientUsersResponse.nextPageToken
returned from the previous call to the
accounts.clients.users.list method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the
        # ListClientUsersRequest.pageToken
        # field in the subsequent call to the
        # clients.invitations.list
        # method to retrieve the next
        # page of results.
    "users": [ # The returned list of client users.
      { # A client user is created under a client buyer and has restricted access to
          # the Ad Exchange Marketplace and certain other sections
          # of the Ad Exchange Buyer UI based on the role
          # granted to the associated client buyer.
          #
          # The only way a new client user can be created is via accepting an
          # email invitation
          # (see the
          # accounts.clients.invitations.create
          # method).
          #
          # All fields are required unless otherwise specified.
        "status": "A String", # The status of the client user.
        "clientAccountId": "A String", # Numerical account ID of the client buyer
            # with which the user is associated; the
            # buyer must be a client of the current sponsor buyer.
            # The value of this field is ignored in an update operation.
        "userId": "A String", # The unique numerical ID of the client user
            # that has accepted an invitation.
            # The value of this field is ignored in an update operation.
        "email": "A String", # User's email address. The value of this field
            # is ignored in an update operation.
      },
    ],
  }
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(accountId, clientAccountId=None, userId, body, x__xgafv=None) 
Updates an existing client user.
Only the user status can be changed on update.

Args:
  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
  clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved
is associated with. (required) (required)
  userId: string, Numerical identifier of the user to retrieve. (required) (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A client user is created under a client buyer and has restricted access to
    # the Ad Exchange Marketplace and certain other sections
    # of the Ad Exchange Buyer UI based on the role
    # granted to the associated client buyer.
    # 
    # The only way a new client user can be created is via accepting an
    # email invitation
    # (see the
    # accounts.clients.invitations.create
    # method).
    # 
    # All fields are required unless otherwise specified.
  "status": "A String", # The status of the client user.
  "clientAccountId": "A String", # Numerical account ID of the client buyer
      # with which the user is associated; the
      # buyer must be a client of the current sponsor buyer.
      # The value of this field is ignored in an update operation.
  "userId": "A String", # The unique numerical ID of the client user
      # that has accepted an invitation.
      # The value of this field is ignored in an update operation.
  "email": "A String", # User's email address. The value of this field
      # is ignored in an update operation.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client user is created under a client buyer and has restricted access to
      # the Ad Exchange Marketplace and certain other sections
      # of the Ad Exchange Buyer UI based on the role
      # granted to the associated client buyer.
      #
      # The only way a new client user can be created is via accepting an
      # email invitation
      # (see the
      # accounts.clients.invitations.create
      # method).
      #
      # All fields are required unless otherwise specified.
    "status": "A String", # The status of the client user.
    "clientAccountId": "A String", # Numerical account ID of the client buyer
        # with which the user is associated; the
        # buyer must be a client of the current sponsor buyer.
        # The value of this field is ignored in an update operation.
    "userId": "A String", # The unique numerical ID of the client user
        # that has accepted an invitation.
        # The value of this field is ignored in an update operation.
    "email": "A String", # User's email address. The value of this field
        # is ignored in an update operation.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer2_v2beta1.accounts.html000066400000000000000000000024121300622755700273400ustar00rootroot00000000000000

Ad Exchange Buyer API II . accounts

Instance Methods

clients()

Returns the clients Resource.

google-api-python-client-1.5.5/docs/dyn/adexchangebuyer2_v2beta1.html000066400000000000000000000041631300622755700255270ustar00rootroot00000000000000

Ad Exchange Buyer API II

Instance Methods

accounts()

Returns the accounts Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_2.accounts.html000066400000000000000000000276431300622755700265760ustar00rootroot00000000000000

Ad Exchange Buyer API . accounts

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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "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.
          "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
          "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
          "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.
    "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
    "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
    "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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "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.
    "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
    "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
    "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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "id": 42, # Account id.
      "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_2.creatives.html000066400000000000000000000461101300622755700267320ustar00rootroot00000000000000

Ad Exchange Buyer API . creatives

Instance Methods

get(accountId, buyerCreativeId)

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

insert(body)

Submit a new creative.

list(pageToken=None, maxResults=None, statusFilter=None)

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId, buyerCreativeId) 
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

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.
      "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
        "A String",
      ],
      "accountId": 42, # Account id.
      "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "width": 42, # Ad width.
      "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
      "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
      "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,
      ],
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "agencyId": "A String", # The agency id for this creative.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "kind": "adexchangebuyer#creative", # Resource type.
      "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
        42,
      ],
      "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
        {
          "reason": "A String", # The type of correction that was applied to the creative.
          "details": [ # Additional details about the correction.
            "A String",
          ],
        },
      ],
      "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
        "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
        "reasons": [ # The filtering reasons.
          {
            "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
            "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
          },
        ],
      },
    }
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.
    "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
    "attribute": [ # All attributes for the ads that may be shown from this snippet.
      42,
    ],
    "height": 42, # Ad height.
    "advertiserName": "A String", # The name of the company being advertised in the creative.
    "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
    "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
    "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
      "A String",
    ],
    "accountId": 42, # Account id.
    "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
    "clickThroughUrl": [ # The set of destination urls for the snippet.
      "A String",
    ],
    "width": 42, # Ad width.
    "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
    "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
    "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,
    ],
    "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
      42,
    ],
    "agencyId": "A String", # The agency id for this creative.
    "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
      "A String",
    ],
    "kind": "adexchangebuyer#creative", # Resource type.
    "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
      42,
    ],
    "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
      {
        "reason": "A String", # The type of correction that was applied to the creative.
        "details": [ # Additional details about the correction.
          "A String",
        ],
      },
    ],
    "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
      "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
      "reasons": [ # The filtering reasons.
        {
          "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
          "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
        },
      ],
    },
  }


Returns:
  An object of the form:

    { # A creative and its classification data.
      "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
        "A String",
      ],
      "accountId": 42, # Account id.
      "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "width": 42, # Ad width.
      "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
      "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
      "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,
      ],
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "agencyId": "A String", # The agency id for this creative.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "kind": "adexchangebuyer#creative", # Resource type.
      "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
        42,
      ],
      "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
        {
          "reason": "A String", # The type of correction that was applied to the creative.
          "details": [ # Additional details about the correction.
            "A String",
          ],
        },
      ],
      "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
        "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
        "reasons": [ # The filtering reasons.
          {
            "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
            "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
          },
        ],
      },
    }
list(pageToken=None, maxResults=None, statusFilter=None) 
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

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.
          "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
          "attribute": [ # All attributes for the ads that may be shown from this snippet.
            42,
          ],
          "height": 42, # Ad height.
          "advertiserName": "A String", # The name of the company being advertised in the creative.
          "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
          "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
          "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
            "A String",
          ],
          "accountId": 42, # Account id.
          "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
          "clickThroughUrl": [ # The set of destination urls for the snippet.
            "A String",
          ],
          "width": 42, # Ad width.
          "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
          "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
          "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,
          ],
          "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
            42,
          ],
          "agencyId": "A String", # The agency id for this creative.
          "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
            "A String",
          ],
          "kind": "adexchangebuyer#creative", # Resource type.
          "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
            42,
          ],
          "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
            {
              "reason": "A String", # The type of correction that was applied to the creative.
              "details": [ # Additional details about the correction.
                "A String",
              ],
            },
          ],
          "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
            "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
            "reasons": [ # The filtering reasons.
              {
                "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
                "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
              },
            ],
          },
        },
    ],
    "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.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_2.html000066400000000000000000000044141300622755700247470ustar00rootroot00000000000000

Ad Exchange Buyer API

Instance Methods

accounts()

Returns the accounts Resource.

creatives()

Returns the creatives Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.accounts.html000066400000000000000000000276431300622755700265770ustar00rootroot00000000000000

Ad Exchange Buyer API . accounts

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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "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.
          "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
          "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
          "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.
    "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
    "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
    "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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "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.
    "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
    "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
    "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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "id": 42, # Account id.
      "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.billingInfo.html000066400000000000000000000061331300622755700272030ustar00rootroot00000000000000

Ad Exchange Buyer API . billingInfo

Instance Methods

get(accountId)

Returns the billing information for one account specified by account ID.

list()

Retrieves a list of billing information for all accounts of the authenticated user.

Method Details

get(accountId) 
Returns the billing information for one account specified by account ID.

Args:
  accountId: integer, The account id. (required)

Returns:
  An object of the form:

    { # The configuration data for an Ad Exchange billing info.
    "billingId": [ # A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.
      "A String",
    ],
    "accountName": "A String", # Account name.
    "kind": "adexchangebuyer#billingInfo", # Resource type.
    "accountId": 42, # Account id.
  }
list() 
Retrieves a list of billing information for all accounts of the authenticated user.

Args:

Returns:
  An object of the form:

    { # A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.
    "items": [ # A list of billing info relevant for your account.
      { # The configuration data for an Ad Exchange billing info.
        "billingId": [ # A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.
          "A String",
        ],
        "accountName": "A String", # Account name.
        "kind": "adexchangebuyer#billingInfo", # Resource type.
        "accountId": 42, # Account id.
      },
    ],
    "kind": "adexchangebuyer#billingInfoList", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.budget.html000066400000000000000000000161201300622755700262160ustar00rootroot00000000000000

Ad Exchange Buyer API . budget

Instance Methods

get(accountId, billingId)

Returns the budget information for the adgroup specified by the accountId and billingId.

patch(accountId, billingId, body)

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

update(accountId, billingId, body)

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Method Details

get(accountId, billingId) 
Returns the budget information for the adgroup specified by the accountId and billingId.

Args:
  accountId: string, The account id to get the budget information for. (required)
  billingId: string, The billing id to get the budget information for. (required)

Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
patch(accountId, billingId, body) 
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

Args:
  accountId: string, The account id associated with the budget being updated. (required)
  billingId: string, The billing id associated with the budget being updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The configuration data for Ad Exchange RTB - Budget API.
    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    "id": "A String", # The unique id that describes this item.
    "accountId": "A String", # The id of the account. This is required for get and update requests.
  }


Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
update(accountId, billingId, body) 
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Args:
  accountId: string, The account id associated with the budget being updated. (required)
  billingId: string, The billing id associated with the budget being updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The configuration data for Ad Exchange RTB - Budget API.
    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    "id": "A String", # The unique id that describes this item.
    "accountId": "A String", # The id of the account. This is required for get and update requests.
  }


Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.creatives.html000066400000000000000000000604101300622755700267320ustar00rootroot00000000000000

Ad Exchange Buyer API . creatives

Instance Methods

get(accountId, buyerCreativeId)

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

insert(body)

Submit a new creative.

list(pageToken=None, maxResults=None, statusFilter=None, buyerCreativeId=None, accountId=None)

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId, buyerCreativeId) 
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

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.
      "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
        "A String",
      ],
      "accountId": 42, # Account id.
      "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "width": 42, # Ad width.
      "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
        "body": "A String", # A long description of the ad.
        "advertiser": "A String",
        "store": "A String", # The URL to the app store to purchase/download the promoted app.
        "headline": "A String", # A short title for the ad.
        "image": { # A large image.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
        "callToAction": "A String", # A label for the button that the user is supposed to click.
        "logo": { # A smaller image, for the advertiser logo.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "appIcon": { # The app icon, for app download ads.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
          "A String",
        ],
        "price": "A String", # The price of the promoted app including the currency info.
        "clickTrackingUrl": "A String", # The URL to use for click tracking.
      },
      "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
      "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
      "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,
      ],
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "agencyId": "A String", # The agency id for this creative.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "kind": "adexchangebuyer#creative", # Resource type.
      "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
        42,
      ],
      "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
        {
          "reason": "A String", # The type of correction that was applied to the creative.
          "details": [ # Additional details about the correction.
            "A String",
          ],
        },
      ],
      "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
        "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
        "reasons": [ # The filtering reasons.
          {
            "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
            "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
          },
        ],
      },
    }
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.
    "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
    "attribute": [ # All attributes for the ads that may be shown from this snippet.
      42,
    ],
    "height": 42, # Ad height.
    "advertiserName": "A String", # The name of the company being advertised in the creative.
    "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
    "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
    "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
      "A String",
    ],
    "accountId": 42, # Account id.
    "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
    "clickThroughUrl": [ # The set of destination urls for the snippet.
      "A String",
    ],
    "width": 42, # Ad width.
    "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
      "body": "A String", # A long description of the ad.
      "advertiser": "A String",
      "store": "A String", # The URL to the app store to purchase/download the promoted app.
      "headline": "A String", # A short title for the ad.
      "image": { # A large image.
        "url": "A String",
        "width": 42,
        "height": 42,
      },
      "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
      "callToAction": "A String", # A label for the button that the user is supposed to click.
      "logo": { # A smaller image, for the advertiser logo.
        "url": "A String",
        "width": 42,
        "height": 42,
      },
      "appIcon": { # The app icon, for app download ads.
        "url": "A String",
        "width": 42,
        "height": 42,
      },
      "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
        "A String",
      ],
      "price": "A String", # The price of the promoted app including the currency info.
      "clickTrackingUrl": "A String", # The URL to use for click tracking.
    },
    "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
    "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
    "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,
    ],
    "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
      42,
    ],
    "agencyId": "A String", # The agency id for this creative.
    "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
      "A String",
    ],
    "kind": "adexchangebuyer#creative", # Resource type.
    "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
      42,
    ],
    "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
      {
        "reason": "A String", # The type of correction that was applied to the creative.
        "details": [ # Additional details about the correction.
          "A String",
        ],
      },
    ],
    "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
      "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
      "reasons": [ # The filtering reasons.
        {
          "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
          "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
        },
      ],
    },
  }


Returns:
  An object of the form:

    { # A creative and its classification data.
      "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
        "A String",
      ],
      "accountId": 42, # Account id.
      "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "width": 42, # Ad width.
      "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
        "body": "A String", # A long description of the ad.
        "advertiser": "A String",
        "store": "A String", # The URL to the app store to purchase/download the promoted app.
        "headline": "A String", # A short title for the ad.
        "image": { # A large image.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
        "callToAction": "A String", # A label for the button that the user is supposed to click.
        "logo": { # A smaller image, for the advertiser logo.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "appIcon": { # The app icon, for app download ads.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
          "A String",
        ],
        "price": "A String", # The price of the promoted app including the currency info.
        "clickTrackingUrl": "A String", # The URL to use for click tracking.
      },
      "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
      "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
      "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,
      ],
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "agencyId": "A String", # The agency id for this creative.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "kind": "adexchangebuyer#creative", # Resource type.
      "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
        42,
      ],
      "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
        {
          "reason": "A String", # The type of correction that was applied to the creative.
          "details": [ # Additional details about the correction.
            "A String",
          ],
        },
      ],
      "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
        "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
        "reasons": [ # The filtering reasons.
          {
            "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
            "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
          },
        ],
      },
    }
list(pageToken=None, maxResults=None, statusFilter=None, buyerCreativeId=None, accountId=None) 
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

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.
  buyerCreativeId: string, When specified, only creatives for the given buyer creative ids are returned. (repeated)
  accountId: integer, When specified, only creatives for the given account ids are returned. (repeated)

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.
          "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
          "attribute": [ # All attributes for the ads that may be shown from this snippet.
            42,
          ],
          "height": 42, # Ad height.
          "advertiserName": "A String", # The name of the company being advertised in the creative.
          "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
          "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
          "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
            "A String",
          ],
          "accountId": 42, # Account id.
          "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
          "clickThroughUrl": [ # The set of destination urls for the snippet.
            "A String",
          ],
          "width": 42, # Ad width.
          "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
            "body": "A String", # A long description of the ad.
            "advertiser": "A String",
            "store": "A String", # The URL to the app store to purchase/download the promoted app.
            "headline": "A String", # A short title for the ad.
            "image": { # A large image.
              "url": "A String",
              "width": 42,
              "height": 42,
            },
            "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
            "callToAction": "A String", # A label for the button that the user is supposed to click.
            "logo": { # A smaller image, for the advertiser logo.
              "url": "A String",
              "width": 42,
              "height": 42,
            },
            "appIcon": { # The app icon, for app download ads.
              "url": "A String",
              "width": 42,
              "height": 42,
            },
            "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
              "A String",
            ],
            "price": "A String", # The price of the promoted app including the currency info.
            "clickTrackingUrl": "A String", # The URL to use for click tracking.
          },
          "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
          "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
          "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,
          ],
          "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
            42,
          ],
          "agencyId": "A String", # The agency id for this creative.
          "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
            "A String",
          ],
          "kind": "adexchangebuyer#creative", # Resource type.
          "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
            42,
          ],
          "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
            {
              "reason": "A String", # The type of correction that was applied to the creative.
              "details": [ # Additional details about the correction.
                "A String",
              ],
            },
          ],
          "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
            "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
            "reasons": [ # The filtering reasons.
              {
                "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
                "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
              },
            ],
          },
        },
    ],
    "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.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.directDeals.html000066400000000000000000000137531300622755700272000ustar00rootroot00000000000000

Ad Exchange Buyer API . directDeals

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.
    "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.
    "name": "A String", # Deal name.
    "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
    "allowsAlcohol": True or False, # Whether the publisher for this deal is eligible for alcohol ads.
    "dealTier": "A String", # The deal type such as programmatic reservation or fixed price and so on.
    "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).
    "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).
    "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.
    "publisherBlocksOverriden": True or False, # If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.
    "buyerAccountId": "A String", # The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.
    "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.
        "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.
        "name": "A String", # Deal name.
        "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
        "allowsAlcohol": True or False, # Whether the publisher for this deal is eligible for alcohol ads.
        "dealTier": "A String", # The deal type such as programmatic reservation or fixed price and so on.
        "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).
        "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).
        "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.
        "publisherBlocksOverriden": True or False, # If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.
        "buyerAccountId": "A String", # The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.
        "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.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.html000066400000000000000000000061661300622755700247560ustar00rootroot00000000000000

Ad Exchange Buyer API

Instance Methods

accounts()

Returns the accounts Resource.

billingInfo()

Returns the billingInfo Resource.

budget()

Returns the budget Resource.

creatives()

Returns the creatives Resource.

directDeals()

Returns the directDeals Resource.

performanceReport()

Returns the performanceReport Resource.

pretargetingConfig()

Returns the pretargetingConfig Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.performanceReport.html000066400000000000000000000116511300622755700304450ustar00rootroot00000000000000

Ad Exchange Buyer API . performanceReport

Instance Methods

list(accountId, endDateTime, startDateTime, pageToken=None, maxResults=None)

Retrieves the authenticated user's list of performance metrics.

Method Details

list(accountId, endDateTime, startDateTime, pageToken=None, maxResults=None) 
Retrieves the authenticated user's list of performance metrics.

Args:
  accountId: string, The account id to get the reports. (required)
  endDateTime: string, The end time of the report in ISO 8601 timestamp format using UTC. (required)
  startDateTime: string, The start time of the report in ISO 8601 timestamp format using UTC. (required)
  pageToken: string, A continuation token, used to page through performance reports. 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.

Returns:
  An object of the form:

    { # The configuration data for an Ad Exchange performance report list.
    "kind": "adexchangebuyer#performanceReportList", # Resource type.
    "performanceReport": [ # A list of performance reports relevant for the account.
      { # The configuration data for an Ad Exchange performance report list.
        "bidRequestRate": 3.14, # The number of bid requests sent to your bidder.
        "unsuccessfulRequestRate": 3.14, # The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.
        "successfulRequestRate": 3.14, # The number of properly formed bid responses received by our servers within the deadline.
        "hostedMatchStatusRate": [ # Average QPS for hosted match operations.
          "",
        ],
        "bidRate": 3.14, # The number of bid responses with an ad.
        "quotaThrottledLimit": 3.14, # The throttled quota limits for this account.
        "cookieMatcherStatusRate": [ # Average QPS for cookie matcher operations.
          "",
        ],
        "calloutStatusRate": [ # Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.
          "",
        ],
        "noQuotaInRegion": 3.14, # Rate of various quota account statuses per quota check.
        "timestamp": "A String", # The unix timestamp of the starting time of this performance data.
        "latency50thPercentile": 3.14, # The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
        "latency85thPercentile": 3.14, # The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
        "pixelMatchResponses": 3.14, # Average QPS for pixel match responses from clients.
        "creativeStatusRate": [ # Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.
          "",
        ],
        "latency95thPercentile": 3.14, # The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
        "kind": "adexchangebuyer#performanceReport", # Resource type.
        "inventoryMatchRate": 3.14, # The number of potential queries based on your pretargeting settings.
        "region": "A String", # The trading location of this data.
        "quotaConfiguredLimit": 3.14, # The configured quota limits for this account.
        "outOfQuota": 3.14, # Rate of various quota account statuses per quota check.
        "filteredBidRate": 3.14, # The number of bid responses that were filtered due to a policy violation or other errors.
        "pixelMatchRequests": 3.14, # Average QPS for pixel match requests from clients.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_3.pretargetingConfig.html000066400000000000000000001123161300622755700305710ustar00rootroot00000000000000

Ad Exchange Buyer API . pretargetingConfig

Instance Methods

delete(accountId, configId)

Deletes an existing pretargeting config.

get(accountId, configId)

Gets a specific pretargeting configuration

insert(accountId, body)

Inserts a new pretargeting configuration.

list(accountId)

Retrieves a list of the authenticated user's pretargeting configurations.

patch(accountId, configId, body)

Updates an existing pretargeting config. This method supports patch semantics.

update(accountId, configId, body)

Updates an existing pretargeting config.

Method Details

delete(accountId, configId) 
Deletes an existing pretargeting config.

Args:
  accountId: string, The account id to delete the pretargeting config for. (required)
  configId: string, The specific id of the configuration to delete. (required)
get(accountId, configId) 
Gets a specific pretargeting configuration

Args:
  accountId: string, The account id to get the pretargeting config for. (required)
  configId: string, The specific id of the configuration to retrieve. (required)

Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
insert(accountId, body) 
Inserts a new pretargeting configuration.

Args:
  accountId: string, The account id to insert the pretargeting config for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "verticals": [ # Requests containing any of these vertical ids will match.
      "A String",
    ],
    "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
      "A String",
    ],
    "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
    "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
      "A String",
    ],
    "configName": "A String", # The name of the config. Must be unique. Required for all requests.
    "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
      "A String",
    ],
    "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
      "A String",
    ],
    "languages": [ # Request containing any of these language codes will match.
      "A String",
    ],
    "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
      "A String",
    ],
    "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
      "A String",
    ],
    "excludedPlacements": [ # Requests containing any of these placements will not match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
    "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
    "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
      "A String",
    ],
    "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
      "A String",
    ],
    "excludedUserLists": [ # Requests containing any of these users list ids will not match.
      "A String",
    ],
    "isActive": True or False, # Whether this config is active. Required for all requests.
    "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
      {
        "width": "A String", # Width in pixels.
        "height": "A String", # Height in pixels.
      },
    ],
    "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
    "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
      "A String",
    ],
    "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
      "A String",
    ],
    "userLists": [ # Requests containing any of these user list ids will match.
      "A String",
    ],
    "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
      "A String",
    ],
    "placements": [ # Requests containing any of these placements will match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
  }


Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
list(accountId) 
Retrieves a list of the authenticated user's pretargeting configurations.

Args:
  accountId: string, The account id to get the pretargeting configs for. (required)

Returns:
  An object of the form:

    {
    "items": [ # A list of pretargeting configs
      {
          "verticals": [ # Requests containing any of these vertical ids will match.
            "A String",
          ],
          "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
            "A String",
          ],
          "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
          "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
            "A String",
          ],
          "configName": "A String", # The name of the config. Must be unique. Required for all requests.
          "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
            "A String",
          ],
          "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
            "A String",
          ],
          "languages": [ # Request containing any of these language codes will match.
            "A String",
          ],
          "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
            "A String",
          ],
          "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
            "A String",
          ],
          "excludedPlacements": [ # Requests containing any of these placements will not match.
            {
              "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
              "type": "A String", # The type of the placement.
            },
          ],
          "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
          "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
            "A String",
          ],
          "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
            "A String",
          ],
          "excludedUserLists": [ # Requests containing any of these users list ids will not match.
            "A String",
          ],
          "isActive": True or False, # Whether this config is active. Required for all requests.
          "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
            {
              "width": "A String", # Width in pixels.
              "height": "A String", # Height in pixels.
            },
          ],
          "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
          "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
            "A String",
          ],
          "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
            "A String",
          ],
          "userLists": [ # Requests containing any of these user list ids will match.
            "A String",
          ],
          "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
            "A String",
          ],
          "placements": [ # Requests containing any of these placements will match.
            {
              "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
              "type": "A String", # The type of the placement.
            },
          ],
        },
    ],
    "kind": "adexchangebuyer#pretargetingConfigList", # Resource type.
  }
patch(accountId, configId, body) 
Updates an existing pretargeting config. This method supports patch semantics.

Args:
  accountId: string, The account id to update the pretargeting config for. (required)
  configId: string, The specific id of the configuration to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "verticals": [ # Requests containing any of these vertical ids will match.
      "A String",
    ],
    "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
      "A String",
    ],
    "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
    "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
      "A String",
    ],
    "configName": "A String", # The name of the config. Must be unique. Required for all requests.
    "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
      "A String",
    ],
    "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
      "A String",
    ],
    "languages": [ # Request containing any of these language codes will match.
      "A String",
    ],
    "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
      "A String",
    ],
    "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
      "A String",
    ],
    "excludedPlacements": [ # Requests containing any of these placements will not match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
    "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
    "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
      "A String",
    ],
    "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
      "A String",
    ],
    "excludedUserLists": [ # Requests containing any of these users list ids will not match.
      "A String",
    ],
    "isActive": True or False, # Whether this config is active. Required for all requests.
    "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
      {
        "width": "A String", # Width in pixels.
        "height": "A String", # Height in pixels.
      },
    ],
    "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
    "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
      "A String",
    ],
    "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
      "A String",
    ],
    "userLists": [ # Requests containing any of these user list ids will match.
      "A String",
    ],
    "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
      "A String",
    ],
    "placements": [ # Requests containing any of these placements will match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
  }


Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
update(accountId, configId, body) 
Updates an existing pretargeting config.

Args:
  accountId: string, The account id to update the pretargeting config for. (required)
  configId: string, The specific id of the configuration to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "verticals": [ # Requests containing any of these vertical ids will match.
      "A String",
    ],
    "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
      "A String",
    ],
    "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
    "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
      "A String",
    ],
    "configName": "A String", # The name of the config. Must be unique. Required for all requests.
    "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
      "A String",
    ],
    "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
      "A String",
    ],
    "languages": [ # Request containing any of these language codes will match.
      "A String",
    ],
    "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
      "A String",
    ],
    "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
      "A String",
    ],
    "excludedPlacements": [ # Requests containing any of these placements will not match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
    "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
    "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
      "A String",
    ],
    "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
      "A String",
    ],
    "excludedUserLists": [ # Requests containing any of these users list ids will not match.
      "A String",
    ],
    "isActive": True or False, # Whether this config is active. Required for all requests.
    "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
      {
        "width": "A String", # Width in pixels.
        "height": "A String", # Height in pixels.
      },
    ],
    "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
    "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
      "A String",
    ],
    "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
      "A String",
    ],
    "userLists": [ # Requests containing any of these user list ids will match.
      "A String",
    ],
    "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
      "A String",
    ],
    "placements": [ # Requests containing any of these placements will match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
  }


Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.accounts.html000066400000000000000000000355271300622755700266000ustar00rootroot00000000000000

Ad Exchange Buyer API . accounts

Instance Methods

get(id)

Gets one account by ID.

list()

Retrieves the authenticated user's list of accounts.

patch(id, body, confirmUnsafeAccountChange=None)

Updates an existing account. This method supports patch semantics.

update(id, body, confirmUnsafeAccountChange=None)

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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
          "bidProtocol": "A String", # The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:
              # - PROTOCOL_ADX
              # - PROTOCOL_OPENRTB_2_2
              # - PROTOCOL_OPENRTB_2_3
              # - PROTOCOL_OPENRTB_PROTOBUF
        },
      ],
      "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "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.
          "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
              "bidProtocol": "A String", # The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:
                  # - PROTOCOL_ADX
                  # - PROTOCOL_OPENRTB_2_2
                  # - PROTOCOL_OPENRTB_2_3
                  # - PROTOCOL_OPENRTB_PROTOBUF
            },
          ],
          "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
          "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
          "id": 42, # Account id.
          "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
        },
    ],
    "kind": "adexchangebuyer#accountsList", # Resource type.
  }
patch(id, body, confirmUnsafeAccountChange=None) 
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.
    "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
        "bidProtocol": "A String", # The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:
            # - PROTOCOL_ADX
            # - PROTOCOL_OPENRTB_2_2
            # - PROTOCOL_OPENRTB_2_3
            # - PROTOCOL_OPENRTB_PROTOBUF
      },
    ],
    "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
    "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
    "id": 42, # Account id.
    "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
  }

  confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls.

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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
          "bidProtocol": "A String", # The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:
              # - PROTOCOL_ADX
              # - PROTOCOL_OPENRTB_2_2
              # - PROTOCOL_OPENRTB_2_3
              # - PROTOCOL_OPENRTB_PROTOBUF
        },
      ],
      "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "id": 42, # Account id.
      "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
    }
update(id, body, confirmUnsafeAccountChange=None) 
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.
    "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
        "bidProtocol": "A String", # The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:
            # - PROTOCOL_ADX
            # - PROTOCOL_OPENRTB_2_2
            # - PROTOCOL_OPENRTB_2_3
            # - PROTOCOL_OPENRTB_PROTOBUF
      },
    ],
    "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
    "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
    "id": 42, # Account id.
    "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
  }

  confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls.

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.
      "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
          "bidProtocol": "A String", # The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:
              # - PROTOCOL_ADX
              # - PROTOCOL_OPENRTB_2_2
              # - PROTOCOL_OPENRTB_2_3
              # - PROTOCOL_OPENRTB_PROTOBUF
        },
      ],
      "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
      "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
      "id": 42, # Account id.
      "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.billingInfo.html000066400000000000000000000061331300622755700272040ustar00rootroot00000000000000

Ad Exchange Buyer API . billingInfo

Instance Methods

get(accountId)

Returns the billing information for one account specified by account ID.

list()

Retrieves a list of billing information for all accounts of the authenticated user.

Method Details

get(accountId) 
Returns the billing information for one account specified by account ID.

Args:
  accountId: integer, The account id. (required)

Returns:
  An object of the form:

    { # The configuration data for an Ad Exchange billing info.
    "billingId": [ # A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.
      "A String",
    ],
    "accountName": "A String", # Account name.
    "kind": "adexchangebuyer#billingInfo", # Resource type.
    "accountId": 42, # Account id.
  }
list() 
Retrieves a list of billing information for all accounts of the authenticated user.

Args:

Returns:
  An object of the form:

    { # A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.
    "items": [ # A list of billing info relevant for your account.
      { # The configuration data for an Ad Exchange billing info.
        "billingId": [ # A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.
          "A String",
        ],
        "accountName": "A String", # Account name.
        "kind": "adexchangebuyer#billingInfo", # Resource type.
        "accountId": 42, # Account id.
      },
    ],
    "kind": "adexchangebuyer#billingInfoList", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.budget.html000066400000000000000000000161201300622755700262170ustar00rootroot00000000000000

Ad Exchange Buyer API . budget

Instance Methods

get(accountId, billingId)

Returns the budget information for the adgroup specified by the accountId and billingId.

patch(accountId, billingId, body)

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

update(accountId, billingId, body)

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Method Details

get(accountId, billingId) 
Returns the budget information for the adgroup specified by the accountId and billingId.

Args:
  accountId: string, The account id to get the budget information for. (required)
  billingId: string, The billing id to get the budget information for. (required)

Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
patch(accountId, billingId, body) 
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

Args:
  accountId: string, The account id associated with the budget being updated. (required)
  billingId: string, The billing id associated with the budget being updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The configuration data for Ad Exchange RTB - Budget API.
    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    "id": "A String", # The unique id that describes this item.
    "accountId": "A String", # The id of the account. This is required for get and update requests.
  }


Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
update(accountId, billingId, body) 
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Args:
  accountId: string, The account id associated with the budget being updated. (required)
  billingId: string, The billing id associated with the budget being updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The configuration data for Ad Exchange RTB - Budget API.
    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    "id": "A String", # The unique id that describes this item.
    "accountId": "A String", # The id of the account. This is required for get and update requests.
  }


Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.creatives.html000066400000000000000000001173451300622755700267450ustar00rootroot00000000000000

Ad Exchange Buyer API . creatives

Instance Methods

addDeal(accountId, buyerCreativeId, dealId)

Add a deal id association for the creative.

get(accountId, buyerCreativeId)

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

insert(body)

Submit a new creative.

list(dealsStatusFilter=None, openAuctionStatusFilter=None, pageToken=None, maxResults=None, buyerCreativeId=None, accountId=None)

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

listDeals(accountId, buyerCreativeId)

Lists the external deal ids associated with the creative.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeDeal(accountId, buyerCreativeId, dealId)

Remove a deal id associated with the creative.

Method Details

addDeal(accountId, buyerCreativeId, dealId) 
Add a deal id association for the 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)
  dealId: string, The id of the deal id to associate with this creative. (required)
get(accountId, buyerCreativeId) 
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

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.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
      "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
        "A String",
      ],
      "accountId": 42, # Account id.
      "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
        "A String",
      ],
      "width": 42, # Ad width.
      "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
        "body": "A String", # A long description of the ad.
        "advertiser": "A String",
        "store": "A String", # The URL to the app store to purchase/download the promoted app.
        "videoURL": "A String",
        "headline": "A String", # A short title for the ad.
        "image": { # A large image.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
        "callToAction": "A String", # A label for the button that the user is supposed to click.
        "logo": { # A smaller image, for the advertiser logo.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "appIcon": { # The app icon, for app download ads.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
          "A String",
        ],
        "price": "A String", # The price of the promoted app including the currency info.
        "clickTrackingUrl": "A String", # The URL to use for click tracking.
      },
      "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
      "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
      "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
        42,
      ],
      "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "agencyId": "A String", # The agency id for this creative.
      "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
        "A String",
      ],
      "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "kind": "adexchangebuyer#creative", # Resource type.
      "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests.
        {
          "contexts": [ # All known contexts/restrictions.
            {
              "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
                "A String",
              ],
              "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
              "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
                "A String",
              ],
              "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
                42,
              ],
            },
          ],
          "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
            {
              "reason": "A String", # The categorized reason for disapproval.
              "details": [ # Additional details about the reason for disapproval.
                "A String",
              ],
            },
          ],
          "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
        },
      ],
      "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
        42,
      ],
      "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
        {
          "contexts": [ # All known serving contexts containing serving status information.
            {
              "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
                "A String",
              ],
              "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
              "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
                "A String",
              ],
              "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
                42,
              ],
            },
          ],
          "reason": "A String", # The type of correction that was applied to the creative.
          "details": [ # Additional details about the correction.
            "A String",
          ],
        },
      ],
      "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
        "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
        "reasons": [ # The filtering reasons.
          {
            "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
            "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
          },
        ],
      },
    }
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.
    "attribute": [ # All attributes for the ads that may be shown from this snippet.
      42,
    ],
    "height": 42, # Ad height.
    "advertiserName": "A String", # The name of the company being advertised in the creative.
    "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
    "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
    "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
    "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
    "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
      "A String",
    ],
    "accountId": 42, # Account id.
    "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
    "clickThroughUrl": [ # The set of destination urls for the snippet.
      "A String",
    ],
    "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
      "A String",
    ],
    "width": 42, # Ad width.
    "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
      "body": "A String", # A long description of the ad.
      "advertiser": "A String",
      "store": "A String", # The URL to the app store to purchase/download the promoted app.
      "videoURL": "A String",
      "headline": "A String", # A short title for the ad.
      "image": { # A large image.
        "url": "A String",
        "width": 42,
        "height": 42,
      },
      "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
      "callToAction": "A String", # A label for the button that the user is supposed to click.
      "logo": { # A smaller image, for the advertiser logo.
        "url": "A String",
        "width": 42,
        "height": 42,
      },
      "appIcon": { # The app icon, for app download ads.
        "url": "A String",
        "width": 42,
        "height": 42,
      },
      "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
        "A String",
      ],
      "price": "A String", # The price of the promoted app including the currency info.
      "clickTrackingUrl": "A String", # The URL to use for click tracking.
    },
    "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
    "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
    "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
      42,
    ],
    "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
      42,
    ],
    "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
      42,
    ],
    "agencyId": "A String", # The agency id for this creative.
    "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
      "A String",
    ],
    "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
    "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
      "A String",
    ],
    "kind": "adexchangebuyer#creative", # Resource type.
    "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests.
      {
        "contexts": [ # All known contexts/restrictions.
          {
            "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
              "A String",
            ],
            "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
            "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
              "A String",
            ],
            "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
              42,
            ],
          },
        ],
        "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
          {
            "reason": "A String", # The categorized reason for disapproval.
            "details": [ # Additional details about the reason for disapproval.
              "A String",
            ],
          },
        ],
        "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
      },
    ],
    "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
      42,
    ],
    "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
      {
        "contexts": [ # All known serving contexts containing serving status information.
          {
            "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
              "A String",
            ],
            "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
            "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
              "A String",
            ],
            "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
              42,
            ],
          },
        ],
        "reason": "A String", # The type of correction that was applied to the creative.
        "details": [ # Additional details about the correction.
          "A String",
        ],
      },
    ],
    "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
      "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
      "reasons": [ # The filtering reasons.
        {
          "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
          "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
        },
      ],
    },
  }


Returns:
  An object of the form:

    { # A creative and its classification data.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
      "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
        "A String",
      ],
      "accountId": 42, # Account id.
      "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
        "A String",
      ],
      "width": 42, # Ad width.
      "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
        "body": "A String", # A long description of the ad.
        "advertiser": "A String",
        "store": "A String", # The URL to the app store to purchase/download the promoted app.
        "videoURL": "A String",
        "headline": "A String", # A short title for the ad.
        "image": { # A large image.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
        "callToAction": "A String", # A label for the button that the user is supposed to click.
        "logo": { # A smaller image, for the advertiser logo.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "appIcon": { # The app icon, for app download ads.
          "url": "A String",
          "width": 42,
          "height": 42,
        },
        "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
          "A String",
        ],
        "price": "A String", # The price of the promoted app including the currency info.
        "clickTrackingUrl": "A String", # The URL to use for click tracking.
      },
      "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
      "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
      "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
        42,
      ],
      "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "agencyId": "A String", # The agency id for this creative.
      "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
        "A String",
      ],
      "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "kind": "adexchangebuyer#creative", # Resource type.
      "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests.
        {
          "contexts": [ # All known contexts/restrictions.
            {
              "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
                "A String",
              ],
              "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
              "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
                "A String",
              ],
              "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
                42,
              ],
            },
          ],
          "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
            {
              "reason": "A String", # The categorized reason for disapproval.
              "details": [ # Additional details about the reason for disapproval.
                "A String",
              ],
            },
          ],
          "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
        },
      ],
      "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
        42,
      ],
      "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
        {
          "contexts": [ # All known serving contexts containing serving status information.
            {
              "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
                "A String",
              ],
              "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
              "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
                "A String",
              ],
              "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
                42,
              ],
            },
          ],
          "reason": "A String", # The type of correction that was applied to the creative.
          "details": [ # Additional details about the correction.
            "A String",
          ],
        },
      ],
      "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
        "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
        "reasons": [ # The filtering reasons.
          {
            "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
            "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
          },
        ],
      },
    }
list(dealsStatusFilter=None, openAuctionStatusFilter=None, pageToken=None, maxResults=None, buyerCreativeId=None, accountId=None) 
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

Args:
  dealsStatusFilter: string, When specified, only creatives having the given deals status are returned.
    Allowed values
      approved - Creatives which have been approved for serving on deals.
      conditionally_approved - Creatives which have been conditionally approved for serving on deals.
      disapproved - Creatives which have been disapproved for serving on deals.
      not_checked - Creatives whose deals status is not yet checked.
  openAuctionStatusFilter: string, When specified, only creatives having the given open auction status are returned.
    Allowed values
      approved - Creatives which have been approved for serving on the open auction.
      conditionally_approved - Creatives which have been conditionally approved for serving on the open auction.
      disapproved - Creatives which have been disapproved for serving on the open auction.
      not_checked - Creatives whose open auction status is not yet checked.
  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.
  buyerCreativeId: string, When specified, only creatives for the given buyer creative ids are returned. (repeated)
  accountId: integer, When specified, only creatives for the given account ids are returned. (repeated)

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.
          "attribute": [ # All attributes for the ads that may be shown from this snippet.
            42,
          ],
          "height": 42, # Ad height.
          "advertiserName": "A String", # The name of the company being advertised in the creative.
          "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
          "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
          "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
          "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
          "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
            "A String",
          ],
          "accountId": 42, # Account id.
          "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
          "clickThroughUrl": [ # The set of destination urls for the snippet.
            "A String",
          ],
          "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
            "A String",
          ],
          "width": 42, # Ad width.
          "nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
            "body": "A String", # A long description of the ad.
            "advertiser": "A String",
            "store": "A String", # The URL to the app store to purchase/download the promoted app.
            "videoURL": "A String",
            "headline": "A String", # A short title for the ad.
            "image": { # A large image.
              "url": "A String",
              "width": 42,
              "height": 42,
            },
            "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
            "callToAction": "A String", # A label for the button that the user is supposed to click.
            "logo": { # A smaller image, for the advertiser logo.
              "url": "A String",
              "width": 42,
              "height": 42,
            },
            "appIcon": { # The app icon, for app download ads.
              "url": "A String",
              "width": 42,
              "height": 42,
            },
            "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
              "A String",
            ],
            "price": "A String", # The price of the promoted app including the currency info.
            "clickTrackingUrl": "A String", # The URL to use for click tracking.
          },
          "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
          "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
          "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
            42,
          ],
          "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
            42,
          ],
          "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
            42,
          ],
          "agencyId": "A String", # The agency id for this creative.
          "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
            "A String",
          ],
          "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
          "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
            "A String",
          ],
          "kind": "adexchangebuyer#creative", # Resource type.
          "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests.
            {
              "contexts": [ # All known contexts/restrictions.
                {
                  "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
                    "A String",
                  ],
                  "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
                  "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
                    "A String",
                  ],
                  "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
                    42,
                  ],
                },
              ],
              "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
                {
                  "reason": "A String", # The categorized reason for disapproval.
                  "details": [ # Additional details about the reason for disapproval.
                    "A String",
                  ],
                },
              ],
              "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
            },
          ],
          "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
            42,
          ],
          "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
            {
              "contexts": [ # All known serving contexts containing serving status information.
                {
                  "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
                    "A String",
                  ],
                  "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
                  "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
                    "A String",
                  ],
                  "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
                    42,
                  ],
                },
              ],
              "reason": "A String", # The type of correction that was applied to the creative.
              "details": [ # Additional details about the correction.
                "A String",
              ],
            },
          ],
          "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
            "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
            "reasons": [ # The filtering reasons.
              {
                "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
                "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
              },
            ],
          },
        },
    ],
    "kind": "adexchangebuyer#creativesList", # Resource type.
  }
listDeals(accountId, buyerCreativeId) 
Lists the external deal ids associated with the 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:

    { # The external deal ids associated with a creative.
    "dealStatuses": [ # A list of external deal ids and ARC approval status.
      {
        "webPropertyId": 42, # Publisher ID.
        "dealId": "A String", # External deal ID.
        "arcStatus": "A String", # ARC approval status.
      },
    ],
    "kind": "adexchangebuyer#creativeDealIds", # 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.
removeDeal(accountId, buyerCreativeId, dealId) 
Remove a deal id associated with the 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)
  dealId: string, The id of the deal id to disassociate with this creative. (required)
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.html000066400000000000000000000100011300622755700247360ustar00rootroot00000000000000

Ad Exchange Buyer API

Instance Methods

accounts()

Returns the accounts Resource.

billingInfo()

Returns the billingInfo Resource.

budget()

Returns the budget Resource.

creatives()

Returns the creatives Resource.

marketplacedeals()

Returns the marketplacedeals Resource.

marketplacenotes()

Returns the marketplacenotes Resource.

marketplaceprivateauction()

Returns the marketplaceprivateauction Resource.

performanceReport()

Returns the performanceReport Resource.

pretargetingConfig()

Returns the pretargetingConfig Resource.

products()

Returns the products Resource.

proposals()

Returns the proposals Resource.

pubprofiles()

Returns the pubprofiles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html000066400000000000000000003217751300622755700302650ustar00rootroot00000000000000

Ad Exchange Buyer API . marketplacedeals

Instance Methods

delete(proposalId, body)

Delete the specified deals from the proposal

insert(proposalId, body)

Add new deals for the specified proposal

list(proposalId, pqlQuery=None)

List all the deals for a given proposal

update(proposalId, body)

Replaces all the deals in the proposal with the passed in deals

Method Details

delete(proposalId, body) 
Delete the specified deals from the proposal

Args:
  proposalId: string, The proposalId to delete deals from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "proposalRevisionNumber": "A String", # The last known proposal revision number.
    "updateAction": "A String", # Indicates an optional action to take on the proposal
    "dealIds": [ # List of deals to delete for a given proposal
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "deals": [ # List of deals deleted (in the same proposal as passed in the request)
      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
        "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
        "webPropertyCode": "A String",
        "proposalId": "A String",
        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal. (updatable)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "dealId": "A String", # A unique deal-id for the deal (readonly).
        "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
        "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
        "name": "A String", # The name of the deal. (updatable)
        "buyerPrivateData": { # Buyer private data (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
        "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
          "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
            "hasSellerPaused": True or False,
            "buyerPauseReason": "A String",
            "sellerPauseReason": "A String",
            "hasBuyerPaused": True or False,
            "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
          },
        },
        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
      },
    ],
    "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
  }
insert(proposalId, body) 
Add new deals for the specified proposal

Args:
  proposalId: string, proposalId for which deals need to be added. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "deals": [ # The list of deals to add
      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
        "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
        "webPropertyCode": "A String",
        "proposalId": "A String",
        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal. (updatable)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "dealId": "A String", # A unique deal-id for the deal (readonly).
        "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
        "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
        "name": "A String", # The name of the deal. (updatable)
        "buyerPrivateData": { # Buyer private data (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
        "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
          "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
            "hasSellerPaused": True or False,
            "buyerPauseReason": "A String",
            "sellerPauseReason": "A String",
            "hasBuyerPaused": True or False,
            "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
          },
        },
        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
      },
    ],
    "proposalRevisionNumber": "A String", # The last known proposal revision number.
    "updateAction": "A String", # Indicates an optional action to take on the proposal
  }


Returns:
  An object of the form:

    {
    "deals": [ # List of deals added (in the same proposal as passed in the request)
      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
        "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
        "webPropertyCode": "A String",
        "proposalId": "A String",
        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal. (updatable)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "dealId": "A String", # A unique deal-id for the deal (readonly).
        "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
        "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
        "name": "A String", # The name of the deal. (updatable)
        "buyerPrivateData": { # Buyer private data (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
        "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
          "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
            "hasSellerPaused": True or False,
            "buyerPauseReason": "A String",
            "sellerPauseReason": "A String",
            "hasBuyerPaused": True or False,
            "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
          },
        },
        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
      },
    ],
    "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
  }
list(proposalId, pqlQuery=None) 
List all the deals for a given proposal

Args:
  proposalId: string, The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL. (required)
  pqlQuery: string, Query string to retrieve specific deals.

Returns:
  An object of the form:

    {
    "deals": [ # List of deals for the proposal
      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
        "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
        "webPropertyCode": "A String",
        "proposalId": "A String",
        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal. (updatable)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "dealId": "A String", # A unique deal-id for the deal (readonly).
        "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
        "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
        "name": "A String", # The name of the deal. (updatable)
        "buyerPrivateData": { # Buyer private data (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
        "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
          "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
            "hasSellerPaused": True or False,
            "buyerPauseReason": "A String",
            "sellerPauseReason": "A String",
            "hasBuyerPaused": True or False,
            "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
          },
        },
        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
      },
    ],
  }
update(proposalId, body) 
Replaces all the deals in the proposal with the passed in deals

Args:
  proposalId: string, The proposalId to edit deals on. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "deals": [ # List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.
      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
        "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
        "webPropertyCode": "A String",
        "proposalId": "A String",
        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal. (updatable)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "dealId": "A String", # A unique deal-id for the deal (readonly).
        "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
        "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
        "name": "A String", # The name of the deal. (updatable)
        "buyerPrivateData": { # Buyer private data (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
        "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
          "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
            "hasSellerPaused": True or False,
            "buyerPauseReason": "A String",
            "sellerPauseReason": "A String",
            "hasBuyerPaused": True or False,
            "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
          },
        },
        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
      },
    ],
    "proposal": { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: # If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction.
        #
        # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
      "labels": [ # List of labels associated with the proposal. (readonly)
        {
          "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
          "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
            "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
              "accountId": "A String", # Adx account id of the buyer.
            },
            "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
              "subAccountId": "A String", # Optional sub-account id for the seller.
              "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
            },
          },
          "label": "A String", # The label to use.
          "accountId": "A String", # The accountId of the party that created the label.
        },
      ],
      "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
        {
          "email": "A String", # Email address of the contact.
          "name": "A String", # The name of the contact.
        },
      ],
      "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
      "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
      "revisionNumber": "A String", # The revision number for the proposal (readonly).
      "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
      "seller": { # Reference to the seller on the proposal. (readonly, except on create)
        "subAccountId": "A String", # Optional sub-account id for the seller.
        "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
      },
      "proposalId": "A String", # The unique id of the proposal. (readonly).
      "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
      "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
        "A String",
      ],
      "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
      "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
      "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
      "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
      "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
        "accountId": "A String", # Adx account id of the buyer.
      },
      "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
      "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
      "proposalState": "A String", # The current state of the proposal. (readonly)
      "name": "A String", # The name for the proposal (updatable)
      "buyerPrivateData": { # Private data for buyer. (hidden from seller).
        "referenceId": "A String",
        "referencePayload": "A String",
      },
      "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
        "accountId": "A String", # Adx account id of the buyer.
      },
      "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
      "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
        {
          "email": "A String", # Email address of the contact.
          "name": "A String", # The name of the contact.
        },
      ],
    },
    "proposalRevisionNumber": "A String", # The last known revision number for the proposal.
    "updateAction": "A String", # Indicates an optional action to take on the proposal
  }


Returns:
  An object of the form:

    {
    "deals": [ # List of all deals in the proposal after edit.
      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
        "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "isRfpTemplate": True or False, # Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.
        "webPropertyCode": "A String",
        "proposalId": "A String",
        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal. (updatable)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "dealId": "A String", # A unique deal-id for the deal (readonly).
        "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
        "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
        "name": "A String", # The name of the deal. (updatable)
        "buyerPrivateData": { # Buyer private data (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
        "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
        "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
          "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
            "hasSellerPaused": True or False,
            "buyerPauseReason": "A String",
            "sellerPauseReason": "A String",
            "hasBuyerPaused": True or False,
            "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
          },
        },
        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
      },
    ],
    "orderRevisionNumber": "A String", # The latest revision number after the update has been applied.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html000066400000000000000000000131201300622755700303030ustar00rootroot00000000000000

Ad Exchange Buyer API . marketplacenotes

Instance Methods

insert(proposalId, body)

Add notes to the proposal

list(proposalId, pqlQuery=None)

Get all the notes associated with a proposal

Method Details

insert(proposalId, body) 
Add notes to the proposal

Args:
  proposalId: string, The proposalId to add notes for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "notes": [ # The list of notes to add.
      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
        "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
        "note": "A String", # The actual note to attach. (readonly, except on create)
        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
        "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
        "noteId": "A String", # The unique id for the note. (readonly)
        "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
      },
    ],
  }


Returns:
  An object of the form:

    {
    "notes": [
      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
        "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
        "note": "A String", # The actual note to attach. (readonly, except on create)
        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
        "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
        "noteId": "A String", # The unique id for the note. (readonly)
        "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
      },
    ],
  }
list(proposalId, pqlQuery=None) 
Get all the notes associated with a proposal

Args:
  proposalId: string, The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL. (required)
  pqlQuery: string, Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%"

Returns:
  An object of the form:

    {
    "notes": [ # The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first.
      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
        "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
        "note": "A String", # The actual note to attach. (readonly, except on create)
        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
        "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
        "noteId": "A String", # The unique id for the note. (readonly)
        "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.marketplaceprivateauction.html000066400000000000000000000056631300622755700322250ustar00rootroot00000000000000

Ad Exchange Buyer API . marketplaceprivateauction

Instance Methods

updateproposal(privateAuctionId, body)

Update a given private auction proposal

Method Details

updateproposal(privateAuctionId, body) 
Update a given private auction proposal

Args:
  privateAuctionId: string, The private auction id to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "note": { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. # Optional note to be added.
      "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
      "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
      "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
      "note": "A String", # The actual note to attach. (readonly, except on create)
      "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
      "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
      "noteId": "A String", # The unique id for the note. (readonly)
      "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
    },
    "externalDealId": "A String", # The externalDealId of the deal to be updated.
    "proposalRevisionNumber": "A String", # The current revision number of the proposal to be updated.
    "updateAction": "A String", # The proposed action on the private auction proposal.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.performanceReport.html000066400000000000000000000116511300622755700304460ustar00rootroot00000000000000

Ad Exchange Buyer API . performanceReport

Instance Methods

list(accountId, endDateTime, startDateTime, pageToken=None, maxResults=None)

Retrieves the authenticated user's list of performance metrics.

Method Details

list(accountId, endDateTime, startDateTime, pageToken=None, maxResults=None) 
Retrieves the authenticated user's list of performance metrics.

Args:
  accountId: string, The account id to get the reports. (required)
  endDateTime: string, The end time of the report in ISO 8601 timestamp format using UTC. (required)
  startDateTime: string, The start time of the report in ISO 8601 timestamp format using UTC. (required)
  pageToken: string, A continuation token, used to page through performance reports. 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.

Returns:
  An object of the form:

    { # The configuration data for an Ad Exchange performance report list.
    "kind": "adexchangebuyer#performanceReportList", # Resource type.
    "performanceReport": [ # A list of performance reports relevant for the account.
      { # The configuration data for an Ad Exchange performance report list.
        "bidRequestRate": 3.14, # The number of bid requests sent to your bidder.
        "unsuccessfulRequestRate": 3.14, # The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.
        "successfulRequestRate": 3.14, # The number of properly formed bid responses received by our servers within the deadline.
        "hostedMatchStatusRate": [ # Average QPS for hosted match operations.
          "",
        ],
        "bidRate": 3.14, # The number of bid responses with an ad.
        "quotaThrottledLimit": 3.14, # The throttled quota limits for this account.
        "cookieMatcherStatusRate": [ # Average QPS for cookie matcher operations.
          "",
        ],
        "calloutStatusRate": [ # Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.
          "",
        ],
        "noQuotaInRegion": 3.14, # Rate of various quota account statuses per quota check.
        "timestamp": "A String", # The unix timestamp of the starting time of this performance data.
        "latency50thPercentile": 3.14, # The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
        "latency85thPercentile": 3.14, # The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
        "pixelMatchResponses": 3.14, # Average QPS for pixel match responses from clients.
        "creativeStatusRate": [ # Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.
          "",
        ],
        "latency95thPercentile": 3.14, # The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
        "kind": "adexchangebuyer#performanceReport", # Resource type.
        "inventoryMatchRate": 3.14, # The number of potential queries based on your pretargeting settings.
        "region": "A String", # The trading location of this data.
        "quotaConfiguredLimit": 3.14, # The configured quota limits for this account.
        "outOfQuota": 3.14, # Rate of various quota account statuses per quota check.
        "filteredBidRate": 3.14, # The number of bid responses that were filtered due to a policy violation or other errors.
        "pixelMatchRequests": 3.14, # Average QPS for pixel match requests from clients.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.pretargetingConfig.html000066400000000000000000001221201300622755700305640ustar00rootroot00000000000000

Ad Exchange Buyer API . pretargetingConfig

Instance Methods

delete(accountId, configId)

Deletes an existing pretargeting config.

get(accountId, configId)

Gets a specific pretargeting configuration

insert(accountId, body)

Inserts a new pretargeting configuration.

list(accountId)

Retrieves a list of the authenticated user's pretargeting configurations.

patch(accountId, configId, body)

Updates an existing pretargeting config. This method supports patch semantics.

update(accountId, configId, body)

Updates an existing pretargeting config.

Method Details

delete(accountId, configId) 
Deletes an existing pretargeting config.

Args:
  accountId: string, The account id to delete the pretargeting config for. (required)
  configId: string, The specific id of the configuration to delete. (required)
get(accountId, configId) 
Gets a specific pretargeting configuration

Args:
  accountId: string, The account id to get the pretargeting config for. (required)
  configId: string, The specific id of the configuration to retrieve. (required)

Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
        {
          "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
          "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
          "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
        },
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
insert(accountId, body) 
Inserts a new pretargeting configuration.

Args:
  accountId: string, The account id to insert the pretargeting config for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "verticals": [ # Requests containing any of these vertical ids will match.
      "A String",
    ],
    "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
      "A String",
    ],
    "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
      {
        "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
        "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
        "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
      },
    ],
    "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
    "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
      "A String",
    ],
    "configName": "A String", # The name of the config. Must be unique. Required for all requests.
    "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
      "A String",
    ],
    "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
      "A String",
    ],
    "languages": [ # Request containing any of these language codes will match.
      "A String",
    ],
    "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
      "A String",
    ],
    "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
      "A String",
    ],
    "excludedPlacements": [ # Requests containing any of these placements will not match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
    "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
    "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
      "A String",
    ],
    "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
      "A String",
    ],
    "excludedUserLists": [ # Requests containing any of these users list ids will not match.
      "A String",
    ],
    "isActive": True or False, # Whether this config is active. Required for all requests.
    "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
      {
        "width": "A String", # Width in pixels.
        "height": "A String", # Height in pixels.
      },
    ],
    "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
    "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
      "A String",
    ],
    "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
      "A String",
    ],
    "userLists": [ # Requests containing any of these user list ids will match.
      "A String",
    ],
    "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
      "A String",
    ],
    "placements": [ # Requests containing any of these placements will match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
  }


Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
        {
          "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
          "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
          "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
        },
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
list(accountId) 
Retrieves a list of the authenticated user's pretargeting configurations.

Args:
  accountId: string, The account id to get the pretargeting configs for. (required)

Returns:
  An object of the form:

    {
    "items": [ # A list of pretargeting configs
      {
          "verticals": [ # Requests containing any of these vertical ids will match.
            "A String",
          ],
          "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
            "A String",
          ],
          "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
            {
              "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
              "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
              "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
            },
          ],
          "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
          "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
            "A String",
          ],
          "configName": "A String", # The name of the config. Must be unique. Required for all requests.
          "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
            "A String",
          ],
          "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
            "A String",
          ],
          "languages": [ # Request containing any of these language codes will match.
            "A String",
          ],
          "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
            "A String",
          ],
          "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
            "A String",
          ],
          "excludedPlacements": [ # Requests containing any of these placements will not match.
            {
              "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
              "type": "A String", # The type of the placement.
            },
          ],
          "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
          "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
            "A String",
          ],
          "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
            "A String",
          ],
          "excludedUserLists": [ # Requests containing any of these users list ids will not match.
            "A String",
          ],
          "isActive": True or False, # Whether this config is active. Required for all requests.
          "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
            {
              "width": "A String", # Width in pixels.
              "height": "A String", # Height in pixels.
            },
          ],
          "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
          "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
            "A String",
          ],
          "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
            "A String",
          ],
          "userLists": [ # Requests containing any of these user list ids will match.
            "A String",
          ],
          "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
            "A String",
          ],
          "placements": [ # Requests containing any of these placements will match.
            {
              "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
              "type": "A String", # The type of the placement.
            },
          ],
        },
    ],
    "kind": "adexchangebuyer#pretargetingConfigList", # Resource type.
  }
patch(accountId, configId, body) 
Updates an existing pretargeting config. This method supports patch semantics.

Args:
  accountId: string, The account id to update the pretargeting config for. (required)
  configId: string, The specific id of the configuration to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "verticals": [ # Requests containing any of these vertical ids will match.
      "A String",
    ],
    "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
      "A String",
    ],
    "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
      {
        "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
        "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
        "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
      },
    ],
    "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
    "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
      "A String",
    ],
    "configName": "A String", # The name of the config. Must be unique. Required for all requests.
    "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
      "A String",
    ],
    "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
      "A String",
    ],
    "languages": [ # Request containing any of these language codes will match.
      "A String",
    ],
    "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
      "A String",
    ],
    "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
      "A String",
    ],
    "excludedPlacements": [ # Requests containing any of these placements will not match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
    "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
    "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
      "A String",
    ],
    "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
      "A String",
    ],
    "excludedUserLists": [ # Requests containing any of these users list ids will not match.
      "A String",
    ],
    "isActive": True or False, # Whether this config is active. Required for all requests.
    "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
      {
        "width": "A String", # Width in pixels.
        "height": "A String", # Height in pixels.
      },
    ],
    "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
    "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
      "A String",
    ],
    "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
      "A String",
    ],
    "userLists": [ # Requests containing any of these user list ids will match.
      "A String",
    ],
    "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
      "A String",
    ],
    "placements": [ # Requests containing any of these placements will match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
  }


Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
        {
          "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
          "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
          "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
        },
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
update(accountId, configId, body) 
Updates an existing pretargeting config.

Args:
  accountId: string, The account id to update the pretargeting config for. (required)
  configId: string, The specific id of the configuration to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "verticals": [ # Requests containing any of these vertical ids will match.
      "A String",
    ],
    "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
      "A String",
    ],
    "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
      {
        "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
        "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
        "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
      },
    ],
    "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
    "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
      "A String",
    ],
    "configName": "A String", # The name of the config. Must be unique. Required for all requests.
    "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
      "A String",
    ],
    "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
      "A String",
    ],
    "languages": [ # Request containing any of these language codes will match.
      "A String",
    ],
    "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
      "A String",
    ],
    "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
      "A String",
    ],
    "excludedPlacements": [ # Requests containing any of these placements will not match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
    "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
    "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
      "A String",
    ],
    "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
      "A String",
    ],
    "excludedUserLists": [ # Requests containing any of these users list ids will not match.
      "A String",
    ],
    "isActive": True or False, # Whether this config is active. Required for all requests.
    "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
      {
        "width": "A String", # Width in pixels.
        "height": "A String", # Height in pixels.
      },
    ],
    "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
    "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
      "A String",
    ],
    "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
      "A String",
    ],
    "userLists": [ # Requests containing any of these user list ids will match.
      "A String",
    ],
    "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
      "A String",
    ],
    "placements": [ # Requests containing any of these placements will match.
      {
        "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
        "type": "A String", # The type of the placement.
      },
    ],
  }


Returns:
  An object of the form:

    {
      "verticals": [ # Requests containing any of these vertical ids will match.
        "A String",
      ],
      "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
        "A String",
      ],
      "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match.
        {
          "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width.
          "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios.
          "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height.
        },
      ],
      "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
      "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
        "A String",
      ],
      "configName": "A String", # The name of the config. Must be unique. Required for all requests.
      "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
        "A String",
      ],
      "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
        "A String",
      ],
      "languages": [ # Request containing any of these language codes will match.
        "A String",
      ],
      "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
        "A String",
      ],
      "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
        "A String",
      ],
      "excludedPlacements": [ # Requests containing any of these placements will not match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
      "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
      "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
        "A String",
      ],
      "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
        "A String",
      ],
      "excludedUserLists": [ # Requests containing any of these users list ids will not match.
        "A String",
      ],
      "isActive": True or False, # Whether this config is active. Required for all requests.
      "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
        {
          "width": "A String", # Width in pixels.
          "height": "A String", # Height in pixels.
        },
      ],
      "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
      "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
        "A String",
      ],
      "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
        "A String",
      ],
      "userLists": [ # Requests containing any of these user list ids will match.
        "A String",
      ],
      "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
        "A String",
      ],
      "placements": [ # Requests containing any of these placements will match.
        {
          "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
          "type": "A String", # The type of the placement.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.products.html000066400000000000000000001115441300622755700266160ustar00rootroot00000000000000

Ad Exchange Buyer API . products

Instance Methods

get(productId)

Gets the requested product by id.

search(pqlQuery=None)

Gets the requested product.

Method Details

get(productId) 
Gets the requested product by id.

Args:
  productId: string, The id for the product to get the head revision for. (required)

Returns:
  An object of the form:

    { # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:
      #
      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
    "creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly)
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
    "publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher self-provided forecast information.
      "weeklyImpressions": "A String", # Publisher provided weekly impressions.
      "dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc...
        { # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}
          "dimensionType": "A String",
          "dimensionValues": [
            { # Value of the dimension.
              "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.
              "id": 42, # Id of the dimension.
              "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
            },
          ],
        },
      ],
      "weeklyUniques": "A String", # Publisher provided weekly uniques.
    },
    "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
    "labels": [ # Optional List of labels for the product (optional, buyer-readonly).
      {
        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
            "accountId": "A String", # Adx account id of the buyer.
          },
          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
            "subAccountId": "A String", # Optional sub-account id for the seller.
            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
          },
        },
        "label": "A String", # The label to use.
        "accountId": "A String", # The accountId of the party that created the label.
      },
    ],
    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
    "publisherProfileId": "A String", # Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller.
    "revisionNumber": "A String", # The revision number of the product. (readonly)
    "seller": { # Information about the seller that created this product (readonly, except on create)
      "subAccountId": "A String", # Optional sub-account id for the seller.
      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
    },
    "webPropertyCode": "A String", # The web property code for the seller. This field is meant to be copied over as is when creating deals.
    "state": "A String", # The state of the product. (buyer-readonly)
    "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
    "productId": "A String", # The unique id for the product (readonly)
    "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
      "frequencyCaps": [
        {
          "numTimeUnits": 42,
          "timeUnitType": "A String",
          "maxImpressions": 42,
        },
      ],
      "creativeBlockingLevel": "A String",
      "deliveryRateType": "A String",
    },
    "terms": { # The negotiable terms of the deal (buyer-readonly)
      "brandingType": "A String", # Visibilty of the URL in bid requests.
      "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
      "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
        "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
        "fixedPrices": [ # Fixed price for the specified buyer.
          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
            "auctionTier": "A String", # Optional access type for this buyer.
            "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
              "accountId": "A String", # Adx account id of the buyer.
            },
            "price": { # The specified price
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
        ],
        "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
        "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
        "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
          "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
          "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
          "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
        },
      },
      "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
      "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
      "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
        "fixedPrices": [ # Fixed price for the specified buyer.
          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
            "auctionTier": "A String", # Optional access type for this buyer.
            "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
              "accountId": "A String", # Adx account id of the buyer.
            },
            "price": { # The specified price
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
        ],
      },
      "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
        "pricingType": "A String", # The pricing type for the deal/product.
        "currencyCode": "A String", # The currency code for the price.
        "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
        "amountMicros": 3.14, # The price value in micros.
      },
      "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
        "priorityPrice": { # Optional price for Rubicon priority access in the auction.
          "pricingType": "A String", # The pricing type for the deal/product.
          "currencyCode": "A String", # The currency code for the price.
          "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
          "amountMicros": 3.14, # The price value in micros.
        },
        "standardPrice": { # Optional price for Rubicon standard access in the auction.
          "pricingType": "A String", # The pricing type for the deal/product.
          "currencyCode": "A String", # The currency code for the price.
          "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
          "amountMicros": 3.14, # The price value in micros.
        },
      },
      "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
        "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
        "reservePricePerBuyers": [ # Reserve price for the specified buyer.
          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
            "auctionTier": "A String", # Optional access type for this buyer.
            "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
              "accountId": "A String", # Adx account id of the buyer.
            },
            "price": { # The specified price
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
        ],
      },
      "description": "A String", # Description for the proposed terms of the deal.
    },
    "privateAuctionId": "A String", # Optional private auction id if this offer is a private auction offer.
    "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
      {
        "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
          {
            "longValue": "A String", # The long value to exclude/include.
            "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
              "dayParts": [
                {
                  "dayOfWeek": "A String",
                  "endHour": 42,
                  "startMinute": 42,
                  "endMinute": 42,
                  "startHour": 42,
                },
              ],
              "timeZoneType": "A String",
            },
            "creativeSizeValue": { # The creative size value to exclude/include.
              "skippableAdType": "A String", # The skippable ad type for video size.
              "creativeSizeType": "A String", # The Creative size type.
              "companionSizes": [ # For video size type, the list of companion sizes.
                {
                  "width": 42, # The width of the creative.
                  "height": 42, # The height of the creative.
                },
              ],
              "size": { # For regular or video creative size type, specifies the size of the creative.
                "width": 42, # The width of the creative.
                "height": 42, # The height of the creative.
              },
            },
            "stringValue": "A String", # The string value to exclude/include.
          },
        ],
        "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
          {
            "longValue": "A String", # The long value to exclude/include.
            "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
              "dayParts": [
                {
                  "dayOfWeek": "A String",
                  "endHour": 42,
                  "startMinute": 42,
                  "endMinute": 42,
                  "startHour": 42,
                },
              ],
              "timeZoneType": "A String",
            },
            "creativeSizeValue": { # The creative size value to exclude/include.
              "skippableAdType": "A String", # The skippable ad type for video size.
              "creativeSizeType": "A String", # The Creative size type.
              "companionSizes": [ # For video size type, the list of companion sizes.
                {
                  "width": 42, # The width of the creative.
                  "height": 42, # The height of the creative.
                },
              ],
              "size": { # For regular or video creative size type, specifies the size of the creative.
                "width": 42, # The width of the creative.
                "height": 42, # The height of the creative.
              },
            },
            "stringValue": "A String", # The string value to exclude/include.
          },
        ],
        "key": "A String", # The key representing the shared targeting criterion.
      },
    ],
    "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
    "legacyOfferId": "A String", # Optional legacy offer id if this offer is a preferred deal offer.
    "kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
    "name": "A String", # The name for this product as set by the seller. (buyer-readonly)
    "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
    "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
    "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
  }
search(pqlQuery=None) 
Gets the requested product.

Args:
  pqlQuery: string, The pql query used to query for products.

Returns:
  An object of the form:

    {
    "products": [ # The returned list of products.
      { # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:
          #
          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
        "creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher self-provided forecast information.
          "weeklyImpressions": "A String", # Publisher provided weekly impressions.
          "dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc...
            { # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}
              "dimensionType": "A String",
              "dimensionValues": [
                { # Value of the dimension.
                  "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.
                  "id": 42, # Id of the dimension.
                  "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
                },
              ],
            },
          ],
          "weeklyUniques": "A String", # Publisher provided weekly uniques.
        },
        "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
        "labels": [ # Optional List of labels for the product (optional, buyer-readonly).
          {
            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
                "accountId": "A String", # Adx account id of the buyer.
              },
              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
                "subAccountId": "A String", # Optional sub-account id for the seller.
                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
              },
            },
            "label": "A String", # The label to use.
            "accountId": "A String", # The accountId of the party that created the label.
          },
        ],
        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
        "publisherProfileId": "A String", # Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller.
        "revisionNumber": "A String", # The revision number of the product. (readonly)
        "seller": { # Information about the seller that created this product (readonly, except on create)
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
        "webPropertyCode": "A String", # The web property code for the seller. This field is meant to be copied over as is when creating deals.
        "state": "A String", # The state of the product. (buyer-readonly)
        "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
        "productId": "A String", # The unique id for the product (readonly)
        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
          "frequencyCaps": [
            {
              "numTimeUnits": 42,
              "timeUnitType": "A String",
              "maxImpressions": 42,
            },
          ],
          "creativeBlockingLevel": "A String",
          "deliveryRateType": "A String",
        },
        "terms": { # The negotiable terms of the deal (buyer-readonly)
          "brandingType": "A String", # Visibilty of the URL in bid requests.
          "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
            "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
            "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
              "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
                "pricingType": "A String", # The pricing type for the deal/product.
                "currencyCode": "A String", # The currency code for the price.
                "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                "amountMicros": 3.14, # The price value in micros.
              },
              "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
              "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
              "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
            },
          },
          "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
            "fixedPrices": [ # Fixed price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
            "pricingType": "A String", # The pricing type for the deal/product.
            "currencyCode": "A String", # The currency code for the price.
            "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
            "amountMicros": 3.14, # The price value in micros.
          },
          "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
            "priorityPrice": { # Optional price for Rubicon priority access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
            "standardPrice": { # Optional price for Rubicon standard access in the auction.
              "pricingType": "A String", # The pricing type for the deal/product.
              "currencyCode": "A String", # The currency code for the price.
              "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
              "amountMicros": 3.14, # The price value in micros.
            },
          },
          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                "auctionTier": "A String", # Optional access type for this buyer.
                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                  "accountId": "A String", # Adx account id of the buyer.
                },
                "price": { # The specified price
                  "pricingType": "A String", # The pricing type for the deal/product.
                  "currencyCode": "A String", # The currency code for the price.
                  "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
                  "amountMicros": 3.14, # The price value in micros.
                },
              },
            ],
          },
          "description": "A String", # Description for the proposed terms of the deal.
        },
        "privateAuctionId": "A String", # Optional private auction id if this offer is a private auction offer.
        "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
          {
            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
              {
                "longValue": "A String", # The long value to exclude/include.
                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
                  "dayParts": [
                    {
                      "dayOfWeek": "A String",
                      "endHour": 42,
                      "startMinute": 42,
                      "endMinute": 42,
                      "startHour": 42,
                    },
                  ],
                  "timeZoneType": "A String",
                },
                "creativeSizeValue": { # The creative size value to exclude/include.
                  "skippableAdType": "A String", # The skippable ad type for video size.
                  "creativeSizeType": "A String", # The Creative size type.
                  "companionSizes": [ # For video size type, the list of companion sizes.
                    {
                      "width": 42, # The width of the creative.
                      "height": 42, # The height of the creative.
                    },
                  ],
                  "size": { # For regular or video creative size type, specifies the size of the creative.
                    "width": 42, # The width of the creative.
                    "height": 42, # The height of the creative.
                  },
                },
                "stringValue": "A String", # The string value to exclude/include.
              },
            ],
            "key": "A String", # The key representing the shared targeting criterion.
          },
        ],
        "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
        "legacyOfferId": "A String", # Optional legacy offer id if this offer is a preferred deal offer.
        "kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
        "name": "A String", # The name for this product as set by the seller. (buyer-readonly)
        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
        "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
        "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.proposals.html000066400000000000000000001246101300622755700267730ustar00rootroot00000000000000

Ad Exchange Buyer API . proposals

Instance Methods

get(proposalId)

Get a proposal given its id

insert(body)

Create the given list of proposals

patch(proposalId, revisionNumber, updateAction, body)

Update the given proposal. This method supports patch semantics.

search(pqlQuery=None)

Search for proposals using pql query

setupcomplete(proposalId)

Update the given proposal to indicate that setup has been completed.

update(proposalId, revisionNumber, updateAction, body)

Update the given proposal

Method Details

get(proposalId) 
Get a proposal given its id

Args:
  proposalId: string, Id of the proposal to retrieve. (required)

Returns:
  An object of the form:

    { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
      #
      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
    "labels": [ # List of labels associated with the proposal. (readonly)
      {
        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
            "accountId": "A String", # Adx account id of the buyer.
          },
          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
            "subAccountId": "A String", # Optional sub-account id for the seller.
            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
          },
        },
        "label": "A String", # The label to use.
        "accountId": "A String", # The accountId of the party that created the label.
      },
    ],
    "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
    "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
    "revisionNumber": "A String", # The revision number for the proposal (readonly).
    "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
    "seller": { # Reference to the seller on the proposal. (readonly, except on create)
      "subAccountId": "A String", # Optional sub-account id for the seller.
      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
    },
    "proposalId": "A String", # The unique id of the proposal. (readonly).
    "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
    "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
      "A String",
    ],
    "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
    "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
    "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
    "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
    "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
      "accountId": "A String", # Adx account id of the buyer.
    },
    "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
    "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
    "proposalState": "A String", # The current state of the proposal. (readonly)
    "name": "A String", # The name for the proposal (updatable)
    "buyerPrivateData": { # Private data for buyer. (hidden from seller).
      "referenceId": "A String",
      "referencePayload": "A String",
    },
    "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
      "accountId": "A String", # Adx account id of the buyer.
    },
    "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
    "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
  }
insert(body) 
Create the given list of proposals

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "webPropertyCode": "A String", # Web property id of the seller creating these orders
    "proposals": [ # The list of proposals to create.
      { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
          #
          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
        "labels": [ # List of labels associated with the proposal. (readonly)
          {
            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
                "accountId": "A String", # Adx account id of the buyer.
              },
              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
                "subAccountId": "A String", # Optional sub-account id for the seller.
                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
              },
            },
            "label": "A String", # The label to use.
            "accountId": "A String", # The accountId of the party that created the label.
          },
        ],
        "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
        "revisionNumber": "A String", # The revision number for the proposal (readonly).
        "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
        "seller": { # Reference to the seller on the proposal. (readonly, except on create)
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
        "proposalId": "A String", # The unique id of the proposal. (readonly).
        "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
        "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
          "A String",
        ],
        "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
        "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
        "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
        "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
        "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
          "accountId": "A String", # Adx account id of the buyer.
        },
        "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
        "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
        "proposalState": "A String", # The current state of the proposal. (readonly)
        "name": "A String", # The name for the proposal (updatable)
        "buyerPrivateData": { # Private data for buyer. (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
          "accountId": "A String", # Adx account id of the buyer.
        },
        "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
        "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
      },
    ],
  }


Returns:
  An object of the form:

    {
    "proposals": [ # The list of proposals successfully created.
      { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
          #
          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
        "labels": [ # List of labels associated with the proposal. (readonly)
          {
            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
                "accountId": "A String", # Adx account id of the buyer.
              },
              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
                "subAccountId": "A String", # Optional sub-account id for the seller.
                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
              },
            },
            "label": "A String", # The label to use.
            "accountId": "A String", # The accountId of the party that created the label.
          },
        ],
        "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
        "revisionNumber": "A String", # The revision number for the proposal (readonly).
        "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
        "seller": { # Reference to the seller on the proposal. (readonly, except on create)
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
        "proposalId": "A String", # The unique id of the proposal. (readonly).
        "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
        "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
          "A String",
        ],
        "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
        "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
        "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
        "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
        "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
          "accountId": "A String", # Adx account id of the buyer.
        },
        "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
        "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
        "proposalState": "A String", # The current state of the proposal. (readonly)
        "name": "A String", # The name for the proposal (updatable)
        "buyerPrivateData": { # Private data for buyer. (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
          "accountId": "A String", # Adx account id of the buyer.
        },
        "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
        "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
      },
    ],
  }
patch(proposalId, revisionNumber, updateAction, body) 
Update the given proposal. This method supports patch semantics.

Args:
  proposalId: string, The proposal id to update. (required)
  revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. (required)
  updateAction: string, The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. (required)
    Allowed values
      accept - 
      cancel - 
      propose - 
      proposeAndAccept - 
      unknownAction - 
      updateFinalized - 
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
    # 
    # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
  "labels": [ # List of labels associated with the proposal. (readonly)
    {
      "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
      "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
        "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
          "accountId": "A String", # Adx account id of the buyer.
        },
        "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
      },
      "label": "A String", # The label to use.
      "accountId": "A String", # The accountId of the party that created the label.
    },
  ],
  "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
    {
      "email": "A String", # Email address of the contact.
      "name": "A String", # The name of the contact.
    },
  ],
  "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
  "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
  "revisionNumber": "A String", # The revision number for the proposal (readonly).
  "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
  "seller": { # Reference to the seller on the proposal. (readonly, except on create)
    "subAccountId": "A String", # Optional sub-account id for the seller.
    "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
  },
  "proposalId": "A String", # The unique id of the proposal. (readonly).
  "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
  "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
    "A String",
  ],
  "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
  "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
  "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
  "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
  "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
    "accountId": "A String", # Adx account id of the buyer.
  },
  "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
  "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
  "proposalState": "A String", # The current state of the proposal. (readonly)
  "name": "A String", # The name for the proposal (updatable)
  "buyerPrivateData": { # Private data for buyer. (hidden from seller).
    "referenceId": "A String",
    "referencePayload": "A String",
  },
  "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
    "accountId": "A String", # Adx account id of the buyer.
  },
  "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
  "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
    {
      "email": "A String", # Email address of the contact.
      "name": "A String", # The name of the contact.
    },
  ],
}


Returns:
  An object of the form:

    { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
      #
      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
    "labels": [ # List of labels associated with the proposal. (readonly)
      {
        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
            "accountId": "A String", # Adx account id of the buyer.
          },
          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
            "subAccountId": "A String", # Optional sub-account id for the seller.
            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
          },
        },
        "label": "A String", # The label to use.
        "accountId": "A String", # The accountId of the party that created the label.
      },
    ],
    "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
    "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
    "revisionNumber": "A String", # The revision number for the proposal (readonly).
    "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
    "seller": { # Reference to the seller on the proposal. (readonly, except on create)
      "subAccountId": "A String", # Optional sub-account id for the seller.
      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
    },
    "proposalId": "A String", # The unique id of the proposal. (readonly).
    "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
    "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
      "A String",
    ],
    "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
    "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
    "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
    "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
    "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
      "accountId": "A String", # Adx account id of the buyer.
    },
    "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
    "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
    "proposalState": "A String", # The current state of the proposal. (readonly)
    "name": "A String", # The name for the proposal (updatable)
    "buyerPrivateData": { # Private data for buyer. (hidden from seller).
      "referenceId": "A String",
      "referencePayload": "A String",
    },
    "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
      "accountId": "A String", # Adx account id of the buyer.
    },
    "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
    "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
  }
search(pqlQuery=None) 
Search for proposals using pql query

Args:
  pqlQuery: string, Query string to retrieve specific proposals.

Returns:
  An object of the form:

    {
    "proposals": [ # The list of matching proposals.
      { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
          #
          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
        "labels": [ # List of labels associated with the proposal. (readonly)
          {
            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
                "accountId": "A String", # Adx account id of the buyer.
              },
              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
                "subAccountId": "A String", # Optional sub-account id for the seller.
                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
              },
            },
            "label": "A String", # The label to use.
            "accountId": "A String", # The accountId of the party that created the label.
          },
        ],
        "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
        "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
        "revisionNumber": "A String", # The revision number for the proposal (readonly).
        "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
        "seller": { # Reference to the seller on the proposal. (readonly, except on create)
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
        "proposalId": "A String", # The unique id of the proposal. (readonly).
        "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
        "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
          "A String",
        ],
        "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
        "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
        "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
        "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
        "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
          "accountId": "A String", # Adx account id of the buyer.
        },
        "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
        "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
        "proposalState": "A String", # The current state of the proposal. (readonly)
        "name": "A String", # The name for the proposal (updatable)
        "buyerPrivateData": { # Private data for buyer. (hidden from seller).
          "referenceId": "A String",
          "referencePayload": "A String",
        },
        "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
          "accountId": "A String", # Adx account id of the buyer.
        },
        "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
        "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
          {
            "email": "A String", # Email address of the contact.
            "name": "A String", # The name of the contact.
          },
        ],
      },
    ],
  }
setupcomplete(proposalId) 
Update the given proposal to indicate that setup has been completed.

Args:
  proposalId: string, The proposal id for which the setup is complete (required)
update(proposalId, revisionNumber, updateAction, body) 
Update the given proposal

Args:
  proposalId: string, The proposal id to update. (required)
  revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. (required)
  updateAction: string, The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. (required)
    Allowed values
      accept - 
      cancel - 
      propose - 
      proposeAndAccept - 
      unknownAction - 
      updateFinalized - 
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
    # 
    # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
  "labels": [ # List of labels associated with the proposal. (readonly)
    {
      "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
      "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
        "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
          "accountId": "A String", # Adx account id of the buyer.
        },
        "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
      },
      "label": "A String", # The label to use.
      "accountId": "A String", # The accountId of the party that created the label.
    },
  ],
  "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
    {
      "email": "A String", # Email address of the contact.
      "name": "A String", # The name of the contact.
    },
  ],
  "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
  "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
  "revisionNumber": "A String", # The revision number for the proposal (readonly).
  "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
  "seller": { # Reference to the seller on the proposal. (readonly, except on create)
    "subAccountId": "A String", # Optional sub-account id for the seller.
    "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
  },
  "proposalId": "A String", # The unique id of the proposal. (readonly).
  "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
  "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
    "A String",
  ],
  "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
  "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
  "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
  "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
  "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
    "accountId": "A String", # Adx account id of the buyer.
  },
  "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
  "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
  "proposalState": "A String", # The current state of the proposal. (readonly)
  "name": "A String", # The name for the proposal (updatable)
  "buyerPrivateData": { # Private data for buyer. (hidden from seller).
    "referenceId": "A String",
    "referencePayload": "A String",
  },
  "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
    "accountId": "A String", # Adx account id of the buyer.
  },
  "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
  "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
    {
      "email": "A String", # Email address of the contact.
      "name": "A String", # The name of the contact.
    },
  ],
}


Returns:
  An object of the form:

    { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
      #
      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
    "labels": [ # List of labels associated with the proposal. (readonly)
      {
        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
            "accountId": "A String", # Adx account id of the buyer.
          },
          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
            "subAccountId": "A String", # Optional sub-account id for the seller.
            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
          },
        },
        "label": "A String", # The label to use.
        "accountId": "A String", # The accountId of the party that created the label.
      },
    ],
    "sellerContacts": [ # Optional contact information of the seller (buyer-readonly).
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
    "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
    "revisionNumber": "A String", # The revision number for the proposal (readonly).
    "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
    "seller": { # Reference to the seller on the proposal. (readonly, except on create)
      "subAccountId": "A String", # Optional sub-account id for the seller.
      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
    },
    "proposalId": "A String", # The unique id of the proposal. (readonly).
    "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
    "dbmAdvertiserIds": [ # IDs of DBM advertisers permission to this proposal.
      "A String",
    ],
    "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
    "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
    "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
    "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
    "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
      "accountId": "A String", # Adx account id of the buyer.
    },
    "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
    "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
    "proposalState": "A String", # The current state of the proposal. (readonly)
    "name": "A String", # The name for the proposal (updatable)
    "buyerPrivateData": { # Private data for buyer. (hidden from seller).
      "referenceId": "A String",
      "referencePayload": "A String",
    },
    "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
      "accountId": "A String", # Adx account id of the buyer.
    },
    "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
    "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly)
      {
        "email": "A String", # Email address of the contact.
        "name": "A String", # The name of the contact.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html000066400000000000000000000120351300622755700273000ustar00rootroot00000000000000

Ad Exchange Buyer API . pubprofiles

Instance Methods

list(accountId)

Gets the requested publisher profile(s) by publisher accountId.

Method Details

list(accountId) 
Gets the requested publisher profile(s) by publisher accountId.

Args:
  accountId: integer, The accountId of the publisher to get profiles for. (required)

Returns:
  An object of the form:

    {
    "profiles": [ # Profiles for the requested publisher
      {
        "googlePlusLink": "A String", # Link to publisher's Google+ page.
        "mediaKitLink": "A String", # The url for additional marketing and sales materials.
        "publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher provided forecasting information.
          "weeklyImpressions": "A String", # Publisher provided weekly impressions.
          "dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc...
            { # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}
              "dimensionType": "A String",
              "dimensionValues": [
                { # Value of the dimension.
                  "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.
                  "id": 42, # Id of the dimension.
                  "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
                },
              ],
            },
          ],
          "weeklyUniques": "A String", # Publisher provided weekly uniques.
        },
        "overview": "A String", # Publisher provided overview.
        "buyerPitchStatement": "A String", # A pitch statement for the buyer
        "isParent": True or False, # True, if this is the parent profile, which represents all domains owned by the publisher.
        "topHeadlines": [ # Publisher provided key metrics and rankings.
          "A String",
        ],
        "publisherProfileId": "A String", # Unique Id for publisher profile.
        "accountId": "A String", # The account id of the seller.
        "programmaticContact": "A String", # Programmatic contact for the publisher profile.
        "rateCardInfoLink": "A String", # Link to publisher rate card
        "seller": { # Seller of the publisher profile.
          "subAccountId": "A String", # Optional sub-account id for the seller.
          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
        },
        "directContact": "A String", # Direct contact for the publisher profile.
        "samplePageLink": "A String", # Link for a sample content page.
        "state": "A String", # State of the publisher profile.
        "exchange": "A String", # Exchange where this publisher profile is from. E.g. AdX, Rubicon etc...
        "kind": "adexchangebuyer#publisherProfileApiProto", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#publisherProfileApiProto".
        "name": "A String",
        "publisherDomains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile.
          "A String",
        ],
        "isPublished": True or False, # True, if this profile is published. Deprecated for state.
        "audience": "A String", # Publisher provided info on its audience.
        "logoUrl": "A String", # The url to the logo for the publisher.
        "profileId": 42, # The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.adclients.html000066400000000000000000000065041300622755700266350ustar00rootroot00000000000000

Ad Exchange Seller API . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.adunits.customchannels.html000066400000000000000000000105461300622755700313640ustar00rootroot00000000000000

Ad Exchange Seller API . adunits . customchannels

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.adunits.html000066400000000000000000000127461300622755700263430ustar00rootroot00000000000000

Ad Exchange Seller API . adunits

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.customchannels.adunits.html000066400000000000000000000101751300622755700313620ustar00rootroot00000000000000

Ad Exchange Seller API . customchannels . adunits

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.customchannels.html000066400000000000000000000141371300622755700277160ustar00rootroot00000000000000

Ad Exchange Seller API . customchannels

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.html000066400000000000000000000053771300622755700246770ustar00rootroot00000000000000

Ad Exchange Seller API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.reports.html000066400000000000000000000144321300622755700263640ustar00rootroot00000000000000

Ad Exchange Seller API . reports

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.reports.saved.html000066400000000000000000000130751300622755700274670ustar00rootroot00000000000000

Ad Exchange Seller API . reports . saved

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1.urlchannels.html000066400000000000000000000067061300622755700272110ustar00rootroot00000000000000

Ad Exchange Seller API . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.accounts.html000066400000000000000000000034251300622755700267250ustar00rootroot00000000000000

Ad Exchange Seller API . accounts

Instance Methods

get(accountId)

Get information about the selected Ad Exchange account.

Method Details

get(accountId) 
Get information about the selected Ad Exchange account.

Args:
  accountId: string, Account to get information about. Tip: 'myaccount' is a valid ID. (required)

Returns:
  An object of the form:

    {
    "kind": "adexchangeseller#account", # Kind of resource this is, in this case adexchangeseller#account.
    "id": "A String", # Unique identifier of this account.
    "name": "A String", # Name of this account.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.adclients.html000066400000000000000000000065101300622755700270520ustar00rootroot00000000000000

Ad Exchange Seller API . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.adunits.customchannels.html000066400000000000000000000105541300622755700316030ustar00rootroot00000000000000

Ad Exchange Seller API . adunits . customchannels

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.adunits.html000066400000000000000000000127541300622755700265620ustar00rootroot00000000000000

Ad Exchange Seller API . adunits

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.alerts.html000066400000000000000000000047351300622755700264050ustar00rootroot00000000000000

Ad Exchange Seller API . alerts

Instance Methods

list(locale=None)

List the alerts for this Ad Exchange account.

Method Details

list(locale=None) 
List the alerts for this Ad Exchange 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": "adexchangeseller#alert", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#alerts", # Kind of list this is, in this case adexchangeseller#alerts.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.customchannels.adunits.html000066400000000000000000000102031300622755700315720ustar00rootroot00000000000000

Ad Exchange Seller API . customchannels . adunits

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.customchannels.html000066400000000000000000000141451300622755700301350ustar00rootroot00000000000000

Ad Exchange Seller API . customchannels

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.html000066400000000000000000000066371300622755700251170ustar00rootroot00000000000000

Ad Exchange Seller API

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.

preferreddeals()

Returns the preferreddeals Resource.

reports()

Returns the reports Resource.

urlchannels()

Returns the urlchannels Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.metadata.dimensions.html000066400000000000000000000063231300622755700310350ustar00rootroot00000000000000

Ad Exchange Seller API . metadata . dimensions

Instance Methods

list()

List the metadata for the dimensions available to this AdExchange account.

Method Details

list() 
List the metadata for the dimensions available to this AdExchange 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": "adexchangeseller#reportingMetadataEntry", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#metadata", # Kind of list this is, in this case adexchangeseller#metadata.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.metadata.html000066400000000000000000000026601300622755700266660ustar00rootroot00000000000000

Ad Exchange Seller API . metadata

Instance Methods

dimensions()

Returns the dimensions Resource.

metrics()

Returns the metrics Resource.

google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.metadata.metrics.html000066400000000000000000000063071300622755700303350ustar00rootroot00000000000000

Ad Exchange Seller API . metadata . metrics

Instance Methods

list()

List the metadata for the metrics available to this AdExchange account.

Method Details

list() 
List the metadata for the metrics available to this AdExchange 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": "adexchangeseller#reportingMetadataEntry", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#metadata", # Kind of list this is, in this case adexchangeseller#metadata.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.preferreddeals.html000066400000000000000000000103731300622755700300750ustar00rootroot00000000000000

Ad Exchange Seller API . preferreddeals

Instance Methods

get(dealId)

Get information about the selected Ad Exchange Preferred Deal.

list()

List the preferred deals for this Ad Exchange account.

Method Details

get(dealId) 
Get information about the selected Ad Exchange Preferred Deal.

Args:
  dealId: string, Preferred deal to get information about. (required)

Returns:
  An object of the form:

    {
    "kind": "adexchangeseller#preferredDeal", # Kind of resource this is, in this case adexchangeseller#preferredDeal.
    "buyerNetworkName": "A String", # The name of the buyer network this deal is for.
    "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
    "advertiserName": "A String", # The name of the advertiser this deal is for.
    "fixedCpm": "A String", # The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
    "startTime": "A String", # Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.
    "endTime": "A String", # Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.
    "id": "A String", # Unique identifier of this preferred deal.
  }
list() 
List the preferred deals for this Ad Exchange account.

Args:

Returns:
  An object of the form:

    {
    "items": [ # The preferred deals returned in this list response.
      {
        "kind": "adexchangeseller#preferredDeal", # Kind of resource this is, in this case adexchangeseller#preferredDeal.
        "buyerNetworkName": "A String", # The name of the buyer network this deal is for.
        "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
        "advertiserName": "A String", # The name of the advertiser this deal is for.
        "fixedCpm": "A String", # The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
        "startTime": "A String", # Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.
        "endTime": "A String", # Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.
        "id": "A String", # Unique identifier of this preferred deal.
      },
    ],
    "kind": "adexchangeseller#preferredDeals", # Kind of list this is, in this case adexchangeseller#preferredDeals.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.reports.html000066400000000000000000000144401300622755700266030ustar00rootroot00000000000000

Ad Exchange Seller API . reports

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.reports.saved.html000066400000000000000000000131031300622755700276770ustar00rootroot00000000000000

Ad Exchange Seller API . reports . saved

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v1_1.urlchannels.html000066400000000000000000000067121300622755700274260ustar00rootroot00000000000000

Ad Exchange Seller API . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.adclients.html000066400000000000000000000067541300622755700307020ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . adclients

Instance Methods

list(accountId, 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(accountId, pageToken=None, maxResults=None) 
List all ad clients in this Ad Exchange account.

Args:
  accountId: string, Account to which the ad client belongs. (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": "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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.alerts.html000066400000000000000000000051641300622755700302200ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . alerts

Instance Methods

list(accountId, locale=None)

List the alerts for this Ad Exchange account.

Method Details

list(accountId, locale=None) 
List the alerts for this Ad Exchange account.

Args:
  accountId: string, Account owning 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": "adexchangeseller#alert", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#alerts", # Kind of list this is, in this case adexchangeseller#alerts.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.customchannels.html000066400000000000000000000142711300622755700317530ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . customchannels

Instance Methods

get(accountId, adClientId, customChannelId)

Get the specified custom channel from the specified ad client.

list(accountId, 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(accountId, adClientId, customChannelId) 
Get the specified custom channel from the specified ad client.

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": "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(accountId, adClientId, pageToken=None, maxResults=None) 
List all custom channels in the specified ad client for this Ad Exchange 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": "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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.html000066400000000000000000000117111300622755700267220ustar00rootroot00000000000000

Ad Exchange Seller API . accounts

Instance Methods

adclients()

Returns the adclients Resource.

alerts()

Returns the alerts Resource.

customchannels()

Returns the customchannels Resource.

metadata()

Returns the metadata Resource.

preferreddeals()

Returns the preferreddeals Resource.

reports()

Returns the reports Resource.

urlchannels()

Returns the urlchannels Resource.

get(accountId)

Get information about the selected Ad Exchange account.

list(pageToken=None, maxResults=None)

List all accounts available to this Ad Exchange account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId) 
Get information about the selected Ad Exchange account.

Args:
  accountId: string, Account to get information about. Tip: 'myaccount' is a valid ID. (required)

Returns:
  An object of the form:

    {
    "kind": "adexchangeseller#account", # Kind of resource this is, in this case adexchangeseller#account.
    "id": "A String", # Unique identifier of this account.
    "name": "A String", # Name of this account.
  }
list(pageToken=None, maxResults=None) 
List all accounts available to this Ad Exchange 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": "adexchangeseller#account", # Kind of resource this is, in this case adexchangeseller#account.
        "id": "A String", # Unique identifier of this account.
        "name": "A String", # Name of this account.
      },
    ],
    "kind": "adexchangeseller#accounts", # Kind of list this is, in this case adexchangeseller#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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.metadata.dimensions.html000066400000000000000000000065771300622755700326660ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . metadata . dimensions

Instance Methods

list(accountId)

List the metadata for the dimensions available to this AdExchange account.

Method Details

list(accountId) 
List the metadata for the dimensions available to this AdExchange account.

Args:
  accountId: string, Account with visibility to the dimensions. (required)

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": "adexchangeseller#reportingMetadataEntry", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#metadata", # Kind of list this is, in this case adexchangeseller#metadata.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.metadata.html000066400000000000000000000030101300622755700304720ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . metadata

Instance Methods

dimensions()

Returns the dimensions Resource.

metrics()

Returns the metrics Resource.

google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.metadata.metrics.html000066400000000000000000000065601300622755700321540ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . metadata . metrics

Instance Methods

list(accountId)

List the metadata for the metrics available to this AdExchange account.

Method Details

list(accountId) 
List the metadata for the metrics available to this AdExchange account.

Args:
  accountId: string, Account with visibility to the metrics. (required)

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": "adexchangeseller#reportingMetadataEntry", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#metadata", # Kind of list this is, in this case adexchangeseller#metadata.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.preferreddeals.html000066400000000000000000000107341300622755700317140ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . preferreddeals

Instance Methods

get(accountId, dealId)

Get information about the selected Ad Exchange Preferred Deal.

list(accountId)

List the preferred deals for this Ad Exchange account.

Method Details

get(accountId, dealId) 
Get information about the selected Ad Exchange Preferred Deal.

Args:
  accountId: string, Account owning the deal. (required)
  dealId: string, Preferred deal to get information about. (required)

Returns:
  An object of the form:

    {
    "kind": "adexchangeseller#preferredDeal", # Kind of resource this is, in this case adexchangeseller#preferredDeal.
    "buyerNetworkName": "A String", # The name of the buyer network this deal is for.
    "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
    "advertiserName": "A String", # The name of the advertiser this deal is for.
    "fixedCpm": "A String", # The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
    "startTime": "A String", # Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.
    "endTime": "A String", # Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.
    "id": "A String", # Unique identifier of this preferred deal.
  }
list(accountId) 
List the preferred deals for this Ad Exchange account.

Args:
  accountId: string, Account owning the deals. (required)

Returns:
  An object of the form:

    {
    "items": [ # The preferred deals returned in this list response.
      {
        "kind": "adexchangeseller#preferredDeal", # Kind of resource this is, in this case adexchangeseller#preferredDeal.
        "buyerNetworkName": "A String", # The name of the buyer network this deal is for.
        "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
        "advertiserName": "A String", # The name of the advertiser this deal is for.
        "fixedCpm": "A String", # The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
        "startTime": "A String", # Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.
        "endTime": "A String", # Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.
        "id": "A String", # Unique identifier of this preferred deal.
      },
    ],
    "kind": "adexchangeseller#preferredDeals", # Kind of list this is, in this case adexchangeseller#preferredDeals.
  }
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.reports.html000066400000000000000000000150551300622755700304240ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . reports

Instance Methods

saved()

Returns the saved Resource.

generate(accountId, 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(accountId, 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(accountId, 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:
  accountId: string, Account which owns the generated 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": "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(accountId, 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:
  accountId: string, Account which owns the generated 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:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.reports.saved.html000066400000000000000000000135011300622755700315170ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . reports . saved

Instance Methods

generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)

Generate an Ad Exchange report based on the saved report ID sent in the query parameters.

list(accountId, 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(accountId, savedReportId, locale=None, maxResults=None, startIndex=None) 
Generate an Ad Exchange report based on the saved report ID sent in the query parameters.

Args:
  accountId: string, Account owning the saved report. (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": "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(accountId, pageToken=None, maxResults=None) 
List all saved reports in this Ad Exchange account.

Args:
  accountId: string, Account owning the saved reports. (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": "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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.accounts.urlchannels.html000066400000000000000000000071561300622755700312470ustar00rootroot00000000000000

Ad Exchange Seller API . accounts . urlchannels

Instance Methods

list(accountId, 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(accountId, adClientId, pageToken=None, maxResults=None) 
List all URL channels in the specified ad client for this Ad Exchange 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": "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.
google-api-python-client-1.5.5/docs/dyn/adexchangeseller_v2_0.html000066400000000000000000000041531300622755700251060ustar00rootroot00000000000000

Ad Exchange Seller API

Instance Methods

accounts()

Returns the accounts Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/admin_datatransfer_v1.applications.html000066400000000000000000000116661300622755700277120ustar00rootroot00000000000000

Admin Data Transfer API . applications

Instance Methods

get(applicationId)

Retrieves information about an application for the given application ID.

list(pageToken=None, maxResults=None, customerId=None)

Lists the applications available for data transfer for a customer.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(applicationId) 
Retrieves information about an application for the given application ID.

Args:
  applicationId: string, ID of the application resource to be retrieved. (required)

Returns:
  An object of the form:

    { # The JSON template for an Application resource.
    "kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
    "etag": "A String", # Etag of the resource.
    "transferParams": [ # The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
      { # Template for application transfer parameters.
        "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
          "A String",
        ],
        "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
      },
    ],
    "id": "A String", # The application's ID.
    "name": "A String", # The application's name.
  }
list(pageToken=None, maxResults=None, customerId=None) 
Lists the applications available for data transfer for a customer.

Args:
  pageToken: string, Token to specify next page in the list.
  maxResults: integer, Maximum number of results to return. Default is 100.
  customerId: string, Immutable ID of the Google Apps account.

Returns:
  An object of the form:

    { # Template for a collection of Applications.
    "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
    "applications": [ # List of applications that support data transfer and are also installed for the customer.
      { # The JSON template for an Application resource.
        "kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
        "etag": "A String", # Etag of the resource.
        "transferParams": [ # The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
          { # Template for application transfer parameters.
            "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
              "A String",
            ],
            "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
          },
        ],
        "id": "A String", # The application's ID.
        "name": "A String", # The application's name.
      },
    ],
    "kind": "admin#datatransfer#applicationsList", # Identifies the resource as a collection of Applications.
    "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.
google-api-python-client-1.5.5/docs/dyn/admin_datatransfer_v1.html000066400000000000000000000044351300622755700252210ustar00rootroot00000000000000

Admin Data Transfer API

Instance Methods

applications()

Returns the applications Resource.

transfers()

Returns the transfers Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/admin_datatransfer_v1.transfers.html000066400000000000000000000255031300622755700272260ustar00rootroot00000000000000

Admin Data Transfer API . transfers

Instance Methods

get(dataTransferId)

Retrieves a data transfer request by its resource ID.

insert(body)

Inserts a data transfer request.

list(status=None, oldOwnerUserId=None, pageToken=None, maxResults=None, newOwnerUserId=None, customerId=None)

Lists the transfers for a customer by source user, destination user, or status.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(dataTransferId) 
Retrieves a data transfer request by its resource ID.

Args:
  dataTransferId: string, ID of the resource to be retrieved. This is returned in the response from the insert method. (required)

Returns:
  An object of the form:

    { # The JSON template for a DataTransfer resource.
      "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
      "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
      "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
        { # Template to map fields of ApplicationDataTransfer resource.
          "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
            { # Template for application transfer parameters.
              "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
                "A String",
              ],
              "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
            },
          ],
          "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
          "applicationId": "A String", # The application's ID.
        },
      ],
      "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
      "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
      "etag": "A String", # ETag of the resource.
      "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
      "id": "A String", # The transfer's ID (Read-only).
    }
insert(body) 
Inserts a data transfer request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The JSON template for a DataTransfer resource.
    "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
    "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
    "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
      { # Template to map fields of ApplicationDataTransfer resource.
        "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
          { # Template for application transfer parameters.
            "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
              "A String",
            ],
            "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
          },
        ],
        "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
        "applicationId": "A String", # The application's ID.
      },
    ],
    "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
    "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
    "etag": "A String", # ETag of the resource.
    "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
    "id": "A String", # The transfer's ID (Read-only).
  }


Returns:
  An object of the form:

    { # The JSON template for a DataTransfer resource.
      "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
      "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
      "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
        { # Template to map fields of ApplicationDataTransfer resource.
          "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
            { # Template for application transfer parameters.
              "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
                "A String",
              ],
              "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
            },
          ],
          "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
          "applicationId": "A String", # The application's ID.
        },
      ],
      "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
      "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
      "etag": "A String", # ETag of the resource.
      "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
      "id": "A String", # The transfer's ID (Read-only).
    }
list(status=None, oldOwnerUserId=None, pageToken=None, maxResults=None, newOwnerUserId=None, customerId=None) 
Lists the transfers for a customer by source user, destination user, or status.

Args:
  status: string, Status of the transfer.
  oldOwnerUserId: string, Source user's profile ID.
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return. Default is 100.
  newOwnerUserId: string, Destination user's profile ID.
  customerId: string, Immutable ID of the Google Apps account.

Returns:
  An object of the form:

    { # Template for a collection of DataTransfer resources.
    "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
    "kind": "admin#datatransfer#dataTransfersList", # Identifies the resource as a collection of data transfer requests.
    "etag": "A String", # ETag of the resource.
    "dataTransfers": [ # List of data transfer requests.
      { # The JSON template for a DataTransfer resource.
          "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
          "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
          "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
            { # Template to map fields of ApplicationDataTransfer resource.
              "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
                { # Template for application transfer parameters.
                  "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
                    "A String",
                  ],
                  "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
                },
              ],
              "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
              "applicationId": "A String", # The application's ID.
            },
          ],
          "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
          "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
          "etag": "A String", # ETag of the resource.
          "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
          "id": "A String", # The transfer's ID (Read-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.
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.asps.html000066400000000000000000000102731300622755700255110ustar00rootroot00000000000000

Admin Directory API . asps

Instance Methods

delete(userKey, codeId)

Delete an ASP issued by a user.

get(userKey, codeId)

Get information about an ASP issued by a user.

list(userKey)

List the ASPs issued by a user.

Method Details

delete(userKey, codeId) 
Delete an ASP issued by a user.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
  codeId: integer, The unique ID of the ASP to be deleted. (required)
get(userKey, codeId) 
Get information about an ASP issued by a user.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
  codeId: integer, The unique ID of the ASP. (required)

Returns:
  An object of the form:

    { # The template that returns individual ASP (Access Code) data.
    "kind": "admin#directory#asp", # The type of the API resource. This is always admin#directory#asp.
    "name": "A String", # The name of the application that the user, represented by their userId, entered when the ASP was created.
    "lastTimeUsed": "A String", # The time when the ASP was last used. Expressed in Unix time format.
    "creationTime": "A String", # The time when the ASP was created. Expressed in Unix time format.
    "etag": "A String", # ETag of the ASP.
    "codeId": 42, # The unique ID of the ASP.
    "userKey": "A String", # The unique ID of the user who issued the ASP.
  }
list(userKey) 
List the ASPs issued by a user.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)

Returns:
  An object of the form:

    {
    "items": [ # A list of ASP resources.
      { # The template that returns individual ASP (Access Code) data.
        "kind": "admin#directory#asp", # The type of the API resource. This is always admin#directory#asp.
        "name": "A String", # The name of the application that the user, represented by their userId, entered when the ASP was created.
        "lastTimeUsed": "A String", # The time when the ASP was last used. Expressed in Unix time format.
        "creationTime": "A String", # The time when the ASP was created. Expressed in Unix time format.
        "etag": "A String", # ETag of the ASP.
        "codeId": 42, # The unique ID of the ASP.
        "userKey": "A String", # The unique ID of the user who issued the ASP.
      },
    ],
    "kind": "admin#directory#aspList", # The type of the API resource. This is always admin#directory#aspList.
    "etag": "A String", # ETag of the resource.
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.channels.html000066400000000000000000000052731300622755700263420ustar00rootroot00000000000000

Admin Directory API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.chromeosdevices.html000066400000000000000000000530141300622755700277250ustar00rootroot00000000000000

Admin Directory API . chromeosdevices

Instance Methods

action(customerId, resourceId, body)

Take action on Chrome OS Device

get(customerId, deviceId, projection=None)

Retrieve Chrome OS Device

list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)

Retrieve all Chrome OS Devices of a customer (paginated)

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(customerId, deviceId, body, projection=None)

Update Chrome OS Device. This method supports patch semantics.

update(customerId, deviceId, body, projection=None)

Update Chrome OS Device

Method Details

action(customerId, resourceId, body) 
Take action on Chrome OS Device

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  resourceId: string, Immutable id of Chrome OS Device (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON request template for firing actions on ChromeOs Device in Directory Devices API.
    "action": "A String", # Action to be taken on the ChromeOs Device
    "deprovisionReason": "A String",
  }
get(customerId, deviceId, projection=None) 
Retrieve Chrome OS Device

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  deviceId: string, Immutable id of Chrome OS Device (required)
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
      FULL - Includes all metadata fields

Returns:
  An object of the form:

    { # JSON template for Chrome Os Device resource in Directory API.
      "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
      "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
      "orderNumber": "A String", # Chromebook order number (Read-only)
      "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
      "activeTimeRanges": [ # List of active time ranges (Read-only)
        {
          "date": "A String", # Date of usage
          "activeTime": 42, # Duration in milliseconds
        },
      ],
      "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
      "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
      "bootMode": "A String", # Chromebook boot mode (Read-only)
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # OrgUnit of the device
      "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
        {
          "type": "A String", # The type of the user
          "email": "A String", # Email address of the user. Present only if the user type is managed
        },
      ],
      "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
      "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
      "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
      "annotatedUser": "A String", # User of the device
      "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
      "platformVersion": "A String", # Chromebook platform version (Read-only)
      "osVersion": "A String", # Chromebook Os Version (Read-only)
      "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
      "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
      "notes": "A String", # Notes added by the administrator
      "serialNumber": "A String", # Chromebook serial number (Read-only)
      "status": "A String", # status of the device (Read-only)
      "supportEndDate": "A String", # Final date the device will be supported (Read-only)
      "model": "A String", # Chromebook Model (Read-only)
    }
list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None) 
Retrieve all Chrome OS Devices of a customer (paginated)

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  orderBy: string, Column to use for sorting results
    Allowed values
      annotatedLocation - Chromebook location as annotated by the administrator.
      annotatedUser - Chromebook user as annotated by administrator.
      lastSync - Chromebook last sync.
      notes - Chromebook notes as annotated by the administrator.
      serialNumber - Chromebook Serial Number.
      status - Chromebook status.
      supportEndDate - Chromebook support end date.
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
      FULL - Includes all metadata fields
  pageToken: string, Token to specify next page in the list
  maxResults: integer, Maximum number of results to return. Default is 100
  sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  query: string, Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333

Returns:
  An object of the form:

    { # JSON response template for List Chrome OS Devices operation in Directory API.
    "nextPageToken": "A String", # Token used to access next page of this result.
    "chromeosdevices": [ # List of Chrome OS Device objects.
      { # JSON template for Chrome Os Device resource in Directory API.
          "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
          "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
          "orderNumber": "A String", # Chromebook order number (Read-only)
          "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
          "activeTimeRanges": [ # List of active time ranges (Read-only)
            {
              "date": "A String", # Date of usage
              "activeTime": 42, # Duration in milliseconds
            },
          ],
          "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
          "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
          "bootMode": "A String", # Chromebook boot mode (Read-only)
          "etag": "A String", # ETag of the resource.
          "orgUnitPath": "A String", # OrgUnit of the device
          "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
            {
              "type": "A String", # The type of the user
              "email": "A String", # Email address of the user. Present only if the user type is managed
            },
          ],
          "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
          "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
          "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
          "annotatedUser": "A String", # User of the device
          "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
          "platformVersion": "A String", # Chromebook platform version (Read-only)
          "osVersion": "A String", # Chromebook Os Version (Read-only)
          "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
          "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
          "notes": "A String", # Notes added by the administrator
          "serialNumber": "A String", # Chromebook serial number (Read-only)
          "status": "A String", # status of the device (Read-only)
          "supportEndDate": "A String", # Final date the device will be supported (Read-only)
          "model": "A String", # Chromebook Model (Read-only)
        },
    ],
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#chromeosdevices", # Kind of resource 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.
patch(customerId, deviceId, body, projection=None) 
Update Chrome OS Device. This method supports patch semantics.

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  deviceId: string, Immutable id of Chrome OS Device (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Chrome Os Device resource in Directory API.
    "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
    "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
    "orderNumber": "A String", # Chromebook order number (Read-only)
    "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
    "activeTimeRanges": [ # List of active time ranges (Read-only)
      {
        "date": "A String", # Date of usage
        "activeTime": 42, # Duration in milliseconds
      },
    ],
    "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
    "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
    "bootMode": "A String", # Chromebook boot mode (Read-only)
    "etag": "A String", # ETag of the resource.
    "orgUnitPath": "A String", # OrgUnit of the device
    "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
      {
        "type": "A String", # The type of the user
        "email": "A String", # Email address of the user. Present only if the user type is managed
      },
    ],
    "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
    "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
    "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
    "annotatedUser": "A String", # User of the device
    "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
    "platformVersion": "A String", # Chromebook platform version (Read-only)
    "osVersion": "A String", # Chromebook Os Version (Read-only)
    "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
    "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
    "notes": "A String", # Notes added by the administrator
    "serialNumber": "A String", # Chromebook serial number (Read-only)
    "status": "A String", # status of the device (Read-only)
    "supportEndDate": "A String", # Final date the device will be supported (Read-only)
    "model": "A String", # Chromebook Model (Read-only)
  }

  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
      FULL - Includes all metadata fields

Returns:
  An object of the form:

    { # JSON template for Chrome Os Device resource in Directory API.
      "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
      "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
      "orderNumber": "A String", # Chromebook order number (Read-only)
      "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
      "activeTimeRanges": [ # List of active time ranges (Read-only)
        {
          "date": "A String", # Date of usage
          "activeTime": 42, # Duration in milliseconds
        },
      ],
      "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
      "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
      "bootMode": "A String", # Chromebook boot mode (Read-only)
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # OrgUnit of the device
      "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
        {
          "type": "A String", # The type of the user
          "email": "A String", # Email address of the user. Present only if the user type is managed
        },
      ],
      "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
      "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
      "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
      "annotatedUser": "A String", # User of the device
      "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
      "platformVersion": "A String", # Chromebook platform version (Read-only)
      "osVersion": "A String", # Chromebook Os Version (Read-only)
      "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
      "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
      "notes": "A String", # Notes added by the administrator
      "serialNumber": "A String", # Chromebook serial number (Read-only)
      "status": "A String", # status of the device (Read-only)
      "supportEndDate": "A String", # Final date the device will be supported (Read-only)
      "model": "A String", # Chromebook Model (Read-only)
    }
update(customerId, deviceId, body, projection=None) 
Update Chrome OS Device

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  deviceId: string, Immutable id of Chrome OS Device (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Chrome Os Device resource in Directory API.
    "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
    "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
    "orderNumber": "A String", # Chromebook order number (Read-only)
    "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
    "activeTimeRanges": [ # List of active time ranges (Read-only)
      {
        "date": "A String", # Date of usage
        "activeTime": 42, # Duration in milliseconds
      },
    ],
    "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
    "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
    "bootMode": "A String", # Chromebook boot mode (Read-only)
    "etag": "A String", # ETag of the resource.
    "orgUnitPath": "A String", # OrgUnit of the device
    "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
      {
        "type": "A String", # The type of the user
        "email": "A String", # Email address of the user. Present only if the user type is managed
      },
    ],
    "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
    "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
    "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
    "annotatedUser": "A String", # User of the device
    "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
    "platformVersion": "A String", # Chromebook platform version (Read-only)
    "osVersion": "A String", # Chromebook Os Version (Read-only)
    "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
    "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
    "notes": "A String", # Notes added by the administrator
    "serialNumber": "A String", # Chromebook serial number (Read-only)
    "status": "A String", # status of the device (Read-only)
    "supportEndDate": "A String", # Final date the device will be supported (Read-only)
    "model": "A String", # Chromebook Model (Read-only)
  }

  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
      FULL - Includes all metadata fields

Returns:
  An object of the form:

    { # JSON template for Chrome Os Device resource in Directory API.
      "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
      "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
      "orderNumber": "A String", # Chromebook order number (Read-only)
      "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
      "activeTimeRanges": [ # List of active time ranges (Read-only)
        {
          "date": "A String", # Date of usage
          "activeTime": 42, # Duration in milliseconds
        },
      ],
      "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
      "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
      "bootMode": "A String", # Chromebook boot mode (Read-only)
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # OrgUnit of the device
      "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
        {
          "type": "A String", # The type of the user
          "email": "A String", # Email address of the user. Present only if the user type is managed
        },
      ],
      "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
      "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
      "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
      "annotatedUser": "A String", # User of the device
      "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
      "platformVersion": "A String", # Chromebook platform version (Read-only)
      "osVersion": "A String", # Chromebook Os Version (Read-only)
      "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
      "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
      "notes": "A String", # Notes added by the administrator
      "serialNumber": "A String", # Chromebook serial number (Read-only)
      "status": "A String", # status of the device (Read-only)
      "supportEndDate": "A String", # Final date the device will be supported (Read-only)
      "model": "A String", # Chromebook Model (Read-only)
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.customers.html000066400000000000000000000301011300622755700265570ustar00rootroot00000000000000

Admin Directory API . customers

Instance Methods

get(customerKey)

Retrieves a customer.

patch(customerKey, body)

Updates a customer. This method supports patch semantics.

update(customerKey, body)

Updates a customer.

Method Details

get(customerKey) 
Retrieves a customer.

Args:
  customerKey: string, Id of the customer to be retrieved (required)

Returns:
  An object of the form:

    { # JSON template for Customer Resource object in Directory API.
      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
      "customerCreationTime": "A String", # The customer's creation time (Readonly)
      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
      "etag": "A String", # ETag of the resource.
      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
        "organizationName": "A String", # The company or company division name.
        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # The customer contact's name.
        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
        "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "id": "A String", # The unique ID for the customer's Google account. (Readonly)
    }
patch(customerKey, body) 
Updates a customer. This method supports patch semantics.

Args:
  customerKey: string, Id of the customer to be updated (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Customer Resource object in Directory API.
    "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
    "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
    "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
    "customerCreationTime": "A String", # The customer's creation time (Readonly)
    "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
    "etag": "A String", # ETag of the resource.
    "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
    "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
      "organizationName": "A String", # The company or company division name.
      "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
      "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
      "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # The customer contact's name.
      "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
      "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "id": "A String", # The unique ID for the customer's Google account. (Readonly)
  }


Returns:
  An object of the form:

    { # JSON template for Customer Resource object in Directory API.
      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
      "customerCreationTime": "A String", # The customer's creation time (Readonly)
      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
      "etag": "A String", # ETag of the resource.
      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
        "organizationName": "A String", # The company or company division name.
        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # The customer contact's name.
        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
        "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "id": "A String", # The unique ID for the customer's Google account. (Readonly)
    }
update(customerKey, body) 
Updates a customer.

Args:
  customerKey: string, Id of the customer to be updated (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Customer Resource object in Directory API.
    "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
    "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
    "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
    "customerCreationTime": "A String", # The customer's creation time (Readonly)
    "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
    "etag": "A String", # ETag of the resource.
    "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
    "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
      "organizationName": "A String", # The company or company division name.
      "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
      "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
      "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # The customer contact's name.
      "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
      "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "id": "A String", # The unique ID for the customer's Google account. (Readonly)
  }


Returns:
  An object of the form:

    { # JSON template for Customer Resource object in Directory API.
      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
      "customerCreationTime": "A String", # The customer's creation time (Readonly)
      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
      "etag": "A String", # ETag of the resource.
      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
        "organizationName": "A String", # The company or company division name.
        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # The customer contact's name.
        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
        "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "id": "A String", # The unique ID for the customer's Google account. (Readonly)
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.domainAliases.html000066400000000000000000000134421300622755700273150ustar00rootroot00000000000000

Admin Directory API . domainAliases

Instance Methods

delete(customer, domainAliasName)

Deletes a Domain Alias of the customer.

get(customer, domainAliasName)

Retrieves a domain alias of the customer.

insert(customer, body)

Inserts a Domain alias of the customer.

list(customer, parentDomainName=None)

Lists the domain aliases of the customer.

Method Details

delete(customer, domainAliasName) 
Deletes a Domain Alias of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  domainAliasName: string, Name of domain alias to be retrieved. (required)
get(customer, domainAliasName) 
Retrieves a domain alias of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  domainAliasName: string, Name of domain alias to be retrieved. (required)

Returns:
  An object of the form:

    { # JSON template for Domain Alias object in Directory API.
      "kind": "admin#directory#domainAlias", # Kind of resource this is.
      "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
      "creationTime": "A String", # The creation time of the domain alias. (Read-only).
      "etag": "A String", # ETag of the resource.
      "domainAliasName": "A String", # The domain alias name.
      "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    }
insert(customer, body) 
Inserts a Domain alias of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Domain Alias object in Directory API.
    "kind": "admin#directory#domainAlias", # Kind of resource this is.
    "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
    "creationTime": "A String", # The creation time of the domain alias. (Read-only).
    "etag": "A String", # ETag of the resource.
    "domainAliasName": "A String", # The domain alias name.
    "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
  }


Returns:
  An object of the form:

    { # JSON template for Domain Alias object in Directory API.
      "kind": "admin#directory#domainAlias", # Kind of resource this is.
      "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
      "creationTime": "A String", # The creation time of the domain alias. (Read-only).
      "etag": "A String", # ETag of the resource.
      "domainAliasName": "A String", # The domain alias name.
      "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    }
list(customer, parentDomainName=None) 
Lists the domain aliases of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  parentDomainName: string, Name of the parent domain for which domain aliases are to be fetched.

Returns:
  An object of the form:

    { # JSON response template to list domain aliases in Directory API.
    "domainAliases": [ # List of domain alias objects.
      { # JSON template for Domain Alias object in Directory API.
          "kind": "admin#directory#domainAlias", # Kind of resource this is.
          "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
          "creationTime": "A String", # The creation time of the domain alias. (Read-only).
          "etag": "A String", # ETag of the resource.
          "domainAliasName": "A String", # The domain alias name.
          "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
        },
    ],
    "kind": "admin#directory#domainAliases", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.domains.html000066400000000000000000000200351300622755700261720ustar00rootroot00000000000000

Admin Directory API . domains

Instance Methods

delete(customer, domainName)

Deletes a domain of the customer.

get(customer, domainName)

Retrieves a domain of the customer.

insert(customer, body)

Inserts a domain of the customer.

list(customer)

Lists the domains of the customer.

Method Details

delete(customer, domainName) 
Deletes a domain of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  domainName: string, Name of domain to be deleted (required)
get(customer, domainName) 
Retrieves a domain of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  domainName: string, Name of domain to be retrieved (required)

Returns:
  An object of the form:

    { # JSON template for Domain object in Directory API.
      "kind": "admin#directory#domain", # Kind of resource this is.
      "verified": True or False, # Indicates the verification state of a domain. (Read-only).
      "domainName": "A String", # The domain name of the customer.
      "creationTime": "A String", # Creation time of the domain. (Read-only).
      "etag": "A String", # ETag of the resource.
      "domainAliases": [ # List of domain alias objects. (Read-only)
        { # JSON template for Domain Alias object in Directory API.
            "kind": "admin#directory#domainAlias", # Kind of resource this is.
            "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
            "creationTime": "A String", # The creation time of the domain alias. (Read-only).
            "etag": "A String", # ETag of the resource.
            "domainAliasName": "A String", # The domain alias name.
            "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
          },
      ],
      "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
    }
insert(customer, body) 
Inserts a domain of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Domain object in Directory API.
    "kind": "admin#directory#domain", # Kind of resource this is.
    "verified": True or False, # Indicates the verification state of a domain. (Read-only).
    "domainName": "A String", # The domain name of the customer.
    "creationTime": "A String", # Creation time of the domain. (Read-only).
    "etag": "A String", # ETag of the resource.
    "domainAliases": [ # List of domain alias objects. (Read-only)
      { # JSON template for Domain Alias object in Directory API.
          "kind": "admin#directory#domainAlias", # Kind of resource this is.
          "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
          "creationTime": "A String", # The creation time of the domain alias. (Read-only).
          "etag": "A String", # ETag of the resource.
          "domainAliasName": "A String", # The domain alias name.
          "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
        },
    ],
    "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
  }


Returns:
  An object of the form:

    { # JSON template for Domain object in Directory API.
      "kind": "admin#directory#domain", # Kind of resource this is.
      "verified": True or False, # Indicates the verification state of a domain. (Read-only).
      "domainName": "A String", # The domain name of the customer.
      "creationTime": "A String", # Creation time of the domain. (Read-only).
      "etag": "A String", # ETag of the resource.
      "domainAliases": [ # List of domain alias objects. (Read-only)
        { # JSON template for Domain Alias object in Directory API.
            "kind": "admin#directory#domainAlias", # Kind of resource this is.
            "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
            "creationTime": "A String", # The creation time of the domain alias. (Read-only).
            "etag": "A String", # ETag of the resource.
            "domainAliasName": "A String", # The domain alias name.
            "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
          },
      ],
      "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
    }
list(customer) 
Lists the domains of the customer.

Args:
  customer: string, Immutable id of the Google Apps account. (required)

Returns:
  An object of the form:

    { # JSON response template to list Domains in Directory API.
    "domains": [ # List of domain objects.
      { # JSON template for Domain object in Directory API.
          "kind": "admin#directory#domain", # Kind of resource this is.
          "verified": True or False, # Indicates the verification state of a domain. (Read-only).
          "domainName": "A String", # The domain name of the customer.
          "creationTime": "A String", # Creation time of the domain. (Read-only).
          "etag": "A String", # ETag of the resource.
          "domainAliases": [ # List of domain alias objects. (Read-only)
            { # JSON template for Domain Alias object in Directory API.
                "kind": "admin#directory#domainAlias", # Kind of resource this is.
                "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
                "creationTime": "A String", # The creation time of the domain alias. (Read-only).
                "etag": "A String", # ETag of the resource.
                "domainAliasName": "A String", # The domain alias name.
                "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
              },
          ],
          "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
        },
    ],
    "kind": "admin#directory#domains", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.groups.aliases.html000066400000000000000000000066521300622755700275100ustar00rootroot00000000000000

Admin Directory API . groups . aliases

Instance Methods

delete(groupKey, alias)

Remove a alias for the group

insert(groupKey, body)

Add a alias for the group

list(groupKey)

List all aliases for a group

Method Details

delete(groupKey, alias) 
Remove a alias for the group

Args:
  groupKey: string, Email or immutable Id of the group (required)
  alias: string, The alias to be removed (required)
insert(groupKey, body) 
Add a alias for the group

Args:
  groupKey: string, Email or immutable Id of the group (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Alias object in Directory API.
    "alias": "A String", # A alias email
    "kind": "admin#directory#alias", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
    "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Alias object in Directory API.
      "alias": "A String", # A alias email
      "kind": "admin#directory#alias", # Kind of resource this is.
      "etag": "A String", # ETag of the resource.
      "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
      "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
    }
list(groupKey) 
List all aliases for a group

Args:
  groupKey: string, Email or immutable Id of the group (required)

Returns:
  An object of the form:

    { # JSON response template to list aliases in Directory API.
    "kind": "admin#directory#aliases", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "aliases": [ # List of alias objects.
      "",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.groups.html000066400000000000000000000256041300622755700260660ustar00rootroot00000000000000

Admin Directory API . groups

Instance Methods

aliases()

Returns the aliases Resource.

delete(groupKey)

Delete Group

get(groupKey)

Retrieve Group

insert(body)

Create Group

list(customer=None, domain=None, pageToken=None, maxResults=None, userKey=None)

Retrieve all groups in a domain (paginated)

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(groupKey, body)

Update Group. This method supports patch semantics.

update(groupKey, body)

Update Group

Method Details

delete(groupKey) 
Delete Group

Args:
  groupKey: string, Email or immutable Id of the group (required)
get(groupKey) 
Retrieve Group

Args:
  groupKey: string, Email or immutable Id of the group (required)

Returns:
  An object of the form:

    { # JSON template for Group resource in Directory API.
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "description": "A String", # Description of the group
      "name": "A String", # Group name
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "directMembersCount": "A String", # Group direct members count
      "id": "A String", # Unique identifier of Group (Read-only)
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of Group
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
    }
insert(body) 
Create Group

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Group resource in Directory API.
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "kind": "admin#directory#group", # Kind of resource this is.
    "description": "A String", # Description of the group
    "name": "A String", # Group name
    "adminCreated": True or False, # Is the group created by admin (Read-only) *
    "directMembersCount": "A String", # Group direct members count
    "id": "A String", # Unique identifier of Group (Read-only)
    "etag": "A String", # ETag of the resource.
    "email": "A String", # Email of Group
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # JSON template for Group resource in Directory API.
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "description": "A String", # Description of the group
      "name": "A String", # Group name
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "directMembersCount": "A String", # Group direct members count
      "id": "A String", # Unique identifier of Group (Read-only)
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of Group
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
    }
list(customer=None, domain=None, pageToken=None, maxResults=None, userKey=None) 
Retrieve all groups in a domain (paginated)

Args:
  customer: string, Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
  domain: string, Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
  pageToken: string, Token to specify next page in the list
  maxResults: integer, Maximum number of results to return. Default is 200
  userKey: string, Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object

Returns:
  An object of the form:

    { # JSON response template for List Groups operation in Directory API.
    "nextPageToken": "A String", # Token used to access next page of this result.
    "kind": "admin#directory#groups", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "groups": [ # List of group objects.
      { # JSON template for Group resource in Directory API.
          "nonEditableAliases": [ # List of non editable aliases (Read-only)
            "A String",
          ],
          "kind": "admin#directory#group", # Kind of resource this is.
          "description": "A String", # Description of the group
          "name": "A String", # Group name
          "adminCreated": True or False, # Is the group created by admin (Read-only) *
          "directMembersCount": "A String", # Group direct members count
          "id": "A String", # Unique identifier of Group (Read-only)
          "etag": "A String", # ETag of the resource.
          "email": "A String", # Email of Group
          "aliases": [ # List of aliases (Read-only)
            "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(groupKey, body) 
Update Group. This method supports patch semantics.

Args:
  groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Group resource in Directory API.
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "kind": "admin#directory#group", # Kind of resource this is.
    "description": "A String", # Description of the group
    "name": "A String", # Group name
    "adminCreated": True or False, # Is the group created by admin (Read-only) *
    "directMembersCount": "A String", # Group direct members count
    "id": "A String", # Unique identifier of Group (Read-only)
    "etag": "A String", # ETag of the resource.
    "email": "A String", # Email of Group
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # JSON template for Group resource in Directory API.
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "description": "A String", # Description of the group
      "name": "A String", # Group name
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "directMembersCount": "A String", # Group direct members count
      "id": "A String", # Unique identifier of Group (Read-only)
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of Group
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
    }
update(groupKey, body) 
Update Group

Args:
  groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Group resource in Directory API.
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "kind": "admin#directory#group", # Kind of resource this is.
    "description": "A String", # Description of the group
    "name": "A String", # Group name
    "adminCreated": True or False, # Is the group created by admin (Read-only) *
    "directMembersCount": "A String", # Group direct members count
    "id": "A String", # Unique identifier of Group (Read-only)
    "etag": "A String", # ETag of the resource.
    "email": "A String", # Email of Group
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # JSON template for Group resource in Directory API.
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "description": "A String", # Description of the group
      "name": "A String", # Group name
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "directMembersCount": "A String", # Group direct members count
      "id": "A String", # Unique identifier of Group (Read-only)
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of Group
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.html000066400000000000000000000117331300622755700245460ustar00rootroot00000000000000

Admin Directory API

Instance Methods

asps()

Returns the asps Resource.

channels()

Returns the channels Resource.

chromeosdevices()

Returns the chromeosdevices Resource.

customers()

Returns the customers Resource.

domainAliases()

Returns the domainAliases Resource.

domains()

Returns the domains Resource.

groups()

Returns the groups Resource.

members()

Returns the members Resource.

mobiledevices()

Returns the mobiledevices Resource.

notifications()

Returns the notifications Resource.

orgunits()

Returns the orgunits Resource.

privileges()

Returns the privileges Resource.

resources()

Returns the resources Resource.

roleAssignments()

Returns the roleAssignments Resource.

roles()

Returns the roles Resource.

schemas()

Returns the schemas Resource.

tokens()

Returns the tokens Resource.

users()

Returns the users Resource.

verificationCodes()

Returns the verificationCodes Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.members.html000066400000000000000000000234321300622755700261760ustar00rootroot00000000000000

Admin Directory API . members

Instance Methods

delete(groupKey, memberKey)

Remove membership.

get(groupKey, memberKey)

Retrieve Group Member

insert(groupKey, body)

Add user to the specified group.

list(groupKey, pageToken=None, maxResults=None, roles=None)

Retrieve all members in a group (paginated)

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(groupKey, memberKey, body)

Update membership of a user in the specified group. This method supports patch semantics.

update(groupKey, memberKey, body)

Update membership of a user in the specified group.

Method Details

delete(groupKey, memberKey) 
Remove membership.

Args:
  groupKey: string, Email or immutable Id of the group (required)
  memberKey: string, Email or immutable Id of the member (required)
get(groupKey, memberKey) 
Retrieve Group Member

Args:
  groupKey: string, Email or immutable Id of the group (required)
  memberKey: string, Email or immutable Id of the member (required)

Returns:
  An object of the form:

    { # JSON template for Member resource in Directory API.
      "status": "A String", # Status of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
      "etag": "A String", # ETag of the resource.
      "role": "A String", # Role of member
      "type": "A String", # Type of member (Immutable)
      "email": "A String", # Email of member (Read-only)
    }
insert(groupKey, body) 
Add user to the specified group.

Args:
  groupKey: string, Email or immutable Id of the group (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Member resource in Directory API.
    "status": "A String", # Status of member (Immutable)
    "kind": "admin#directory#member", # Kind of resource this is.
    "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
    "etag": "A String", # ETag of the resource.
    "role": "A String", # Role of member
    "type": "A String", # Type of member (Immutable)
    "email": "A String", # Email of member (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Member resource in Directory API.
      "status": "A String", # Status of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
      "etag": "A String", # ETag of the resource.
      "role": "A String", # Role of member
      "type": "A String", # Type of member (Immutable)
      "email": "A String", # Email of member (Read-only)
    }
list(groupKey, pageToken=None, maxResults=None, roles=None) 
Retrieve all members in a group (paginated)

Args:
  groupKey: string, Email or immutable Id of the group (required)
  pageToken: string, Token to specify next page in the list
  maxResults: integer, Maximum number of results to return. Default is 200
  roles: string, Comma separated role values to filter list results on.

Returns:
  An object of the form:

    { # JSON response template for List Members operation in Directory API.
    "nextPageToken": "A String", # Token used to access next page of this result.
    "kind": "admin#directory#members", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "members": [ # List of member objects.
      { # JSON template for Member resource in Directory API.
          "status": "A String", # Status of member (Immutable)
          "kind": "admin#directory#member", # Kind of resource this is.
          "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
          "etag": "A String", # ETag of the resource.
          "role": "A String", # Role of member
          "type": "A String", # Type of member (Immutable)
          "email": "A String", # Email of member (Read-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(groupKey, memberKey, body) 
Update membership of a user in the specified group. This method supports patch semantics.

Args:
  groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
  memberKey: string, Email or immutable Id of the user. If Id, it should match with id of member object (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Member resource in Directory API.
    "status": "A String", # Status of member (Immutable)
    "kind": "admin#directory#member", # Kind of resource this is.
    "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
    "etag": "A String", # ETag of the resource.
    "role": "A String", # Role of member
    "type": "A String", # Type of member (Immutable)
    "email": "A String", # Email of member (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Member resource in Directory API.
      "status": "A String", # Status of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
      "etag": "A String", # ETag of the resource.
      "role": "A String", # Role of member
      "type": "A String", # Type of member (Immutable)
      "email": "A String", # Email of member (Read-only)
    }
update(groupKey, memberKey, body) 
Update membership of a user in the specified group.

Args:
  groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
  memberKey: string, Email or immutable Id of the user. If Id, it should match with id of member object (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Member resource in Directory API.
    "status": "A String", # Status of member (Immutable)
    "kind": "admin#directory#member", # Kind of resource this is.
    "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
    "etag": "A String", # ETag of the resource.
    "role": "A String", # Role of member
    "type": "A String", # Type of member (Immutable)
    "email": "A String", # Email of member (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Member resource in Directory API.
      "status": "A String", # Status of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
      "etag": "A String", # ETag of the resource.
      "role": "A String", # Role of member
      "type": "A String", # Type of member (Immutable)
      "email": "A String", # Email of member (Read-only)
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.mobiledevices.html000066400000000000000000000322121300622755700273520ustar00rootroot00000000000000

Admin Directory API . mobiledevices

Instance Methods

action(customerId, resourceId, body)

Take action on Mobile Device

delete(customerId, resourceId)

Delete Mobile Device

get(customerId, resourceId, projection=None)

Retrieve Mobile Device

list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)

Retrieve all Mobile Devices of a customer (paginated)

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

action(customerId, resourceId, body) 
Take action on Mobile Device

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  resourceId: string, Immutable id of Mobile Device (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON request template for firing commands on Mobile Device in Directory Devices API.
    "action": "A String", # Action to be taken on the Mobile Device
  }
delete(customerId, resourceId) 
Delete Mobile Device

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  resourceId: string, Immutable id of Mobile Device (required)
get(customerId, resourceId, projection=None) 
Retrieve Mobile Device

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  resourceId: string, Immutable id of Mobile Device (required)
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
      FULL - Includes all metadata fields

Returns:
  An object of the form:

    { # JSON template for Mobile Device resource in Directory API.
    "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
    "deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
    "resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
    "defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
    "hardware": "A String", # Mobile Device Hardware (Read-only)
    "userAgent": "A String", # Mobile Device user agent
    "firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
    "otherAccountsInfo": [ # List of accounts added on device (Read-only)
      "A String",
    ],
    "releaseVersion": "A String", # Mobile Device release version version (Read-only)
    "hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
    "etag": "A String", # ETag of the resource.
    "securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
    "privilege": "A String", # DMAgentPermission (Read-only)
    "encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
    "type": "A String", # The type of device (Read-only)
    "email": [ # List of owner user's email addresses (Read-only)
      "A String",
    ],
    "devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
    "kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
    "brand": "A String", # Mobile Device Brand (Read-only)
    "meid": "A String", # Mobile Device MEID number (Read-only)
    "buildNumber": "A String", # Mobile Device Build number (Read-only)
    "applications": [ # List of applications installed on Mobile Device
      {
        "versionCode": 42, # Version code of application
        "packageName": "A String", # Package name of application
        "displayName": "A String", # Display name of application
        "versionName": "A String", # Version name of application
        "permission": [ # List of Permissions for application
          "A String",
        ],
      },
    ],
    "deviceId": "A String", # Mobile Device serial number (Read-only)
    "imei": "A String", # Mobile Device IMEI number (Read-only)
    "adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
    "bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
    "manufacturer": "A String", # Mobile Device manufacturer (Read-only)
    "basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
    "kind": "admin#directory#mobiledevice", # Kind of resource this is.
    "developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
    "name": [ # List of owner user's names (Read-only)
      "A String",
    ],
    "serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
    "supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
    "networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
    "status": "A String", # Status of the device (Read-only)
    "unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
    "managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
    "model": "A String", # Name of the model of the device
    "os": "A String", # Name of the mobile operating system
    "wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-only)
  }
list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None) 
Retrieve all Mobile Devices of a customer (paginated)

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  orderBy: string, Column to use for sorting results
    Allowed values
      deviceId - Mobile Device serial number.
      email - Owner user email.
      lastSync - Last policy settings sync date time of the device.
      model - Mobile Device model.
      name - Owner user name.
      os - Mobile operating system.
      status - Status of the device.
      type - Type of the device.
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
      FULL - Includes all metadata fields
  pageToken: string, Token to specify next page in the list
  maxResults: integer, Maximum number of results to return. Default is 100
  sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  query: string, Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search

Returns:
  An object of the form:

    { # JSON response template for List Mobile Devices operation in Directory API.
    "nextPageToken": "A String", # Token used to access next page of this result.
    "kind": "admin#directory#mobiledevices", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "mobiledevices": [ # List of Mobile Device objects.
      { # JSON template for Mobile Device resource in Directory API.
        "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
        "deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
        "resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
        "defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
        "hardware": "A String", # Mobile Device Hardware (Read-only)
        "userAgent": "A String", # Mobile Device user agent
        "firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
        "otherAccountsInfo": [ # List of accounts added on device (Read-only)
          "A String",
        ],
        "releaseVersion": "A String", # Mobile Device release version version (Read-only)
        "hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
        "etag": "A String", # ETag of the resource.
        "securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
        "privilege": "A String", # DMAgentPermission (Read-only)
        "encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
        "type": "A String", # The type of device (Read-only)
        "email": [ # List of owner user's email addresses (Read-only)
          "A String",
        ],
        "devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
        "kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
        "brand": "A String", # Mobile Device Brand (Read-only)
        "meid": "A String", # Mobile Device MEID number (Read-only)
        "buildNumber": "A String", # Mobile Device Build number (Read-only)
        "applications": [ # List of applications installed on Mobile Device
          {
            "versionCode": 42, # Version code of application
            "packageName": "A String", # Package name of application
            "displayName": "A String", # Display name of application
            "versionName": "A String", # Version name of application
            "permission": [ # List of Permissions for application
              "A String",
            ],
          },
        ],
        "deviceId": "A String", # Mobile Device serial number (Read-only)
        "imei": "A String", # Mobile Device IMEI number (Read-only)
        "adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
        "bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
        "manufacturer": "A String", # Mobile Device manufacturer (Read-only)
        "basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
        "kind": "admin#directory#mobiledevice", # Kind of resource this is.
        "developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
        "name": [ # List of owner user's names (Read-only)
          "A String",
        ],
        "serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
        "supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
        "networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
        "status": "A String", # Status of the device (Read-only)
        "unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
        "managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
        "model": "A String", # Name of the model of the device
        "os": "A String", # Name of the mobile operating system
        "wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-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.
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.notifications.html000066400000000000000000000214211300622755700274110ustar00rootroot00000000000000

Admin Directory API . notifications

Instance Methods

delete(customer, notificationId)

Deletes a notification

get(customer, notificationId)

Retrieves a notification.

list(customer, language=None, pageToken=None, maxResults=None)

Retrieves a list of notifications.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(customer, notificationId, body)

Updates a notification. This method supports patch semantics.

update(customer, notificationId, body)

Updates a notification.

Method Details

delete(customer, notificationId) 
Deletes a notification

Args:
  customer: string, The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource. (required)
  notificationId: string, The unique ID of the notification. (required)
get(customer, notificationId) 
Retrieves a notification.

Args:
  customer: string, The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource. (required)
  notificationId: string, The unique ID of the notification. (required)

Returns:
  An object of the form:

    { # Template for a notification resource.
      "body": "A String", # Body of the notification (Read-only)
      "kind": "admin#directory#notification", # The type of the resource.
      "etag": "A String", # ETag of the resource.
      "sendTime": "A String", # Time at which notification was sent (Read-only)
      "notificationId": "A String",
      "fromAddress": "A String", # Address from which the notification is received (Read-only)
      "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
      "subject": "A String", # Subject of the notification (Read-only)
    }
list(customer, language=None, pageToken=None, maxResults=None) 
Retrieves a list of notifications.

Args:
  customer: string, The unique ID for the customer's Google account. (required)
  language: string, The ISO 639-1 code of the language notifications are returned in. The default is English (en).
  pageToken: string, The token to specify the page of results to retrieve.
  maxResults: integer, Maximum number of notifications to return per page. The default is 100.

Returns:
  An object of the form:

    { # Template for notifications list response.
    "nextPageToken": "A String", # Token for fetching the next page of notifications.
    "items": [ # List of notifications in this page.
      { # Template for a notification resource.
          "body": "A String", # Body of the notification (Read-only)
          "kind": "admin#directory#notification", # The type of the resource.
          "etag": "A String", # ETag of the resource.
          "sendTime": "A String", # Time at which notification was sent (Read-only)
          "notificationId": "A String",
          "fromAddress": "A String", # Address from which the notification is received (Read-only)
          "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
          "subject": "A String", # Subject of the notification (Read-only)
        },
    ],
    "kind": "admin#directory#notifications", # The type of the resource.
    "etag": "A String", # ETag of the resource.
    "unreadNotificationsCount": 42, # Number of unread notification for the domain.
  }
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(customer, notificationId, body) 
Updates a notification. This method supports patch semantics.

Args:
  customer: string, The unique ID for the customer's Google account. (required)
  notificationId: string, The unique ID of the notification. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Template for a notification resource.
    "body": "A String", # Body of the notification (Read-only)
    "kind": "admin#directory#notification", # The type of the resource.
    "etag": "A String", # ETag of the resource.
    "sendTime": "A String", # Time at which notification was sent (Read-only)
    "notificationId": "A String",
    "fromAddress": "A String", # Address from which the notification is received (Read-only)
    "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    "subject": "A String", # Subject of the notification (Read-only)
  }


Returns:
  An object of the form:

    { # Template for a notification resource.
      "body": "A String", # Body of the notification (Read-only)
      "kind": "admin#directory#notification", # The type of the resource.
      "etag": "A String", # ETag of the resource.
      "sendTime": "A String", # Time at which notification was sent (Read-only)
      "notificationId": "A String",
      "fromAddress": "A String", # Address from which the notification is received (Read-only)
      "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
      "subject": "A String", # Subject of the notification (Read-only)
    }
update(customer, notificationId, body) 
Updates a notification.

Args:
  customer: string, The unique ID for the customer's Google account. (required)
  notificationId: string, The unique ID of the notification. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Template for a notification resource.
    "body": "A String", # Body of the notification (Read-only)
    "kind": "admin#directory#notification", # The type of the resource.
    "etag": "A String", # ETag of the resource.
    "sendTime": "A String", # Time at which notification was sent (Read-only)
    "notificationId": "A String",
    "fromAddress": "A String", # Address from which the notification is received (Read-only)
    "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    "subject": "A String", # Subject of the notification (Read-only)
  }


Returns:
  An object of the form:

    { # Template for a notification resource.
      "body": "A String", # Body of the notification (Read-only)
      "kind": "admin#directory#notification", # The type of the resource.
      "etag": "A String", # ETag of the resource.
      "sendTime": "A String", # Time at which notification was sent (Read-only)
      "notificationId": "A String",
      "fromAddress": "A String", # Address from which the notification is received (Read-only)
      "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
      "subject": "A String", # Subject of the notification (Read-only)
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.orgunits.html000066400000000000000000000222441300622755700264160ustar00rootroot00000000000000

Admin Directory API . orgunits

Instance Methods

delete(customerId, orgUnitPath)

Remove Organization Unit

get(customerId, orgUnitPath)

Retrieve Organization Unit

insert(customerId, body)

Add Organization Unit

list(customerId, type=None, orgUnitPath=None)

Retrieve all Organization Units

patch(customerId, orgUnitPath, body)

Update Organization Unit. This method supports patch semantics.

update(customerId, orgUnitPath, body)

Update Organization Unit

Method Details

delete(customerId, orgUnitPath) 
Remove Organization Unit

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
get(customerId, orgUnitPath) 
Retrieve Organization Unit

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)

Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API.
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "name": "A String", # Name of OrgUnit
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # Path of OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "blockInheritance": True or False, # Should block inheritance
      "orgUnitId": "A String", # Id of OrgUnit
      "description": "A String", # Description of OrgUnit
    }
insert(customerId, body) 
Add Organization Unit

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Org Unit resource in Directory API.
    "kind": "admin#directory#orgUnit", # Kind of resource this is.
    "parentOrgUnitPath": "A String", # Path of parent OrgUnit
    "name": "A String", # Name of OrgUnit
    "etag": "A String", # ETag of the resource.
    "orgUnitPath": "A String", # Path of OrgUnit
    "parentOrgUnitId": "A String", # Id of parent OrgUnit
    "blockInheritance": True or False, # Should block inheritance
    "orgUnitId": "A String", # Id of OrgUnit
    "description": "A String", # Description of OrgUnit
  }


Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API.
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "name": "A String", # Name of OrgUnit
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # Path of OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "blockInheritance": True or False, # Should block inheritance
      "orgUnitId": "A String", # Id of OrgUnit
      "description": "A String", # Description of OrgUnit
    }
list(customerId, type=None, orgUnitPath=None) 
Retrieve all Organization Units

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  type: string, Whether to return all sub-organizations or just immediate children
    Allowed values
      all - All sub-organization units.
      children - Immediate children only (default).
  orgUnitPath: string, the URL-encoded organization unit's path or its Id

Returns:
  An object of the form:

    { # JSON response template for List Organization Units operation in Directory API.
    "kind": "admin#directory#orgUnits", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "organizationUnits": [ # List of user objects.
      { # JSON template for Org Unit resource in Directory API.
          "kind": "admin#directory#orgUnit", # Kind of resource this is.
          "parentOrgUnitPath": "A String", # Path of parent OrgUnit
          "name": "A String", # Name of OrgUnit
          "etag": "A String", # ETag of the resource.
          "orgUnitPath": "A String", # Path of OrgUnit
          "parentOrgUnitId": "A String", # Id of parent OrgUnit
          "blockInheritance": True or False, # Should block inheritance
          "orgUnitId": "A String", # Id of OrgUnit
          "description": "A String", # Description of OrgUnit
        },
    ],
  }
patch(customerId, orgUnitPath, body) 
Update Organization Unit. This method supports patch semantics.

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Org Unit resource in Directory API.
    "kind": "admin#directory#orgUnit", # Kind of resource this is.
    "parentOrgUnitPath": "A String", # Path of parent OrgUnit
    "name": "A String", # Name of OrgUnit
    "etag": "A String", # ETag of the resource.
    "orgUnitPath": "A String", # Path of OrgUnit
    "parentOrgUnitId": "A String", # Id of parent OrgUnit
    "blockInheritance": True or False, # Should block inheritance
    "orgUnitId": "A String", # Id of OrgUnit
    "description": "A String", # Description of OrgUnit
  }


Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API.
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "name": "A String", # Name of OrgUnit
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # Path of OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "blockInheritance": True or False, # Should block inheritance
      "orgUnitId": "A String", # Id of OrgUnit
      "description": "A String", # Description of OrgUnit
    }
update(customerId, orgUnitPath, body) 
Update Organization Unit

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Org Unit resource in Directory API.
    "kind": "admin#directory#orgUnit", # Kind of resource this is.
    "parentOrgUnitPath": "A String", # Path of parent OrgUnit
    "name": "A String", # Name of OrgUnit
    "etag": "A String", # ETag of the resource.
    "orgUnitPath": "A String", # Path of OrgUnit
    "parentOrgUnitId": "A String", # Id of parent OrgUnit
    "blockInheritance": True or False, # Should block inheritance
    "orgUnitId": "A String", # Id of OrgUnit
    "description": "A String", # Description of OrgUnit
  }


Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API.
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "name": "A String", # Name of OrgUnit
      "etag": "A String", # ETag of the resource.
      "orgUnitPath": "A String", # Path of OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "blockInheritance": True or False, # Should block inheritance
      "orgUnitId": "A String", # Id of OrgUnit
      "description": "A String", # Description of OrgUnit
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.privileges.html000066400000000000000000000052241300622755700267140ustar00rootroot00000000000000

Admin Directory API . privileges

Instance Methods

list(customer)

Retrieves a paginated list of all privileges for a customer.

Method Details

list(customer) 
Retrieves a paginated list of all privileges for a customer.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)

Returns:
  An object of the form:

    { # JSON response template for List privileges operation in Directory API.
    "items": [ # A list of Privilege resources.
      { # JSON template for privilege resource in Directory API.
        "kind": "admin#directory#privilege", # The type of the API resource. This is always admin#directory#privilege.
        "privilegeName": "A String", # The name of the privilege.
        "isOuScopable": True or False, # If the privilege can be restricted to an organization unit.
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "etag": "A String", # ETag of the resource.
        "childPrivileges": [ # A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.
          # Object with schema name: Privilege
        ],
        "serviceName": "A String", # The name of the service this privilege is for.
      },
    ],
    "kind": "admin#directory#privileges", # The type of the API resource. This is always admin#directory#privileges.
    "etag": "A String", # ETag of the resource.
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.resources.calendars.html000066400000000000000000000320301300622755700305030ustar00rootroot00000000000000

Admin Directory API . resources . calendars

Instance Methods

delete(customer, calendarResourceId)

Deletes a calendar resource.

get(customer, calendarResourceId)

Retrieves a calendar resource.

insert(customer, body)

Inserts a calendar resource.

list(customer, pageToken=None, maxResults=None)

Retrieves a list of calendar resources for an account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(customer, calendarResourceId, body)

Updates a calendar resource. This method supports patch semantics.

update(customer, calendarResourceId, body)

Updates a calendar resource.

Method Details

delete(customer, calendarResourceId) 
Deletes a calendar resource.

Args:
  customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to delete. (required)
get(customer, calendarResourceId) 
Retrieves a calendar resource.

Args:
  customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
insert(customer, body) 
Inserts a calendar resource.

Args:
  customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Calendar Resource object in Directory API.
    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
    "resourceDescription": "A String", # The brief description of the calendar resource.
    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
    "etags": "A String", # ETag of the resource.
    "resourceId": "A String", # The unique ID for the calendar resource.
    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
  }


Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
list(customer, pageToken=None, maxResults=None) 
Retrieves a list of calendar resources for an account.

Args:
  customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return.

Returns:
  An object of the form:

    { # JSON template for Calendar Resource List Response object in Directory API.
    "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 CalendarResources in this page of results.
      { # JSON template for Calendar Resource object in Directory API.
          "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
          "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
          "resourceDescription": "A String", # The brief description of the calendar resource.
          "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
          "etags": "A String", # ETag of the resource.
          "resourceId": "A String", # The unique ID for the calendar resource.
          "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
        },
    ],
    "kind": "admin#directory#resources#calendars#calendarResourcesList", # Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
    "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(customer, calendarResourceId, body) 
Updates a calendar resource. This method supports patch semantics.

Args:
  customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Calendar Resource object in Directory API.
    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
    "resourceDescription": "A String", # The brief description of the calendar resource.
    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
    "etags": "A String", # ETag of the resource.
    "resourceId": "A String", # The unique ID for the calendar resource.
    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
  }


Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
update(customer, calendarResourceId, body) 
Updates a calendar resource.

Args:
  customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Calendar Resource object in Directory API.
    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
    "resourceDescription": "A String", # The brief description of the calendar resource.
    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
    "etags": "A String", # ETag of the resource.
    "resourceId": "A String", # The unique ID for the calendar resource.
    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
  }


Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.resources.html000066400000000000000000000023741300622755700265600ustar00rootroot00000000000000

Admin Directory API . resources

Instance Methods

calendars()

Returns the calendars Resource.

google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.roleAssignments.html000066400000000000000000000170201300622755700277150ustar00rootroot00000000000000

Admin Directory API . roleAssignments

Instance Methods

delete(customer, roleAssignmentId)

Deletes a role assignment.

get(customer, roleAssignmentId)

Retrieve a role assignment.

insert(customer, body)

Creates a role assignment.

list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)

Retrieves a paginated list of all roleAssignments.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(customer, roleAssignmentId) 
Deletes a role assignment.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  roleAssignmentId: string, Immutable ID of the role assignment. (required)
get(customer, roleAssignmentId) 
Retrieve a role assignment.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  roleAssignmentId: string, Immutable ID of the role assignment. (required)

Returns:
  An object of the form:

    { # JSON template for roleAssignment resource in Directory API.
      "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
      "roleAssignmentId": "A String", # ID of this roleAssignment.
      "roleId": "A String", # The ID of the role that is assigned.
      "assignedTo": "A String", # The unique ID of the user this role is assigned to.
      "etag": "A String", # ETag of the resource.
      "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
          # - CUSTOMER
          # - ORG_UNIT
      "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    }
insert(customer, body) 
Creates a role assignment.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for roleAssignment resource in Directory API.
    "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
    "roleAssignmentId": "A String", # ID of this roleAssignment.
    "roleId": "A String", # The ID of the role that is assigned.
    "assignedTo": "A String", # The unique ID of the user this role is assigned to.
    "etag": "A String", # ETag of the resource.
    "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
        # - CUSTOMER
        # - ORG_UNIT
    "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
  }


Returns:
  An object of the form:

    { # JSON template for roleAssignment resource in Directory API.
      "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
      "roleAssignmentId": "A String", # ID of this roleAssignment.
      "roleId": "A String", # The ID of the role that is assigned.
      "assignedTo": "A String", # The unique ID of the user this role is assigned to.
      "etag": "A String", # ETag of the resource.
      "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
          # - CUSTOMER
          # - ORG_UNIT
      "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    }
list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None) 
Retrieves a paginated list of all roleAssignments.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  pageToken: string, Token to specify the next page in the list.
  roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
  maxResults: integer, Maximum number of results to return.
  userKey: string, The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.

Returns:
  An object of the form:

    { # JSON response template for List roleAssignments operation in Directory API.
    "nextPageToken": "A String",
    "items": [ # A list of RoleAssignment resources.
      { # JSON template for roleAssignment resource in Directory API.
          "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
          "roleAssignmentId": "A String", # ID of this roleAssignment.
          "roleId": "A String", # The ID of the role that is assigned.
          "assignedTo": "A String", # The unique ID of the user this role is assigned to.
          "etag": "A String", # ETag of the resource.
          "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
              # - CUSTOMER
              # - ORG_UNIT
          "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
        },
    ],
    "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always admin#directory#roleAssignments.
    "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.
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.roles.html000066400000000000000000000270311300622755700256670ustar00rootroot00000000000000

Admin Directory API . roles

Instance Methods

delete(customer, roleId)

Deletes a role.

get(customer, roleId)

Retrieves a role.

insert(customer, body)

Creates a role.

list(customer, pageToken=None, maxResults=None)

Retrieves a paginated list of all the roles in a domain.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(customer, roleId, body)

Updates a role. This method supports patch semantics.

update(customer, roleId, body)

Updates a role.

Method Details

delete(customer, roleId) 
Deletes a role.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  roleId: string, Immutable ID of the role. (required)
get(customer, roleId) 
Retrieves a role.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  roleId: string, Immutable ID of the role. (required)

Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }
insert(customer, body) 
Creates a role.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for role resource in Directory API.
    "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    "roleId": "A String", # ID of the role.
    "roleDescription": "A String", # A short description of the role.
    "etag": "A String", # ETag of the resource.
    "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    "roleName": "A String", # Name of the role.
    "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    "rolePrivileges": [ # The set of privileges that are granted to this role.
      {
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "privilegeName": "A String", # The name of the privilege.
      },
    ],
  }


Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }
list(customer, pageToken=None, maxResults=None) 
Retrieves a paginated list of all the roles in a domain.

Args:
  customer: string, Immutable id of the Google Apps account. (required)
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return.

Returns:
  An object of the form:

    { # JSON response template for List roles operation in Directory API.
    "nextPageToken": "A String",
    "items": [ # A list of Role resources.
      { # JSON template for role resource in Directory API.
          "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
          "roleId": "A String", # ID of the role.
          "roleDescription": "A String", # A short description of the role.
          "etag": "A String", # ETag of the resource.
          "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
          "roleName": "A String", # Name of the role.
          "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
          "rolePrivileges": [ # The set of privileges that are granted to this role.
            {
              "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
              "privilegeName": "A String", # The name of the privilege.
            },
          ],
        },
    ],
    "kind": "admin#directory#roles", # The type of the API resource. This is always admin#directory#roles.
    "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(customer, roleId, body) 
Updates a role. This method supports patch semantics.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  roleId: string, Immutable ID of the role. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for role resource in Directory API.
    "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    "roleId": "A String", # ID of the role.
    "roleDescription": "A String", # A short description of the role.
    "etag": "A String", # ETag of the resource.
    "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    "roleName": "A String", # Name of the role.
    "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    "rolePrivileges": [ # The set of privileges that are granted to this role.
      {
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "privilegeName": "A String", # The name of the privilege.
      },
    ],
  }


Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }
update(customer, roleId, body) 
Updates a role.

Args:
  customer: string, Immutable ID of the Google Apps account. (required)
  roleId: string, Immutable ID of the role. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for role resource in Directory API.
    "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    "roleId": "A String", # ID of the role.
    "roleDescription": "A String", # A short description of the role.
    "etag": "A String", # ETag of the resource.
    "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    "roleName": "A String", # Name of the role.
    "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    "rolePrivileges": [ # The set of privileges that are granted to this role.
      {
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "privilegeName": "A String", # The name of the privilege.
      },
    ],
  }


Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.schemas.html000066400000000000000000000435151300622755700261730ustar00rootroot00000000000000

Admin Directory API . schemas

Instance Methods

delete(customerId, schemaKey)

Delete schema

get(customerId, schemaKey)

Retrieve schema

insert(customerId, body)

Create schema.

list(customerId)

Retrieve all schemas for a customer

patch(customerId, schemaKey, body)

Update schema. This method supports patch semantics.

update(customerId, schemaKey, body)

Update schema

Method Details

delete(customerId, schemaKey) 
Delete schema

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  schemaKey: string, Name or immutable Id of the schema (required)
get(customerId, schemaKey) 
Retrieve schema

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  schemaKey: string, Name or immutable Id of the schema (required)

Returns:
  An object of the form:

    { # JSON template for Schema resource in Directory API.
      "fields": [ # Fields of Schema
        { # JSON template for FieldSpec resource for Schemas in Directory API.
          "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
          "etag": "A String", # ETag of the resource.
          "fieldName": "A String", # Name of the field.
          "fieldType": "A String", # Type of the field.
          "indexed": true, # Boolean specifying whether the field is indexed or not.
          "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
          "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
            "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
            "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          },
          "fieldId": "A String", # Unique identifier of Field (Read-only)
          "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
        },
      ],
      "kind": "admin#directory#schema", # Kind of resource this is.
      "etag": "A String", # ETag of the resource.
      "schemaId": "A String", # Unique identifier of Schema (Read-only)
      "schemaName": "A String", # Schema name
    }
insert(customerId, body) 
Create schema.

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Schema resource in Directory API.
    "fields": [ # Fields of Schema
      { # JSON template for FieldSpec resource for Schemas in Directory API.
        "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
        "etag": "A String", # ETag of the resource.
        "fieldName": "A String", # Name of the field.
        "fieldType": "A String", # Type of the field.
        "indexed": true, # Boolean specifying whether the field is indexed or not.
        "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
        "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
          "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
        },
        "fieldId": "A String", # Unique identifier of Field (Read-only)
        "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
      },
    ],
    "kind": "admin#directory#schema", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "schemaId": "A String", # Unique identifier of Schema (Read-only)
    "schemaName": "A String", # Schema name
  }


Returns:
  An object of the form:

    { # JSON template for Schema resource in Directory API.
      "fields": [ # Fields of Schema
        { # JSON template for FieldSpec resource for Schemas in Directory API.
          "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
          "etag": "A String", # ETag of the resource.
          "fieldName": "A String", # Name of the field.
          "fieldType": "A String", # Type of the field.
          "indexed": true, # Boolean specifying whether the field is indexed or not.
          "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
          "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
            "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
            "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          },
          "fieldId": "A String", # Unique identifier of Field (Read-only)
          "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
        },
      ],
      "kind": "admin#directory#schema", # Kind of resource this is.
      "etag": "A String", # ETag of the resource.
      "schemaId": "A String", # Unique identifier of Schema (Read-only)
      "schemaName": "A String", # Schema name
    }
list(customerId) 
Retrieve all schemas for a customer

Args:
  customerId: string, Immutable id of the Google Apps account (required)

Returns:
  An object of the form:

    { # JSON response template for List Schema operation in Directory API.
    "kind": "admin#directory#schemas", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "schemas": [ # List of UserSchema objects.
      { # JSON template for Schema resource in Directory API.
          "fields": [ # Fields of Schema
            { # JSON template for FieldSpec resource for Schemas in Directory API.
              "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
              "etag": "A String", # ETag of the resource.
              "fieldName": "A String", # Name of the field.
              "fieldType": "A String", # Type of the field.
              "indexed": true, # Boolean specifying whether the field is indexed or not.
              "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
              "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
                "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
                "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
              },
              "fieldId": "A String", # Unique identifier of Field (Read-only)
              "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
            },
          ],
          "kind": "admin#directory#schema", # Kind of resource this is.
          "etag": "A String", # ETag of the resource.
          "schemaId": "A String", # Unique identifier of Schema (Read-only)
          "schemaName": "A String", # Schema name
        },
    ],
  }
patch(customerId, schemaKey, body) 
Update schema. This method supports patch semantics.

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  schemaKey: string, Name or immutable Id of the schema. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Schema resource in Directory API.
    "fields": [ # Fields of Schema
      { # JSON template for FieldSpec resource for Schemas in Directory API.
        "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
        "etag": "A String", # ETag of the resource.
        "fieldName": "A String", # Name of the field.
        "fieldType": "A String", # Type of the field.
        "indexed": true, # Boolean specifying whether the field is indexed or not.
        "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
        "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
          "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
        },
        "fieldId": "A String", # Unique identifier of Field (Read-only)
        "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
      },
    ],
    "kind": "admin#directory#schema", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "schemaId": "A String", # Unique identifier of Schema (Read-only)
    "schemaName": "A String", # Schema name
  }


Returns:
  An object of the form:

    { # JSON template for Schema resource in Directory API.
      "fields": [ # Fields of Schema
        { # JSON template for FieldSpec resource for Schemas in Directory API.
          "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
          "etag": "A String", # ETag of the resource.
          "fieldName": "A String", # Name of the field.
          "fieldType": "A String", # Type of the field.
          "indexed": true, # Boolean specifying whether the field is indexed or not.
          "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
          "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
            "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
            "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          },
          "fieldId": "A String", # Unique identifier of Field (Read-only)
          "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
        },
      ],
      "kind": "admin#directory#schema", # Kind of resource this is.
      "etag": "A String", # ETag of the resource.
      "schemaId": "A String", # Unique identifier of Schema (Read-only)
      "schemaName": "A String", # Schema name
    }
update(customerId, schemaKey, body) 
Update schema

Args:
  customerId: string, Immutable id of the Google Apps account (required)
  schemaKey: string, Name or immutable Id of the schema. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Schema resource in Directory API.
    "fields": [ # Fields of Schema
      { # JSON template for FieldSpec resource for Schemas in Directory API.
        "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
        "etag": "A String", # ETag of the resource.
        "fieldName": "A String", # Name of the field.
        "fieldType": "A String", # Type of the field.
        "indexed": true, # Boolean specifying whether the field is indexed or not.
        "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
        "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
          "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
        },
        "fieldId": "A String", # Unique identifier of Field (Read-only)
        "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
      },
    ],
    "kind": "admin#directory#schema", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "schemaId": "A String", # Unique identifier of Schema (Read-only)
    "schemaName": "A String", # Schema name
  }


Returns:
  An object of the form:

    { # JSON template for Schema resource in Directory API.
      "fields": [ # Fields of Schema
        { # JSON template for FieldSpec resource for Schemas in Directory API.
          "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
          "etag": "A String", # ETag of the resource.
          "fieldName": "A String", # Name of the field.
          "fieldType": "A String", # Type of the field.
          "indexed": true, # Boolean specifying whether the field is indexed or not.
          "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
          "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
            "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
            "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
          },
          "fieldId": "A String", # Unique identifier of Field (Read-only)
          "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
        },
      ],
      "kind": "admin#directory#schema", # Kind of resource this is.
      "etag": "A String", # ETag of the resource.
      "schemaId": "A String", # Unique identifier of Schema (Read-only)
      "schemaName": "A String", # Schema name
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.tokens.html000066400000000000000000000117101300622755700260430ustar00rootroot00000000000000

Admin Directory API . tokens

Instance Methods

delete(userKey, clientId)

Delete all access tokens issued by a user for an application.

get(userKey, clientId)

Get information about an access token issued by a user.

list(userKey)

Returns the set of tokens specified user has issued to 3rd party applications.

Method Details

delete(userKey, clientId) 
Delete all access tokens issued by a user for an application.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
  clientId: string, The Client ID of the application the token is issued to. (required)
get(userKey, clientId) 
Get information about an access token issued by a user.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
  clientId: string, The Client ID of the application the token is issued to. (required)

Returns:
  An object of the form:

    { # JSON template for token resource in Directory API.
    "scopes": [ # A list of authorization scopes the application is granted.
      "A String",
    ],
    "kind": "admin#directory#token", # The type of the API resource. This is always admin#directory#token.
    "nativeApp": True or False, # Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
    "clientId": "A String", # The Client ID of the application the token is issued to.
    "etag": "A String", # ETag of the resource.
    "displayText": "A String", # The displayable name of the application the token is issued to.
    "anonymous": True or False, # Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
    "userKey": "A String", # The unique ID of the user that issued the token.
  }
list(userKey) 
Returns the set of tokens specified user has issued to 3rd party applications.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)

Returns:
  An object of the form:

    { # JSON response template for List tokens operation in Directory API.
    "items": [ # A list of Token resources.
      { # JSON template for token resource in Directory API.
        "scopes": [ # A list of authorization scopes the application is granted.
          "A String",
        ],
        "kind": "admin#directory#token", # The type of the API resource. This is always admin#directory#token.
        "nativeApp": True or False, # Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
        "clientId": "A String", # The Client ID of the application the token is issued to.
        "etag": "A String", # ETag of the resource.
        "displayText": "A String", # The displayable name of the application the token is issued to.
        "anonymous": True or False, # Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
        "userKey": "A String", # The unique ID of the user that issued the token.
      },
    ],
    "kind": "admin#directory#tokenList", # The type of the API resource. This is always admin#directory#tokenList.
    "etag": "A String", # ETag of the resource.
  }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.users.aliases.html000066400000000000000000000153041300622755700273240ustar00rootroot00000000000000

Admin Directory API . users . aliases

Instance Methods

delete(userKey, alias)

Remove a alias for the user

insert(userKey, body)

Add a alias for the user

list(userKey, event=None)

List all aliases for a user

watch(userKey, body, event=None)

Watch for changes in user aliases list

Method Details

delete(userKey, alias) 
Remove a alias for the user

Args:
  userKey: string, Email or immutable Id of the user (required)
  alias: string, The alias to be removed (required)
insert(userKey, body) 
Add a alias for the user

Args:
  userKey: string, Email or immutable Id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Alias object in Directory API.
    "alias": "A String", # A alias email
    "kind": "admin#directory#alias", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
    "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Alias object in Directory API.
      "alias": "A String", # A alias email
      "kind": "admin#directory#alias", # Kind of resource this is.
      "etag": "A String", # ETag of the resource.
      "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
      "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
    }
list(userKey, event=None) 
List all aliases for a user

Args:
  userKey: string, Email or immutable Id of the user (required)
  event: string, Event on which subscription is intended (if subscribing)
    Allowed values
      add - Alias Created Event
      delete - Alias Deleted Event

Returns:
  An object of the form:

    { # JSON response template to list aliases in Directory API.
    "kind": "admin#directory#aliases", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "aliases": [ # List of alias objects.
      "",
    ],
  }
watch(userKey, body, event=None) 
Watch for changes in user aliases list

Args:
  userKey: string, Email or immutable Id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  event: string, Event on which subscription is intended (if subscribing)
    Allowed values
      add - Alias Created Event
      delete - Alias Deleted Event

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.users.html000066400000000000000000001040001300622755700256740ustar00rootroot00000000000000

Admin Directory API . users

Instance Methods

aliases()

Returns the aliases Resource.

photos()

Returns the photos Resource.

delete(userKey)

Delete user

get(userKey, projection=None, customFieldMask=None, viewType=None)

retrieve user

insert(body)

create user.

list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)

Retrieve either deleted users or all users in a domain (paginated)

list_next(previous_request, previous_response)

Retrieves the next page of results.

makeAdmin(userKey, body)

change admin status of a user

patch(userKey, body)

update user. This method supports patch semantics.

undelete(userKey, body)

Undelete a deleted user

update(userKey, body)

update user

watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)

Watch for changes in users list

Method Details

delete(userKey) 
Delete user

Args:
  userKey: string, Email or immutable Id of the user (required)
get(userKey, projection=None, customFieldMask=None, viewType=None) 
retrieve user

Args:
  userKey: string, Email or immutable Id of the user (required)
  projection: string, What subset of fields to fetch for this user.
    Allowed values
      basic - Do not include any custom fields for the user.
      custom - Include custom fields from schemas mentioned in customFieldMask.
      full - Include all fields associated with this user.
  customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
  viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
    Allowed values
      admin_view - Fetches the ADMIN_VIEW of the user.
      domain_public - Fetches the DOMAIN_PUBLIC view of the user.

Returns:
  An object of the form:

    { # JSON template for User object in Directory API.
      "addresses": "",
      "phones": "",
      "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
      "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
      "suspended": True or False, # Indicates if user is suspended
      "id": "A String", # Unique identifier of User (Read-only)
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "customSchemas": { # Custom fields of the user.
        "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
          "a_key": "",
        },
      },
      "deletionTime": "A String",
      "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
      "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
      "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
      "relations": "",
      "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
      "ims": "",
      "etag": "A String", # ETag of the resource.
      "lastLoginTime": "A String", # User's last login time. (Read-only)
      "orgUnitPath": "A String", # OrgUnit of User
      "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
      "externalIds": "",
      "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
      "primaryEmail": "A String", # username of User
      "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
      "password": "A String", # User's password
      "emails": "",
      "organizations": "",
      "kind": "admin#directory#user", # Kind of resource this is.
      "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
      "name": { # JSON template for name of a user in Directory API. # User's name
        "givenName": "A String", # First Name
        "fullName": "A String", # Full Name
        "familyName": "A String", # Last Name
      },
      "notes": "",
      "creationTime": "A String", # User's Google account creation time. (Read-only)
      "websites": "",
      "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
      "customerId": "A String", # CustomerId of User (Read-only)
    }
insert(body) 
create user.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for User object in Directory API.
    "addresses": "",
    "phones": "",
    "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
    "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
    "suspended": True or False, # Indicates if user is suspended
    "id": "A String", # Unique identifier of User (Read-only)
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "customSchemas": { # Custom fields of the user.
      "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
        "a_key": "",
      },
    },
    "deletionTime": "A String",
    "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
    "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
    "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
    "relations": "",
    "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
    "ims": "",
    "etag": "A String", # ETag of the resource.
    "lastLoginTime": "A String", # User's last login time. (Read-only)
    "orgUnitPath": "A String", # OrgUnit of User
    "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
    "externalIds": "",
    "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
    "primaryEmail": "A String", # username of User
    "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
    "password": "A String", # User's password
    "emails": "",
    "organizations": "",
    "kind": "admin#directory#user", # Kind of resource this is.
    "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
    "name": { # JSON template for name of a user in Directory API. # User's name
      "givenName": "A String", # First Name
      "fullName": "A String", # Full Name
      "familyName": "A String", # Last Name
    },
    "notes": "",
    "creationTime": "A String", # User's Google account creation time. (Read-only)
    "websites": "",
    "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
    "customerId": "A String", # CustomerId of User (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for User object in Directory API.
      "addresses": "",
      "phones": "",
      "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
      "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
      "suspended": True or False, # Indicates if user is suspended
      "id": "A String", # Unique identifier of User (Read-only)
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "customSchemas": { # Custom fields of the user.
        "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
          "a_key": "",
        },
      },
      "deletionTime": "A String",
      "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
      "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
      "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
      "relations": "",
      "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
      "ims": "",
      "etag": "A String", # ETag of the resource.
      "lastLoginTime": "A String", # User's last login time. (Read-only)
      "orgUnitPath": "A String", # OrgUnit of User
      "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
      "externalIds": "",
      "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
      "primaryEmail": "A String", # username of User
      "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
      "password": "A String", # User's password
      "emails": "",
      "organizations": "",
      "kind": "admin#directory#user", # Kind of resource this is.
      "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
      "name": { # JSON template for name of a user in Directory API. # User's name
        "givenName": "A String", # First Name
        "fullName": "A String", # Full Name
        "familyName": "A String", # Last Name
      },
      "notes": "",
      "creationTime": "A String", # User's Google account creation time. (Read-only)
      "websites": "",
      "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
      "customerId": "A String", # CustomerId of User (Read-only)
    }
list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None) 
Retrieve either deleted users or all users in a domain (paginated)

Args:
  orderBy: string, Column to use for sorting results
    Allowed values
      email - Primary email of the user.
      familyName - User's family name.
      givenName - User's given name.
  domain: string, Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
  projection: string, What subset of fields to fetch for this user.
    Allowed values
      basic - Do not include any custom fields for the user.
      custom - Include custom fields from schemas mentioned in customFieldMask.
      full - Include all fields associated with this user.
  query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
  event: string, Event on which subscription is intended (if subscribing)
    Allowed values
      add - User Created Event
      delete - User Deleted Event
      makeAdmin - User Admin Status Change Event
      undelete - User Undeleted Event
      update - User Updated Event
  showDeleted: string, If set to true retrieves the list of deleted users. Default is false
  pageToken: string, Token to specify next page in the list
  sortOrder: string, Whether to return results in ascending or descending order.
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500
  customer: string, Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
  customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
  viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
    Allowed values
      admin_view - Fetches the ADMIN_VIEW of the user.
      domain_public - Fetches the DOMAIN_PUBLIC view of the user.

Returns:
  An object of the form:

    { # JSON response template for List Users operation in Apps Directory API.
    "nextPageToken": "A String", # Token used to access next page of this result.
    "kind": "admin#directory#users", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "trigger_event": "A String", # Event that triggered this response (only used in case of Push Response)
    "users": [ # List of user objects.
      { # JSON template for User object in Directory API.
          "addresses": "",
          "phones": "",
          "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
          "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
          "suspended": True or False, # Indicates if user is suspended
          "id": "A String", # Unique identifier of User (Read-only)
          "aliases": [ # List of aliases (Read-only)
            "A String",
          ],
          "nonEditableAliases": [ # List of non editable aliases (Read-only)
            "A String",
          ],
          "customSchemas": { # Custom fields of the user.
            "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
              "a_key": "",
            },
          },
          "deletionTime": "A String",
          "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
          "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
          "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
          "relations": "",
          "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
          "ims": "",
          "etag": "A String", # ETag of the resource.
          "lastLoginTime": "A String", # User's last login time. (Read-only)
          "orgUnitPath": "A String", # OrgUnit of User
          "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
          "externalIds": "",
          "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
          "primaryEmail": "A String", # username of User
          "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
          "password": "A String", # User's password
          "emails": "",
          "organizations": "",
          "kind": "admin#directory#user", # Kind of resource this is.
          "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
          "name": { # JSON template for name of a user in Directory API. # User's name
            "givenName": "A String", # First Name
            "fullName": "A String", # Full Name
            "familyName": "A String", # Last Name
          },
          "notes": "",
          "creationTime": "A String", # User's Google account creation time. (Read-only)
          "websites": "",
          "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
          "customerId": "A String", # CustomerId of User (Read-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.
makeAdmin(userKey, body) 
change admin status of a user

Args:
  userKey: string, Email or immutable Id of the user as admin (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON request template for setting/revoking admin status of a user in Directory API.
    "status": True or False, # Boolean indicating new admin status of the user
  }
patch(userKey, body) 
update user. This method supports patch semantics.

Args:
  userKey: string, Email or immutable Id of the user. If Id, it should match with id of user object (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for User object in Directory API.
    "addresses": "",
    "phones": "",
    "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
    "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
    "suspended": True or False, # Indicates if user is suspended
    "id": "A String", # Unique identifier of User (Read-only)
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "customSchemas": { # Custom fields of the user.
      "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
        "a_key": "",
      },
    },
    "deletionTime": "A String",
    "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
    "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
    "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
    "relations": "",
    "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
    "ims": "",
    "etag": "A String", # ETag of the resource.
    "lastLoginTime": "A String", # User's last login time. (Read-only)
    "orgUnitPath": "A String", # OrgUnit of User
    "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
    "externalIds": "",
    "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
    "primaryEmail": "A String", # username of User
    "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
    "password": "A String", # User's password
    "emails": "",
    "organizations": "",
    "kind": "admin#directory#user", # Kind of resource this is.
    "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
    "name": { # JSON template for name of a user in Directory API. # User's name
      "givenName": "A String", # First Name
      "fullName": "A String", # Full Name
      "familyName": "A String", # Last Name
    },
    "notes": "",
    "creationTime": "A String", # User's Google account creation time. (Read-only)
    "websites": "",
    "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
    "customerId": "A String", # CustomerId of User (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for User object in Directory API.
      "addresses": "",
      "phones": "",
      "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
      "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
      "suspended": True or False, # Indicates if user is suspended
      "id": "A String", # Unique identifier of User (Read-only)
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "customSchemas": { # Custom fields of the user.
        "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
          "a_key": "",
        },
      },
      "deletionTime": "A String",
      "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
      "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
      "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
      "relations": "",
      "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
      "ims": "",
      "etag": "A String", # ETag of the resource.
      "lastLoginTime": "A String", # User's last login time. (Read-only)
      "orgUnitPath": "A String", # OrgUnit of User
      "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
      "externalIds": "",
      "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
      "primaryEmail": "A String", # username of User
      "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
      "password": "A String", # User's password
      "emails": "",
      "organizations": "",
      "kind": "admin#directory#user", # Kind of resource this is.
      "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
      "name": { # JSON template for name of a user in Directory API. # User's name
        "givenName": "A String", # First Name
        "fullName": "A String", # Full Name
        "familyName": "A String", # Last Name
      },
      "notes": "",
      "creationTime": "A String", # User's Google account creation time. (Read-only)
      "websites": "",
      "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
      "customerId": "A String", # CustomerId of User (Read-only)
    }
undelete(userKey, body) 
Undelete a deleted user

Args:
  userKey: string, The immutable id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON request template to undelete a user in Directory API.
    "orgUnitPath": "A String", # OrgUnit of User
  }
update(userKey, body) 
update user

Args:
  userKey: string, Email or immutable Id of the user. If Id, it should match with id of user object (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for User object in Directory API.
    "addresses": "",
    "phones": "",
    "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
    "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
    "suspended": True or False, # Indicates if user is suspended
    "id": "A String", # Unique identifier of User (Read-only)
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "customSchemas": { # Custom fields of the user.
      "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
        "a_key": "",
      },
    },
    "deletionTime": "A String",
    "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
    "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
    "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
    "relations": "",
    "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
    "ims": "",
    "etag": "A String", # ETag of the resource.
    "lastLoginTime": "A String", # User's last login time. (Read-only)
    "orgUnitPath": "A String", # OrgUnit of User
    "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
    "externalIds": "",
    "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
    "primaryEmail": "A String", # username of User
    "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
    "password": "A String", # User's password
    "emails": "",
    "organizations": "",
    "kind": "admin#directory#user", # Kind of resource this is.
    "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
    "name": { # JSON template for name of a user in Directory API. # User's name
      "givenName": "A String", # First Name
      "fullName": "A String", # Full Name
      "familyName": "A String", # Last Name
    },
    "notes": "",
    "creationTime": "A String", # User's Google account creation time. (Read-only)
    "websites": "",
    "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
    "customerId": "A String", # CustomerId of User (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for User object in Directory API.
      "addresses": "",
      "phones": "",
      "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
      "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
      "suspended": True or False, # Indicates if user is suspended
      "id": "A String", # Unique identifier of User (Read-only)
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "customSchemas": { # Custom fields of the user.
        "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
          "a_key": "",
        },
      },
      "deletionTime": "A String",
      "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
      "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
      "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
      "relations": "",
      "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
      "ims": "",
      "etag": "A String", # ETag of the resource.
      "lastLoginTime": "A String", # User's last login time. (Read-only)
      "orgUnitPath": "A String", # OrgUnit of User
      "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
      "externalIds": "",
      "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
      "primaryEmail": "A String", # username of User
      "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
      "password": "A String", # User's password
      "emails": "",
      "organizations": "",
      "kind": "admin#directory#user", # Kind of resource this is.
      "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
      "name": { # JSON template for name of a user in Directory API. # User's name
        "givenName": "A String", # First Name
        "fullName": "A String", # Full Name
        "familyName": "A String", # Last Name
      },
      "notes": "",
      "creationTime": "A String", # User's Google account creation time. (Read-only)
      "websites": "",
      "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
      "customerId": "A String", # CustomerId of User (Read-only)
    }
watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None) 
Watch for changes in users list

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  orderBy: string, Column to use for sorting results
    Allowed values
      email - Primary email of the user.
      familyName - User's family name.
      givenName - User's given name.
  domain: string, Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
  projection: string, What subset of fields to fetch for this user.
    Allowed values
      basic - Do not include any custom fields for the user.
      custom - Include custom fields from schemas mentioned in customFieldMask.
      full - Include all fields associated with this user.
  query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
  event: string, Event on which subscription is intended (if subscribing)
    Allowed values
      add - User Created Event
      delete - User Deleted Event
      makeAdmin - User Admin Status Change Event
      undelete - User Undeleted Event
      update - User Updated Event
  showDeleted: string, If set to true retrieves the list of deleted users. Default is false
  pageToken: string, Token to specify next page in the list
  sortOrder: string, Whether to return results in ascending or descending order.
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500
  customer: string, Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
  customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
  viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
    Allowed values
      admin_view - Fetches the ADMIN_VIEW of the user.
      domain_public - Fetches the DOMAIN_PUBLIC view of the user.

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.users.photos.html000066400000000000000000000125641300622755700272240ustar00rootroot00000000000000

Admin Directory API . users . photos

Instance Methods

delete(userKey)

Remove photos for the user

get(userKey)

Retrieve photo of a user

patch(userKey, body)

Add a photo for the user. This method supports patch semantics.

update(userKey, body)

Add a photo for the user

Method Details

delete(userKey) 
Remove photos for the user

Args:
  userKey: string, Email or immutable Id of the user (required)
get(userKey) 
Retrieve photo of a user

Args:
  userKey: string, Email or immutable Id of the user (required)

Returns:
  An object of the form:

    { # JSON template for Photo object in Directory API.
      "mimeType": "A String", # Mime Type of the photo
      "kind": "admin#directory#user#photo", # Kind of resource this is.
      "photoData": "A String", # Base64 encoded photo data
      "height": 42, # Height in pixels of the photo
      "width": 42, # Width in pixels of the photo
      "etag": "A String", # ETag of the resource.
      "primaryEmail": "A String", # Primary email of User (Read-only)
      "id": "A String", # Unique identifier of User (Read-only)
    }
patch(userKey, body) 
Add a photo for the user. This method supports patch semantics.

Args:
  userKey: string, Email or immutable Id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Photo object in Directory API.
    "mimeType": "A String", # Mime Type of the photo
    "kind": "admin#directory#user#photo", # Kind of resource this is.
    "photoData": "A String", # Base64 encoded photo data
    "height": 42, # Height in pixels of the photo
    "width": 42, # Width in pixels of the photo
    "etag": "A String", # ETag of the resource.
    "primaryEmail": "A String", # Primary email of User (Read-only)
    "id": "A String", # Unique identifier of User (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Photo object in Directory API.
      "mimeType": "A String", # Mime Type of the photo
      "kind": "admin#directory#user#photo", # Kind of resource this is.
      "photoData": "A String", # Base64 encoded photo data
      "height": 42, # Height in pixels of the photo
      "width": 42, # Width in pixels of the photo
      "etag": "A String", # ETag of the resource.
      "primaryEmail": "A String", # Primary email of User (Read-only)
      "id": "A String", # Unique identifier of User (Read-only)
    }
update(userKey, body) 
Add a photo for the user

Args:
  userKey: string, Email or immutable Id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Photo object in Directory API.
    "mimeType": "A String", # Mime Type of the photo
    "kind": "admin#directory#user#photo", # Kind of resource this is.
    "photoData": "A String", # Base64 encoded photo data
    "height": 42, # Height in pixels of the photo
    "width": 42, # Width in pixels of the photo
    "etag": "A String", # ETag of the resource.
    "primaryEmail": "A String", # Primary email of User (Read-only)
    "id": "A String", # Unique identifier of User (Read-only)
  }


Returns:
  An object of the form:

    { # JSON template for Photo object in Directory API.
      "mimeType": "A String", # Mime Type of the photo
      "kind": "admin#directory#user#photo", # Kind of resource this is.
      "photoData": "A String", # Base64 encoded photo data
      "height": 42, # Height in pixels of the photo
      "width": 42, # Width in pixels of the photo
      "etag": "A String", # ETag of the resource.
      "primaryEmail": "A String", # Primary email of User (Read-only)
      "id": "A String", # Unique identifier of User (Read-only)
    }
google-api-python-client-1.5.5/docs/dyn/admin_directory_v1.verificationCodes.html000066400000000000000000000064361300622755700302110ustar00rootroot00000000000000

Admin Directory API . verificationCodes

Instance Methods

generate(userKey)

Generate new backup verification codes for the user.

invalidate(userKey)

Invalidate the current backup verification codes for the user.

list(userKey)

Returns the current set of valid backup verification codes for the specified user.

Method Details

generate(userKey) 
Generate new backup verification codes for the user.

Args:
  userKey: string, Email or immutable Id of the user (required)
invalidate(userKey) 
Invalidate the current backup verification codes for the user.

Args:
  userKey: string, Email or immutable Id of the user (required)
list(userKey) 
Returns the current set of valid backup verification codes for the specified user.

Args:
  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)

Returns:
  An object of the form:

    { # JSON response template for List verification codes operation in Directory API.
    "items": [ # A list of verification code resources.
      { # JSON template for verification codes in Directory API.
        "kind": "admin#directory#verificationCode", # The type of the resource. This is always admin#directory#verificationCode.
        "etag": "A String", # ETag of the resource.
        "userId": "A String", # The obfuscated unique ID of the user.
        "verificationCode": "A String", # A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.
      },
    ],
    "kind": "admin#directory#verificationCodesList", # The type of the resource. This is always admin#directory#verificationCodesList.
    "etag": "A String", # ETag of the resource.
  }
google-api-python-client-1.5.5/docs/dyn/admin_reports_v1.activities.html000066400000000000000000000230761300622755700264060ustar00rootroot00000000000000

Admin Reports API . activities

Instance Methods

list(userKey, applicationName, eventName=None, actorIpAddress=None, pageToken=None, filters=None, maxResults=None, startTime=None, endTime=None, customerId=None)

Retrieves a list of activities for a specific customer and application.

list_next(previous_request, previous_response)

Retrieves the next page of results.

watch(userKey, applicationName, body, startTime=None, filters=None, eventName=None, actorIpAddress=None, pageToken=None, maxResults=None, endTime=None, customerId=None)

Push changes to activities

Method Details

list(userKey, applicationName, eventName=None, actorIpAddress=None, pageToken=None, filters=None, maxResults=None, startTime=None, endTime=None, customerId=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.
  pageToken: string, Token to specify next page.
  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.
  startTime: string, Return events which occured at or after this time.
  endTime: string, Return events which occured at or before this time.
  customerId: string, Represents the customer for which the data is to be fetched.

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.
        },
        "etag": "A String", # ETag of the entry.
        "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.
              {
                "name": "A String", # The name of the parameter.
                "intValue": "A String", # Integral value of the parameter.
                "value": "A String", # String value of the parameter.
                "boolValue": True or False, # Boolean value of the parameter.
                "multiValue": [ # Multi-string value of the parameter.
                  "A String",
                ],
                "multiIntValue": [ # Multi-int value of the parameter.
                  "A String",
                ],
              },
            ],
          },
        ],
      },
    ],
    "kind": "admin#reports#activities", # Kind of list response this is.
    "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.
watch(userKey, applicationName, body, startTime=None, filters=None, eventName=None, actorIpAddress=None, pageToken=None, maxResults=None, endTime=None, customerId=None) 
Push changes to activities

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)
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  startTime: string, Return events which occured at or after this time.
  filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
  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.
  pageToken: string, Token to specify next page.
  maxResults: integer, Number of activity records to be shown in each page.
  endTime: string, Return events which occured at or before this time.
  customerId: string, Represents the customer for which the data is to be fetched.

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/admin_reports_v1.channels.html000066400000000000000000000052651300622755700260350ustar00rootroot00000000000000

Admin Reports API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/admin_reports_v1.customerUsageReports.html000066400000000000000000000112451300622755700304420ustar00rootroot00000000000000

Admin Reports API . customerUsageReports

Instance Methods

get(date, parameters=None, pageToken=None, customerId=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, parameters=None, pageToken=None, customerId=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)
  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.
  customerId: string, Represents the customer for which the data is to be fetched.

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.
    "etag": "A String", # ETag of the resource.
    "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.
        "etag": "A String", # ETag of the resource.
        "parameters": [ # Parameter value pairs for various applications.
          {
            "msgValue": [ # Nested message value of the parameter.
              {
                "a_key": "",
              },
            ],
            "name": "A String", # The name of the parameter.
            "intValue": "A String", # Integral value of the parameter.
            "boolValue": True or False, # Boolean value of the parameter.
            "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
            "stringValue": "A String", # String value 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.
google-api-python-client-1.5.5/docs/dyn/admin_reports_v1.html000066400000000000000000000051621300622755700242370ustar00rootroot00000000000000

Admin Reports API

Instance Methods

activities()

Returns the activities Resource.

channels()

Returns the channels Resource.

customerUsageReports()

Returns the customerUsageReports Resource.

userUsageReport()

Returns the userUsageReport Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/admin_reports_v1.userUsageReport.html000066400000000000000000000117731300622755700274020ustar00rootroot00000000000000

Admin Reports API . userUsageReport

Instance Methods

get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None, customerId=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, customerId=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
  customerId: string, Represents the customer for which the data is to be fetched.

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.
    "etag": "A String", # ETag of the resource.
    "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.
        "etag": "A String", # ETag of the resource.
        "parameters": [ # Parameter value pairs for various applications.
          {
            "msgValue": [ # Nested message value of the parameter.
              {
                "a_key": "",
              },
            ],
            "name": "A String", # The name of the parameter.
            "intValue": "A String", # Integral value of the parameter.
            "boolValue": True or False, # Boolean value of the parameter.
            "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
            "stringValue": "A String", # String value 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.adclients.html000066400000000000000000000066451300622755700270270ustar00rootroot00000000000000

AdSense Management API . accounts . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html000066400000000000000000000107531300622755700315500ustar00rootroot00000000000000

AdSense Management API . accounts . adunits . customchannels

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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.adunits.html000066400000000000000000000263011300622755700265170ustar00rootroot00000000000000

AdSense Management API . accounts . adunits

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) - deprecated.
      "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 - deprecated).
      "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) - deprecated.
      "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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.alerts.html000066400000000000000000000051161300622755700263430ustar00rootroot00000000000000

AdSense Management API . accounts . alerts

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html000066400000000000000000000153031300622755700315440ustar00rootroot00000000000000

AdSense Management API . accounts . customchannels . adunits

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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.customchannels.html000066400000000000000000000145701300622755700301030ustar00rootroot00000000000000

AdSense Management API . accounts . customchannels

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 (deprecated)). 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 (deprecated) 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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.html000066400000000000000000000123141300622755700250500ustar00rootroot00000000000000

AdSense Management API . accounts

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.reports.html000066400000000000000000000162731300622755700265550ustar00rootroot00000000000000

AdSense Management API . accounts . reports

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.reports.saved.html000066400000000000000000000133741300622755700276550ustar00rootroot00000000000000

AdSense Management API . accounts . reports . saved

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.savedadstyles.html000066400000000000000000000137001300622755700277220ustar00rootroot00000000000000

AdSense Management API . accounts . savedadstyles

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.accounts.urlchannels.html000066400000000000000000000070511300622755700273670ustar00rootroot00000000000000

AdSense Management API . accounts . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.adclients.html000066400000000000000000000064121300622755700252010ustar00rootroot00000000000000

AdSense Management API . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.adunits.customchannels.html000066400000000000000000000105071300622755700277270ustar00rootroot00000000000000

AdSense Management API . adunits . customchannels

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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.adunits.html000066400000000000000000000254551300622755700247120ustar00rootroot00000000000000

AdSense Management API . adunits

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) - deprecated.
      "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 - deprecated).
      "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) - deprecated.
      "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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.alerts.html000066400000000000000000000046371300622755700245340ustar00rootroot00000000000000

AdSense Management API . alerts

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.customchannels.adunits.html000066400000000000000000000150371300622755700277320ustar00rootroot00000000000000

AdSense Management API . customchannels . adunits

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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.customchannels.html000066400000000000000000000141001300622755700262520ustar00rootroot00000000000000

AdSense Management API . customchannels

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 (deprecated)). 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 (deprecated) 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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.html000066400000000000000000000065021300622755700232340ustar00rootroot00000000000000

AdSense Management API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.metadata.dimensions.html000066400000000000000000000062161300622755700271640ustar00rootroot00000000000000

AdSense Management API . metadata . dimensions

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.metadata.html000066400000000000000000000026141300622755700250130ustar00rootroot00000000000000

AdSense Management API . metadata

Instance Methods

dimensions()

Returns the dimensions Resource.

metrics()

Returns the metrics Resource.

google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.metadata.metrics.html000066400000000000000000000062021300622755700264550ustar00rootroot00000000000000

AdSense Management API . metadata . metrics

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.reports.html000066400000000000000000000162131300622755700247310ustar00rootroot00000000000000

AdSense Management API . reports

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.reports.saved.html000066400000000000000000000127421300622755700260350ustar00rootroot00000000000000

AdSense Management API . reports . saved

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.savedadstyles.html000066400000000000000000000132631300622755700261100ustar00rootroot00000000000000

AdSense Management API . savedadstyles

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_3.urlchannels.html000066400000000000000000000066141300622755700255550ustar00rootroot00000000000000

AdSense Management API . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.adclients.html000066400000000000000000000066451300622755700270300ustar00rootroot00000000000000

AdSense Management API . accounts . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.adunits.customchannels.html000066400000000000000000000107531300622755700315510ustar00rootroot00000000000000

AdSense Management API . accounts . adunits . customchannels

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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.adunits.html000066400000000000000000000263011300622755700265200ustar00rootroot00000000000000

AdSense Management API . accounts . adunits

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) - deprecated.
      "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 - deprecated).
      "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) - deprecated.
      "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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.alerts.html000066400000000000000000000062451300622755700263500ustar00rootroot00000000000000

AdSense Management API . accounts . alerts

Instance Methods

delete(accountId, alertId)

Dismiss (delete) the specified alert from the specified publisher AdSense account.

list(accountId, locale=None)

List the alerts for the specified AdSense account.

Method Details

delete(accountId, alertId) 
Dismiss (delete) the specified alert from the specified publisher AdSense account.

Args:
  accountId: string, Account which contains the ad unit. (required)
  alertId: string, Alert to delete. (required)
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.
      {
        "kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
        "severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
        "isDismissible": True or False, # Whether this alert can be dismissed.
        "message": "A String", # The localized alert message.
        "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.
        "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.
      },
    ],
    "kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.customchannels.adunits.html000066400000000000000000000153031300622755700315450ustar00rootroot00000000000000

AdSense Management API . accounts . customchannels . adunits

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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.customchannels.html000066400000000000000000000145701300622755700301040ustar00rootroot00000000000000

AdSense Management API . accounts . customchannels

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 (deprecated)). 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 (deprecated) 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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.html000066400000000000000000000130701300622755700250510ustar00rootroot00000000000000

AdSense Management API . accounts

Instance Methods

adclients()

Returns the adclients Resource.

adunits()

Returns the adunits Resource.

alerts()

Returns the alerts Resource.

customchannels()

Returns the customchannels Resource.

payments()

Returns the payments 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.
    "name": "A String", # Name of this account.
    "creation_time": "A String",
    "subAccounts": [ # Sub accounts of the this account.
      # Object with schema name: Account
    ],
    "timezone": "A String", # AdSense timezone of this account.
    "id": "A String", # Unique identifier 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.
        "name": "A String", # Name of this account.
        "creation_time": "A String",
        "subAccounts": [ # Sub accounts of the this account.
          # Object with schema name: Account
        ],
        "timezone": "A String", # AdSense timezone of this account.
        "id": "A String", # Unique identifier 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.payments.html000066400000000000000000000044361300622755700267160ustar00rootroot00000000000000

AdSense Management API . accounts . payments

Instance Methods

list(accountId)

List the payments for the specified AdSense account.

Method Details

list(accountId) 
List the payments for the specified AdSense account.

Args:
  accountId: string, Account for which to retrieve the payments. (required)

Returns:
  An object of the form:

    {
    "items": [ # The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.
      {
        "paymentAmountCurrencyCode": "A String", # The currency code for the amount to be paid.
        "kind": "adsense#payment", # Kind of resource this is, in this case adsense#payment.
        "paymentAmount": "A String", # The amount to be paid.
        "id": "A String", # Unique identifier of this Payment.
        "paymentDate": "A String", # The date this payment was/will be credited to the user, or none if the payment threshold has not been met.
      },
    ],
    "kind": "adsense#payments", # Kind of list this is, in this case adsense#payments.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.reports.html000066400000000000000000000165231300622755700265540ustar00rootroot00000000000000

AdSense Management API . accounts . reports

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:

    {
    "startDate": "A String", # The requested start date in yyyy-mm-dd format.
    "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",
      ],
    ],
    "endDate": "A String", # The requested end date in yyyy-mm-dd format.
    "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.reports.saved.html000066400000000000000000000136241300622755700276540ustar00rootroot00000000000000

AdSense Management API . accounts . reports . saved

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:

    {
    "startDate": "A String", # The requested start date in yyyy-mm-dd format.
    "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",
      ],
    ],
    "endDate": "A String", # The requested end date in yyyy-mm-dd format.
    "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.savedadstyles.html000066400000000000000000000137001300622755700277230ustar00rootroot00000000000000

AdSense Management API . accounts . savedadstyles

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.accounts.urlchannels.html000066400000000000000000000070511300622755700273700ustar00rootroot00000000000000

AdSense Management API . accounts . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.adclients.html000066400000000000000000000064121300622755700252020ustar00rootroot00000000000000

AdSense Management API . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.adunits.customchannels.html000066400000000000000000000105071300622755700277300ustar00rootroot00000000000000

AdSense Management API . adunits . customchannels

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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.adunits.html000066400000000000000000000254551300622755700247130ustar00rootroot00000000000000

AdSense Management API . adunits

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) - deprecated.
      "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 - deprecated).
      "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) - deprecated.
      "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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.alerts.html000066400000000000000000000056141300622755700245310ustar00rootroot00000000000000

AdSense Management API . alerts

Instance Methods

delete(alertId)

Dismiss (delete) the specified alert from the publisher's AdSense account.

list(locale=None)

List the alerts for this AdSense account.

Method Details

delete(alertId) 
Dismiss (delete) the specified alert from the publisher's AdSense account.

Args:
  alertId: string, Alert to delete. (required)
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.
      {
        "kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
        "severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
        "isDismissible": True or False, # Whether this alert can be dismissed.
        "message": "A String", # The localized alert message.
        "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.
        "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.
      },
    ],
    "kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.customchannels.adunits.html000066400000000000000000000150371300622755700277330ustar00rootroot00000000000000

AdSense Management API . customchannels . adunits

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) - deprecated.
          "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 - deprecated).
          "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) - deprecated.
          "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.customchannels.html000066400000000000000000000141001300622755700262530ustar00rootroot00000000000000

AdSense Management API . customchannels

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 (deprecated)). 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 (deprecated) 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 (deprecated)). 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 (deprecated) 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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.html000066400000000000000000000067331300622755700232430ustar00rootroot00000000000000

AdSense Management API

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.

payments()

Returns the payments Resource.

reports()

Returns the reports Resource.

savedadstyles()

Returns the savedadstyles Resource.

urlchannels()

Returns the urlchannels Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.metadata.dimensions.html000066400000000000000000000062161300622755700271650ustar00rootroot00000000000000

AdSense Management API . metadata . dimensions

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.metadata.html000066400000000000000000000026141300622755700250140ustar00rootroot00000000000000

AdSense Management API . metadata

Instance Methods

dimensions()

Returns the dimensions Resource.

metrics()

Returns the metrics Resource.

google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.metadata.metrics.html000066400000000000000000000062021300622755700264560ustar00rootroot00000000000000

AdSense Management API . metadata . metrics

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.payments.html000066400000000000000000000041611300622755700250730ustar00rootroot00000000000000

AdSense Management API . payments

Instance Methods

list()

List the payments for this AdSense account.

Method Details

list() 
List the payments for this AdSense account.

Args:

Returns:
  An object of the form:

    {
    "items": [ # The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.
      {
        "paymentAmountCurrencyCode": "A String", # The currency code for the amount to be paid.
        "kind": "adsense#payment", # Kind of resource this is, in this case adsense#payment.
        "paymentAmount": "A String", # The amount to be paid.
        "id": "A String", # Unique identifier of this Payment.
        "paymentDate": "A String", # The date this payment was/will be credited to the user, or none if the payment threshold has not been met.
      },
    ],
    "kind": "adsense#payments", # Kind of list this is, in this case adsense#payments.
  }
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.reports.html000066400000000000000000000164431300622755700247370ustar00rootroot00000000000000

AdSense Management API . reports

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:

    {
    "startDate": "A String", # The requested start date in yyyy-mm-dd format.
    "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",
      ],
    ],
    "endDate": "A String", # The requested end date in yyyy-mm-dd format.
    "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.reports.saved.html000066400000000000000000000131721300622755700260340ustar00rootroot00000000000000

AdSense Management API . reports . saved

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:

    {
    "startDate": "A String", # The requested start date in yyyy-mm-dd format.
    "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",
      ],
    ],
    "endDate": "A String", # The requested end date in yyyy-mm-dd format.
    "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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.savedadstyles.html000066400000000000000000000132631300622755700261110ustar00rootroot00000000000000

AdSense Management API . savedadstyles

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.
google-api-python-client-1.5.5/docs/dyn/adsense_v1_4.urlchannels.html000066400000000000000000000066141300622755700255560ustar00rootroot00000000000000

AdSense Management API . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.accounts.adclients.html000066400000000000000000000107331300622755700277170ustar00rootroot00000000000000

AdSense Host API . accounts . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.accounts.adunits.html000066400000000000000000001072251300622755700274230ustar00rootroot00000000000000

AdSense Host API . accounts . adunits

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 - deprecated).
        "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 - deprecated).
        "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 - deprecated).
        "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 - deprecated).
        "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 - deprecated).
      "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 - deprecated).
      "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 - deprecated).
        "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 - deprecated).
        "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 - deprecated).
            "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 - deprecated).
            "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 - deprecated).
      "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 - deprecated).
      "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 - deprecated).
        "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 - deprecated).
        "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 - deprecated).
      "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 - deprecated).
      "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 - deprecated).
        "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 - deprecated).
        "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.
      },
    }
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.accounts.html000066400000000000000000000065541300622755700257600ustar00rootroot00000000000000

AdSense Host API . accounts

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.
  }
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.accounts.reports.html000066400000000000000000000107531300622755700274510ustar00rootroot00000000000000

AdSense Host API . accounts . reports

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",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.adclients.html000066400000000000000000000102541300622755700260770ustar00rootroot00000000000000

AdSense Host API . adclients

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.
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.associationsessions.html000066400000000000000000000112121300622755700302270ustar00rootroot00000000000000

AdSense Host API . associationsessions

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 - deprecated
      AFS - AdSense For Search - deprecated
      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, AFG, AFV, AFS (deprecated), AFMC (deprecated)
      "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, AFG, AFV, AFS (deprecated), AFMC (deprecated)
      "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.
  }
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.customchannels.html000066400000000000000000000234631300622755700271650ustar00rootroot00000000000000

AdSense Host API . customchannels

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.
    }
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.html000066400000000000000000000056501300622755700241360ustar00rootroot00000000000000

AdSense Host API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.reports.html000066400000000000000000000105171300622755700256310ustar00rootroot00000000000000

AdSense Host API . reports

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",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/adsensehost_v4_1.urlchannels.html000066400000000000000000000132531300622755700264510ustar00rootroot00000000000000

AdSense Host API . urlchannels

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.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.data.html000066400000000000000000000055131300622755700245140ustar00rootroot00000000000000

Google Analytics API . data

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 report 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 report data for a view (profile).

Args:
  ids: string, Unique table ID for retrieving report 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 report data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
  end_date: string, End date for fetching report 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:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. (required)
  sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the report 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 the report data.
  max_results: integer, The maximum number of entries to include in this feed.
  segment: string, An Analytics advanced segment to be applied to the report 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.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.html000066400000000000000000000043601300622755700236030ustar00rootroot00000000000000

Google Analytics API

Instance Methods

data()

Returns the data Resource.

management()

Returns the management Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.management.accounts.html000066400000000000000000000033671300622755700275420ustar00rootroot00000000000000

Google Analytics API . management . accounts

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.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.management.goals.html000066400000000000000000000045221300622755700270220ustar00rootroot00000000000000

Google Analytics API . management . goals

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.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.management.html000066400000000000000000000036171300622755700257220ustar00rootroot00000000000000

Google Analytics API . management

Instance Methods

accounts()

Returns the accounts Resource.

goals()

Returns the goals Resource.

profiles()

Returns the profiles Resource.

segments()

Returns the segments Resource.

webproperties()

Returns the webproperties Resource.

google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.management.profiles.html000066400000000000000000000043141300622755700275370ustar00rootroot00000000000000

Google Analytics API . management . profiles

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 views (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.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.management.segments.html000066400000000000000000000034231300622755700275410ustar00rootroot00000000000000

Google Analytics API . management . segments

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.
google-api-python-client-1.5.5/docs/dyn/analytics_v2_4.management.webproperties.html000066400000000000000000000037241300622755700306120ustar00rootroot00000000000000

Google Analytics API . management . webproperties

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.
google-api-python-client-1.5.5/docs/dyn/analytics_v3.data.ga.html000066400000000000000000000172371300622755700246660ustar00rootroot00000000000000

Google Analytics API . data . ga

Instance Methods

get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, include_empty_rows=None, sort=None, samplingLevel=None, segment=None, start_index=None, output=None)

Returns Analytics data for a view (profile).

Method Details

get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, include_empty_rows=None, sort=None, samplingLevel=None, segment=None, start_index=None, output=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. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. (required)
  end_date: string, End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. (required)
  metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. (required)
  max_results: integer, The maximum number of entries to include in this feed.
  filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
  dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
  include_empty_rows: boolean, The response will include empty rows if this parameter is set to true, the default is true
  sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
  samplingLevel: string, The desired sampling level.
    Allowed values
      DEFAULT - Returns response with a sample size that balances speed and accuracy.
      FASTER - Returns a fast response with a smaller sample size.
      HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower.
  segment: string, An Analytics 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.
  output: string, The selected format for the response. Default format is JSON.
    Allowed values
      dataTable - Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.
      json - Returns the response in standard JSON format.

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.
    "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.
      },
    ],
    "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.
    },
    "dataTable": {
      "rows": [
        {
          "c": [
            {
              "v": "A String",
            },
          ],
        },
      ],
      "cols": [
        {
          "type": "A String",
          "id": "A String",
          "label": "A String",
        },
      ],
    },
    "sampleSize": "A String", # The number of samples used to calculate the result.
    "dataLastRefreshed": "A String", # The last refreshed time in seconds for Analytics data.
    "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",
      ],
      "samplingLevel": "A String", # Desired sampling level
      "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.
    "nextLink": "A String", # Link to next 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.
    },
    "id": "A String", # Unique ID for this data response.
    "selfLink": "A String", # Link to this page.
    "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.data.html000066400000000000000000000027641300622755700242770ustar00rootroot00000000000000

Google Analytics API . data

Instance Methods

ga()

Returns the ga Resource.

mcf()

Returns the mcf Resource.

realtime()

Returns the realtime Resource.

google-api-python-client-1.5.5/docs/dyn/analytics_v3.data.mcf.html000066400000000000000000000166211300622755700250400ustar00rootroot00000000000000

Google Analytics API . data . mcf

Instance Methods

get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, samplingLevel=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, samplingLevel=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. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. (required)
  end_date: string, End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. (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.
  samplingLevel: string, The desired sampling level.
    Allowed values
      DEFAULT - Returns response with a sample size that balances speed and accuracy.
      FASTER - Returns a fast response with a smaller sample size.
      HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower.
  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.
    "sampleSize": "A String", # The number of samples used to calculate the result.
    "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",
      ],
      "samplingLevel": "A String", # Desired sampling level
      "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.
    "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.data.realtime.html000066400000000000000000000113571300622755700260760ustar00rootroot00000000000000

Google Analytics API . data . realtime

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 real time 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 real time metrics. E.g., 'rt:activeUsers'. 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., 'rt:medium,rt: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.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.html000066400000000000000000000050501300622755700233560ustar00rootroot00000000000000

Google Analytics API

Instance Methods

data()

Returns the data Resource.

management()

Returns the management Resource.

metadata()

Returns the metadata Resource.

provisioning()

Returns the provisioning Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.accountSummaries.html000066400000000000000000000115501300622755700310140ustar00rootroot00000000000000

Google Analytics API . management . accountSummaries

Instance Methods

list(max_results=None, start_index=None)

Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

Method Details

list(max_results=None, start_index=None) 
Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

Args:
  max_results: integer, The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
  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:

    { # An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#accountSummaries", # Collection type.
    "items": [ # A list of AccountSummaries.
      { # JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.
        "starred": True or False, # Indicates whether this account is starred or not.
        "kind": "analytics#accountSummary", # Resource type for Analytics AccountSummary.
        "webProperties": [ # List of web properties under this account.
          { # JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.
            "kind": "analytics#webPropertySummary", # Resource type for Analytics WebPropertySummary.
            "name": "A String", # Web property name.
            "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
            "profiles": [ # List of profiles under this web property.
              { # JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.
                "starred": True or False, # Indicates whether this view (profile) is starred or not.
                "kind": "analytics#profileSummary", # Resource type for Analytics ProfileSummary.
                "type": "A String", # View (Profile) type. Supported types: WEB or APP.
                "id": "A String", # View (profile) ID.
                "name": "A String", # View (profile) name.
              },
            ],
            "websiteUrl": "A String", # Website url for this web property.
            "internalWebPropertyId": "A String", # Internal ID for this web property.
            "starred": True or False, # Indicates whether this web property is starred or not.
            "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          },
        ],
        "id": "A String", # Account ID.
        "name": "A String", # Account 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 AccountSummary 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 AccountSummary collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.accountUserLinks.html000066400000000000000000000434651300622755700310000ustar00rootroot00000000000000

Google Analytics API . management . accountUserLinks

Instance Methods

delete(accountId, linkId)

Removes a user from the given account.

insert(accountId, body)

Adds a new user to the given account.

list(accountId, max_results=None, start_index=None)

Lists account-user links for a given account.

update(accountId, linkId, body)

Updates permissions for an existing user on the given account.

Method Details

delete(accountId, linkId) 
Removes a user from the given account.

Args:
  accountId: string, Account ID to delete the user link for. (required)
  linkId: string, Link ID to delete the user link for. (required)
insert(accountId, body) 
Adds a new user to the given account.

Args:
  accountId: string, Account ID to create the user link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
    "kind": "analytics#entityUserLink", # Resource type for entity user link.
    "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
      "accountRef": { # JSON template for a linked account. # Account for this link.
        "kind": "analytics#accountRef", # Analytics account reference.
        "href": "A String", # Link for this account.
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "userRef": { # JSON template for a user reference. # User reference.
      "kind": "analytics#userRef",
      "email": "A String", # Email ID of this user.
      "id": "A String", # User ID.
    },
    "id": "A String", # Entity user link ID
    "selfLink": "A String", # Self link for this resource.
    "permissions": { # Permissions the user has for this entity.
      "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
        "A String",
      ],
      "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
      "kind": "analytics#entityUserLink", # Resource type for entity user link.
      "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
        "accountRef": { # JSON template for a linked account. # Account for this link.
          "kind": "analytics#accountRef", # Analytics account reference.
          "href": "A String", # Link for this account.
          "id": "A String", # Account ID.
          "name": "A String", # Account name.
        },
        "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
          "kind": "analytics#profileRef", # Analytics view (profile) reference.
          "name": "A String", # Name of this view (profile).
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
          "href": "A String", # Link for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
        },
        "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "userRef": { # JSON template for a user reference. # User reference.
        "kind": "analytics#userRef",
        "email": "A String", # Email ID of this user.
        "id": "A String", # User ID.
      },
      "id": "A String", # Entity user link ID
      "selfLink": "A String", # Self link for this resource.
      "permissions": { # Permissions the user has for this entity.
        "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
          "A String",
        ],
        "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
          "A String",
        ],
      },
    }
list(accountId, max_results=None, start_index=None) 
Lists account-user links for a given account.

Args:
  accountId: string, Account ID to retrieve the user links for. (required)
  max_results: integer, The maximum number of account-user links to include in this response.
  start_index: integer, An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.
    "kind": "analytics#entityUserLinks", # Collection type.
    "items": [ # A list of entity user links.
      { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
          "kind": "analytics#entityUserLink", # Resource type for entity user link.
          "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
            "accountRef": { # JSON template for a linked account. # Account for this link.
              "kind": "analytics#accountRef", # Analytics account reference.
              "href": "A String", # Link for this account.
              "id": "A String", # Account ID.
              "name": "A String", # Account name.
            },
            "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
              "kind": "analytics#profileRef", # Analytics view (profile) reference.
              "name": "A String", # Name of this view (profile).
              "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
              "href": "A String", # Link for this view (profile).
              "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
              "id": "A String", # View (Profile) ID.
              "accountId": "A String", # Account ID to which this view (profile) belongs.
            },
            "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
              "kind": "analytics#webPropertyRef", # Analytics web property reference.
              "name": "A String", # Name of this web property.
              "internalWebPropertyId": "A String", # Internal ID for this web property.
              "href": "A String", # Link for this web property.
              "id": "A String", # Web property ID of the form UA-XXXXX-YY.
              "accountId": "A String", # Account ID to which this web property belongs.
            },
          },
          "userRef": { # JSON template for a user reference. # User reference.
            "kind": "analytics#userRef",
            "email": "A String", # Email ID of this user.
            "id": "A String", # User ID.
          },
          "id": "A String", # Entity user link ID
          "selfLink": "A String", # Self link for this resource.
          "permissions": { # Permissions the user has for this entity.
            "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
              "A String",
            ],
            "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
              "A String",
            ],
          },
        },
    ],
    "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.
  }
update(accountId, linkId, body) 
Updates permissions for an existing user on the given account.

Args:
  accountId: string, Account ID to update the account-user link for. (required)
  linkId: string, Link ID to update the account-user link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
    "kind": "analytics#entityUserLink", # Resource type for entity user link.
    "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
      "accountRef": { # JSON template for a linked account. # Account for this link.
        "kind": "analytics#accountRef", # Analytics account reference.
        "href": "A String", # Link for this account.
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "userRef": { # JSON template for a user reference. # User reference.
      "kind": "analytics#userRef",
      "email": "A String", # Email ID of this user.
      "id": "A String", # User ID.
    },
    "id": "A String", # Entity user link ID
    "selfLink": "A String", # Self link for this resource.
    "permissions": { # Permissions the user has for this entity.
      "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
        "A String",
      ],
      "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
      "kind": "analytics#entityUserLink", # Resource type for entity user link.
      "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
        "accountRef": { # JSON template for a linked account. # Account for this link.
          "kind": "analytics#accountRef", # Analytics account reference.
          "href": "A String", # Link for this account.
          "id": "A String", # Account ID.
          "name": "A String", # Account name.
        },
        "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
          "kind": "analytics#profileRef", # Analytics view (profile) reference.
          "name": "A String", # Name of this view (profile).
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
          "href": "A String", # Link for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
        },
        "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "userRef": { # JSON template for a user reference. # User reference.
        "kind": "analytics#userRef",
        "email": "A String", # Email ID of this user.
        "id": "A String", # User ID.
      },
      "id": "A String", # Entity user link ID
      "selfLink": "A String", # Self link for this resource.
      "permissions": { # Permissions the user has for this entity.
        "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
          "A String",
        ],
        "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
          "A String",
        ],
      },
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.accounts.html000066400000000000000000000076041300622755700273160ustar00rootroot00000000000000

Google Analytics API . management . accounts

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".
        },
        "starred": True or False, # Indicates whether this account is starred or not.
        "id": "A String", # Account ID.
        "selfLink": "A String", # Link for this account.
        "permissions": { # Permissions the user has for this account.
          "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
            "A String",
          ],
        },
      },
    ],
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.customDataSources.html000066400000000000000000000113231300622755700311400ustar00rootroot00000000000000

Google Analytics API . management . customDataSources

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.
        "uploadType": "A String",
        "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".
        },
        "importBehavior": "A String",
        "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.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.customDimensions.html000066400000000000000000000366331300622755700310460ustar00rootroot00000000000000

Google Analytics API . management . customDimensions

Instance Methods

get(accountId, webPropertyId, customDimensionId)

Get a custom dimension to which the user has access.

insert(accountId, webPropertyId, body)

Create a new custom dimension.

list(accountId, webPropertyId, max_results=None, start_index=None)

Lists custom dimensions to which the user has access.

patch(accountId, webPropertyId, customDimensionId, body, ignoreCustomDataSourceLinks=None)

Updates an existing custom dimension. This method supports patch semantics.

update(accountId, webPropertyId, customDimensionId, body, ignoreCustomDataSourceLinks=None)

Updates an existing custom dimension.

Method Details

get(accountId, webPropertyId, customDimensionId) 
Get a custom dimension to which the user has access.

Args:
  accountId: string, Account ID for the custom dimension to retrieve. (required)
  webPropertyId: string, Web property ID for the custom dimension to retrieve. (required)
  customDimensionId: string, The ID of the custom dimension to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for Analytics Custom Dimension.
      "index": 42, # Index of the custom dimension.
      "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
      "name": "A String", # Name of the custom dimension.
      "created": "A String", # Time the custom dimension was created.
      "updated": "A String", # Time the custom dimension was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom dimension is active.
      "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
      "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
        "href": "A String", # Link to the property to which the custom dimension belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "id": "A String", # Custom dimension ID.
      "selfLink": "A String", # Link for the custom dimension
      "accountId": "A String", # Account ID.
    }
insert(accountId, webPropertyId, body) 
Create a new custom dimension.

Args:
  accountId: string, Account ID for the custom dimension to create. (required)
  webPropertyId: string, Web property ID for the custom dimension to create. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Custom Dimension.
    "index": 42, # Index of the custom dimension.
    "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
    "name": "A String", # Name of the custom dimension.
    "created": "A String", # Time the custom dimension was created.
    "updated": "A String", # Time the custom dimension was last modified.
    "webPropertyId": "A String", # Property ID.
    "active": True or False, # Boolean indicating whether the custom dimension is active.
    "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
    "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
      "href": "A String", # Link to the property to which the custom dimension belongs.
      "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
    },
    "id": "A String", # Custom dimension ID.
    "selfLink": "A String", # Link for the custom dimension
    "accountId": "A String", # Account ID.
  }


Returns:
  An object of the form:

    { # JSON template for Analytics Custom Dimension.
      "index": 42, # Index of the custom dimension.
      "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
      "name": "A String", # Name of the custom dimension.
      "created": "A String", # Time the custom dimension was created.
      "updated": "A String", # Time the custom dimension was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom dimension is active.
      "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
      "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
        "href": "A String", # Link to the property to which the custom dimension belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "id": "A String", # Custom dimension ID.
      "selfLink": "A String", # Link for the custom dimension
      "accountId": "A String", # Account ID.
    }
list(accountId, webPropertyId, max_results=None, start_index=None) 
Lists custom dimensions to which the user has access.

Args:
  accountId: string, Account ID for the custom dimensions to retrieve. (required)
  webPropertyId: string, Web property ID for the custom dimensions to retrieve. (required)
  max_results: integer, The maximum number of custom dimensions 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 custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#customDimensions", # Collection type.
    "items": [ # Collection of custom dimensions.
      { # JSON template for Analytics Custom Dimension.
          "index": 42, # Index of the custom dimension.
          "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
          "name": "A String", # Name of the custom dimension.
          "created": "A String", # Time the custom dimension was created.
          "updated": "A String", # Time the custom dimension was last modified.
          "webPropertyId": "A String", # Property ID.
          "active": True or False, # Boolean indicating whether the custom dimension is active.
          "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
          "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
            "href": "A String", # Link to the property to which the custom dimension belongs.
            "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
          },
          "id": "A String", # Custom dimension ID.
          "selfLink": "A String", # Link for the custom dimension
          "accountId": "A String", # Account ID.
        },
    ],
    "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 dimension 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 dimension collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
patch(accountId, webPropertyId, customDimensionId, body, ignoreCustomDataSourceLinks=None) 
Updates an existing custom dimension. This method supports patch semantics.

Args:
  accountId: string, Account ID for the custom dimension to update. (required)
  webPropertyId: string, Web property ID for the custom dimension to update. (required)
  customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Custom Dimension.
    "index": 42, # Index of the custom dimension.
    "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
    "name": "A String", # Name of the custom dimension.
    "created": "A String", # Time the custom dimension was created.
    "updated": "A String", # Time the custom dimension was last modified.
    "webPropertyId": "A String", # Property ID.
    "active": True or False, # Boolean indicating whether the custom dimension is active.
    "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
    "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
      "href": "A String", # Link to the property to which the custom dimension belongs.
      "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
    },
    "id": "A String", # Custom dimension ID.
    "selfLink": "A String", # Link for the custom dimension
    "accountId": "A String", # Account ID.
  }

  ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

Returns:
  An object of the form:

    { # JSON template for Analytics Custom Dimension.
      "index": 42, # Index of the custom dimension.
      "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
      "name": "A String", # Name of the custom dimension.
      "created": "A String", # Time the custom dimension was created.
      "updated": "A String", # Time the custom dimension was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom dimension is active.
      "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
      "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
        "href": "A String", # Link to the property to which the custom dimension belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "id": "A String", # Custom dimension ID.
      "selfLink": "A String", # Link for the custom dimension
      "accountId": "A String", # Account ID.
    }
update(accountId, webPropertyId, customDimensionId, body, ignoreCustomDataSourceLinks=None) 
Updates an existing custom dimension.

Args:
  accountId: string, Account ID for the custom dimension to update. (required)
  webPropertyId: string, Web property ID for the custom dimension to update. (required)
  customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Custom Dimension.
    "index": 42, # Index of the custom dimension.
    "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
    "name": "A String", # Name of the custom dimension.
    "created": "A String", # Time the custom dimension was created.
    "updated": "A String", # Time the custom dimension was last modified.
    "webPropertyId": "A String", # Property ID.
    "active": True or False, # Boolean indicating whether the custom dimension is active.
    "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
    "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
      "href": "A String", # Link to the property to which the custom dimension belongs.
      "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
    },
    "id": "A String", # Custom dimension ID.
    "selfLink": "A String", # Link for the custom dimension
    "accountId": "A String", # Account ID.
  }

  ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

Returns:
  An object of the form:

    { # JSON template for Analytics Custom Dimension.
      "index": 42, # Index of the custom dimension.
      "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
      "name": "A String", # Name of the custom dimension.
      "created": "A String", # Time the custom dimension was created.
      "updated": "A String", # Time the custom dimension was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom dimension is active.
      "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
      "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
        "href": "A String", # Link to the property to which the custom dimension belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "id": "A String", # Custom dimension ID.
      "selfLink": "A String", # Link for the custom dimension
      "accountId": "A String", # Account ID.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.customMetrics.html000066400000000000000000000402761300622755700303420ustar00rootroot00000000000000

Google Analytics API . management . customMetrics

Instance Methods

get(accountId, webPropertyId, customMetricId)

Get a custom metric to which the user has access.

insert(accountId, webPropertyId, body)

Create a new custom metric.

list(accountId, webPropertyId, max_results=None, start_index=None)

Lists custom metrics to which the user has access.

patch(accountId, webPropertyId, customMetricId, body, ignoreCustomDataSourceLinks=None)

Updates an existing custom metric. This method supports patch semantics.

update(accountId, webPropertyId, customMetricId, body, ignoreCustomDataSourceLinks=None)

Updates an existing custom metric.

Method Details

get(accountId, webPropertyId, customMetricId) 
Get a custom metric to which the user has access.

Args:
  accountId: string, Account ID for the custom metric to retrieve. (required)
  webPropertyId: string, Web property ID for the custom metric to retrieve. (required)
  customMetricId: string, The ID of the custom metric to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for Analytics Custom Metric.
      "index": 42, # Index of the custom metric.
      "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
      "name": "A String", # Name of the custom metric.
      "created": "A String", # Time the custom metric was created.
      "max_value": "A String", # Max value of custom metric.
      "min_value": "A String", # Min value of custom metric.
      "updated": "A String", # Time the custom metric was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom metric is active.
      "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
      "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
        "href": "A String", # Link to the property to which the custom metric belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "type": "A String", # Data type of custom metric.
      "id": "A String", # Custom metric ID.
      "selfLink": "A String", # Link for the custom metric
      "accountId": "A String", # Account ID.
    }
insert(accountId, webPropertyId, body) 
Create a new custom metric.

Args:
  accountId: string, Account ID for the custom metric to create. (required)
  webPropertyId: string, Web property ID for the custom dimension to create. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Custom Metric.
    "index": 42, # Index of the custom metric.
    "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
    "name": "A String", # Name of the custom metric.
    "created": "A String", # Time the custom metric was created.
    "max_value": "A String", # Max value of custom metric.
    "min_value": "A String", # Min value of custom metric.
    "updated": "A String", # Time the custom metric was last modified.
    "webPropertyId": "A String", # Property ID.
    "active": True or False, # Boolean indicating whether the custom metric is active.
    "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
    "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
      "href": "A String", # Link to the property to which the custom metric belongs.
      "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
    },
    "type": "A String", # Data type of custom metric.
    "id": "A String", # Custom metric ID.
    "selfLink": "A String", # Link for the custom metric
    "accountId": "A String", # Account ID.
  }


Returns:
  An object of the form:

    { # JSON template for Analytics Custom Metric.
      "index": 42, # Index of the custom metric.
      "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
      "name": "A String", # Name of the custom metric.
      "created": "A String", # Time the custom metric was created.
      "max_value": "A String", # Max value of custom metric.
      "min_value": "A String", # Min value of custom metric.
      "updated": "A String", # Time the custom metric was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom metric is active.
      "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
      "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
        "href": "A String", # Link to the property to which the custom metric belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "type": "A String", # Data type of custom metric.
      "id": "A String", # Custom metric ID.
      "selfLink": "A String", # Link for the custom metric
      "accountId": "A String", # Account ID.
    }
list(accountId, webPropertyId, max_results=None, start_index=None) 
Lists custom metrics to which the user has access.

Args:
  accountId: string, Account ID for the custom metrics to retrieve. (required)
  webPropertyId: string, Web property ID for the custom metrics to retrieve. (required)
  max_results: integer, The maximum number of custom metrics 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 custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#customMetrics", # Collection type.
    "items": [ # Collection of custom metrics.
      { # JSON template for Analytics Custom Metric.
          "index": 42, # Index of the custom metric.
          "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
          "name": "A String", # Name of the custom metric.
          "created": "A String", # Time the custom metric was created.
          "max_value": "A String", # Max value of custom metric.
          "min_value": "A String", # Min value of custom metric.
          "updated": "A String", # Time the custom metric was last modified.
          "webPropertyId": "A String", # Property ID.
          "active": True or False, # Boolean indicating whether the custom metric is active.
          "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
          "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
            "href": "A String", # Link to the property to which the custom metric belongs.
            "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
          },
          "type": "A String", # Data type of custom metric.
          "id": "A String", # Custom metric ID.
          "selfLink": "A String", # Link for the custom metric
          "accountId": "A String", # Account ID.
        },
    ],
    "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 metric 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 metric collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
patch(accountId, webPropertyId, customMetricId, body, ignoreCustomDataSourceLinks=None) 
Updates an existing custom metric. This method supports patch semantics.

Args:
  accountId: string, Account ID for the custom metric to update. (required)
  webPropertyId: string, Web property ID for the custom metric to update. (required)
  customMetricId: string, Custom metric ID for the custom metric to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Custom Metric.
    "index": 42, # Index of the custom metric.
    "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
    "name": "A String", # Name of the custom metric.
    "created": "A String", # Time the custom metric was created.
    "max_value": "A String", # Max value of custom metric.
    "min_value": "A String", # Min value of custom metric.
    "updated": "A String", # Time the custom metric was last modified.
    "webPropertyId": "A String", # Property ID.
    "active": True or False, # Boolean indicating whether the custom metric is active.
    "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
    "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
      "href": "A String", # Link to the property to which the custom metric belongs.
      "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
    },
    "type": "A String", # Data type of custom metric.
    "id": "A String", # Custom metric ID.
    "selfLink": "A String", # Link for the custom metric
    "accountId": "A String", # Account ID.
  }

  ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

Returns:
  An object of the form:

    { # JSON template for Analytics Custom Metric.
      "index": 42, # Index of the custom metric.
      "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
      "name": "A String", # Name of the custom metric.
      "created": "A String", # Time the custom metric was created.
      "max_value": "A String", # Max value of custom metric.
      "min_value": "A String", # Min value of custom metric.
      "updated": "A String", # Time the custom metric was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom metric is active.
      "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
      "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
        "href": "A String", # Link to the property to which the custom metric belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "type": "A String", # Data type of custom metric.
      "id": "A String", # Custom metric ID.
      "selfLink": "A String", # Link for the custom metric
      "accountId": "A String", # Account ID.
    }
update(accountId, webPropertyId, customMetricId, body, ignoreCustomDataSourceLinks=None) 
Updates an existing custom metric.

Args:
  accountId: string, Account ID for the custom metric to update. (required)
  webPropertyId: string, Web property ID for the custom metric to update. (required)
  customMetricId: string, Custom metric ID for the custom metric to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Custom Metric.
    "index": 42, # Index of the custom metric.
    "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
    "name": "A String", # Name of the custom metric.
    "created": "A String", # Time the custom metric was created.
    "max_value": "A String", # Max value of custom metric.
    "min_value": "A String", # Min value of custom metric.
    "updated": "A String", # Time the custom metric was last modified.
    "webPropertyId": "A String", # Property ID.
    "active": True or False, # Boolean indicating whether the custom metric is active.
    "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
    "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
      "href": "A String", # Link to the property to which the custom metric belongs.
      "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
    },
    "type": "A String", # Data type of custom metric.
    "id": "A String", # Custom metric ID.
    "selfLink": "A String", # Link for the custom metric
    "accountId": "A String", # Account ID.
  }

  ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

Returns:
  An object of the form:

    { # JSON template for Analytics Custom Metric.
      "index": 42, # Index of the custom metric.
      "kind": "analytics#customMetric", # Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
      "name": "A String", # Name of the custom metric.
      "created": "A String", # Time the custom metric was created.
      "max_value": "A String", # Max value of custom metric.
      "min_value": "A String", # Min value of custom metric.
      "updated": "A String", # Time the custom metric was last modified.
      "webPropertyId": "A String", # Property ID.
      "active": True or False, # Boolean indicating whether the custom metric is active.
      "scope": "A String", # Scope of the custom metric: HIT or PRODUCT.
      "parentLink": { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
        "href": "A String", # Link to the property to which the custom metric belongs.
        "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty".
      },
      "type": "A String", # Data type of custom metric.
      "id": "A String", # Custom metric ID.
      "selfLink": "A String", # Link for the custom metric
      "accountId": "A String", # Account ID.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.experiments.html000066400000000000000000001673151300622755700300500ustar00rootroot00000000000000

Google Analytics API . management . experiments

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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
      "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
      "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
    "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
    "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
      "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
      "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
          "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
          "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
    "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
    "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
      "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
      "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
    "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
    "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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 in (0, 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:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "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.
      "equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
      "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": True or False, # 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": "A String", # 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 in (0, 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, # An integer number in [3, 90]. 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.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.filters.html000066400000000000000000003104351300622755700271460ustar00rootroot00000000000000

Google Analytics API . management . filters

Instance Methods

delete(accountId, filterId)

Delete a filter.

get(accountId, filterId)

Returns a filters to which the user has access.

insert(accountId, body)

Create a new filter.

list(accountId, max_results=None, start_index=None)

Lists all filters for an account

patch(accountId, filterId, body)

Updates an existing filter. This method supports patch semantics.

update(accountId, filterId, body)

Updates an existing filter.

Method Details

delete(accountId, filterId) 
Delete a filter.

Args:
  accountId: string, Account ID to delete the filter for. (required)
  filterId: string, ID of the filter to be deleted. (required)

Returns:
  An object of the form:

    { # JSON template for an Analytics account filter.
      "kind": "analytics#filter", # Resource type for Analytics filter.
      "name": "A String", # Name of this filter.
      "created": "A String", # Time this filter was created.
      "uppercaseDetails": { # Details for the filter of the type UPPER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "updated": "A String", # Time this filter was last modified.
      "advancedDetails": { # Details for the filter of the type ADVANCED.
        "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractB": "A String", # Expression to extract from field B.
        "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
        "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "fieldARequired": True or False, # Indicates if field A is required to match.
        "fieldB": "A String", # Field B.
        "outputConstructor": "A String", # Expression used to construct the output value.
        "fieldBRequired": True or False, # Indicates if field B is required to match.
        "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
        "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractA": "A String", # Expression to extract from field A.
        "fieldA": "A String", # Field A.
        "outputToField": "A String", # Output field.
      },
      "lowercaseDetails": { # Details for the filter of the type LOWER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "selfLink": "A String", # Link for this filter.
      "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
        "href": "A String", # Link to the account to which this filter belongs.
        "type": "analytics#account", # Value is "analytics#account".
      },
      "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
      "id": "A String", # Filter ID.
      "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "searchString": "A String", # Term to search.
        "replaceString": "A String", # Term to replace the search term with.
        "field": "A String", # Field to use in the filter.
      },
      "accountId": "A String", # Account ID to which this filter belongs.
    }
get(accountId, filterId) 
Returns a filters to which the user has access.

Args:
  accountId: string, Account ID to retrieve filters for. (required)
  filterId: string, Filter ID to retrieve filters for. (required)

Returns:
  An object of the form:

    { # JSON template for an Analytics account filter.
      "kind": "analytics#filter", # Resource type for Analytics filter.
      "name": "A String", # Name of this filter.
      "created": "A String", # Time this filter was created.
      "uppercaseDetails": { # Details for the filter of the type UPPER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "updated": "A String", # Time this filter was last modified.
      "advancedDetails": { # Details for the filter of the type ADVANCED.
        "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractB": "A String", # Expression to extract from field B.
        "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
        "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "fieldARequired": True or False, # Indicates if field A is required to match.
        "fieldB": "A String", # Field B.
        "outputConstructor": "A String", # Expression used to construct the output value.
        "fieldBRequired": True or False, # Indicates if field B is required to match.
        "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
        "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractA": "A String", # Expression to extract from field A.
        "fieldA": "A String", # Field A.
        "outputToField": "A String", # Output field.
      },
      "lowercaseDetails": { # Details for the filter of the type LOWER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "selfLink": "A String", # Link for this filter.
      "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
        "href": "A String", # Link to the account to which this filter belongs.
        "type": "analytics#account", # Value is "analytics#account".
      },
      "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
      "id": "A String", # Filter ID.
      "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "searchString": "A String", # Term to search.
        "replaceString": "A String", # Term to replace the search term with.
        "field": "A String", # Field to use in the filter.
      },
      "accountId": "A String", # Account ID to which this filter belongs.
    }
insert(accountId, body) 
Create a new filter.

Args:
  accountId: string, Account ID to create filter for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics account filter.
    "kind": "analytics#filter", # Resource type for Analytics filter.
    "name": "A String", # Name of this filter.
    "created": "A String", # Time this filter was created.
    "uppercaseDetails": { # Details for the filter of the type UPPER.
      "field": "A String", # Field to use in the filter.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
    },
    "updated": "A String", # Time this filter was last modified.
    "advancedDetails": { # Details for the filter of the type ADVANCED.
      "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "extractB": "A String", # Expression to extract from field B.
      "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
      "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "fieldARequired": True or False, # Indicates if field A is required to match.
      "fieldB": "A String", # Field B.
      "outputConstructor": "A String", # Expression used to construct the output value.
      "fieldBRequired": True or False, # Indicates if field B is required to match.
      "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
      "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "extractA": "A String", # Expression to extract from field A.
      "fieldA": "A String", # Field A.
      "outputToField": "A String", # Output field.
    },
    "lowercaseDetails": { # Details for the filter of the type LOWER.
      "field": "A String", # Field to use in the filter.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
    },
    "selfLink": "A String", # Link for this filter.
    "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
      "kind": "analytics#filterExpression", # Kind value for filter expression
      "expressionValue": "A String", # Filter expression value
      "field": "A String", # Field to filter. Possible values:
          # - Content and Traffic
          # - PAGE_REQUEST_URI,
          # - PAGE_HOSTNAME,
          # - PAGE_TITLE,
          # - REFERRAL,
          # - COST_DATA_URI (Campaign target URL),
          # - HIT_TYPE,
          # - INTERNAL_SEARCH_TERM,
          # - INTERNAL_SEARCH_TYPE,
          # - SOURCE_PROPERTY_TRACKING_ID,
          # - Campaign or AdGroup
          # - CAMPAIGN_SOURCE,
          # - CAMPAIGN_MEDIUM,
          # - CAMPAIGN_NAME,
          # - CAMPAIGN_AD_GROUP,
          # - CAMPAIGN_TERM,
          # - CAMPAIGN_CONTENT,
          # - CAMPAIGN_CODE,
          # - CAMPAIGN_REFERRAL_PATH,
          # - E-Commerce
          # - TRANSACTION_COUNTRY,
          # - TRANSACTION_REGION,
          # - TRANSACTION_CITY,
          # - TRANSACTION_AFFILIATION (Store or order location),
          # - ITEM_NAME,
          # - ITEM_CODE,
          # - ITEM_VARIATION,
          # - TRANSACTION_ID,
          # - TRANSACTION_CURRENCY_CODE,
          # - PRODUCT_ACTION_TYPE,
          # - Audience/Users
          # - BROWSER,
          # - BROWSER_VERSION,
          # - BROWSER_SIZE,
          # - PLATFORM,
          # - PLATFORM_VERSION,
          # - LANGUAGE,
          # - SCREEN_RESOLUTION,
          # - SCREEN_COLORS,
          # - JAVA_ENABLED (Boolean Field),
          # - FLASH_VERSION,
          # - GEO_SPEED (Connection speed),
          # - VISITOR_TYPE,
          # - GEO_ORGANIZATION (ISP organization),
          # - GEO_DOMAIN,
          # - GEO_IP_ADDRESS,
          # - GEO_IP_VERSION,
          # - Location
          # - GEO_COUNTRY,
          # - GEO_REGION,
          # - GEO_CITY,
          # - Event
          # - EVENT_CATEGORY,
          # - EVENT_ACTION,
          # - EVENT_LABEL,
          # - Other
          # - CUSTOM_FIELD_1,
          # - CUSTOM_FIELD_2,
          # - USER_DEFINED_VALUE,
          # - Application
          # - APP_ID,
          # - APP_INSTALLER_ID,
          # - APP_NAME,
          # - APP_VERSION,
          # - SCREEN,
          # - IS_APP (Boolean Field),
          # - IS_FATAL_EXCEPTION (Boolean Field),
          # - EXCEPTION_DESCRIPTION,
          # - Mobile device
          # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
          # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
          # - DEVICE_CATEGORY,
          # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
          # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
          # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
          # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
          # - MOBILE_BRAND_NAME,
          # - MOBILE_MODEL_NAME,
          # - MOBILE_MARKETING_NAME,
          # - MOBILE_POINTING_METHOD,
          # - Social
          # - SOCIAL_NETWORK,
          # - SOCIAL_ACTION,
          # - SOCIAL_ACTION_TARGET,
          # - Custom dimension
          # - CUSTOM_DIMENSION (See accompanying field index),
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
      "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
    },
    "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
      "kind": "analytics#filterExpression", # Kind value for filter expression
      "expressionValue": "A String", # Filter expression value
      "field": "A String", # Field to filter. Possible values:
          # - Content and Traffic
          # - PAGE_REQUEST_URI,
          # - PAGE_HOSTNAME,
          # - PAGE_TITLE,
          # - REFERRAL,
          # - COST_DATA_URI (Campaign target URL),
          # - HIT_TYPE,
          # - INTERNAL_SEARCH_TERM,
          # - INTERNAL_SEARCH_TYPE,
          # - SOURCE_PROPERTY_TRACKING_ID,
          # - Campaign or AdGroup
          # - CAMPAIGN_SOURCE,
          # - CAMPAIGN_MEDIUM,
          # - CAMPAIGN_NAME,
          # - CAMPAIGN_AD_GROUP,
          # - CAMPAIGN_TERM,
          # - CAMPAIGN_CONTENT,
          # - CAMPAIGN_CODE,
          # - CAMPAIGN_REFERRAL_PATH,
          # - E-Commerce
          # - TRANSACTION_COUNTRY,
          # - TRANSACTION_REGION,
          # - TRANSACTION_CITY,
          # - TRANSACTION_AFFILIATION (Store or order location),
          # - ITEM_NAME,
          # - ITEM_CODE,
          # - ITEM_VARIATION,
          # - TRANSACTION_ID,
          # - TRANSACTION_CURRENCY_CODE,
          # - PRODUCT_ACTION_TYPE,
          # - Audience/Users
          # - BROWSER,
          # - BROWSER_VERSION,
          # - BROWSER_SIZE,
          # - PLATFORM,
          # - PLATFORM_VERSION,
          # - LANGUAGE,
          # - SCREEN_RESOLUTION,
          # - SCREEN_COLORS,
          # - JAVA_ENABLED (Boolean Field),
          # - FLASH_VERSION,
          # - GEO_SPEED (Connection speed),
          # - VISITOR_TYPE,
          # - GEO_ORGANIZATION (ISP organization),
          # - GEO_DOMAIN,
          # - GEO_IP_ADDRESS,
          # - GEO_IP_VERSION,
          # - Location
          # - GEO_COUNTRY,
          # - GEO_REGION,
          # - GEO_CITY,
          # - Event
          # - EVENT_CATEGORY,
          # - EVENT_ACTION,
          # - EVENT_LABEL,
          # - Other
          # - CUSTOM_FIELD_1,
          # - CUSTOM_FIELD_2,
          # - USER_DEFINED_VALUE,
          # - Application
          # - APP_ID,
          # - APP_INSTALLER_ID,
          # - APP_NAME,
          # - APP_VERSION,
          # - SCREEN,
          # - IS_APP (Boolean Field),
          # - IS_FATAL_EXCEPTION (Boolean Field),
          # - EXCEPTION_DESCRIPTION,
          # - Mobile device
          # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
          # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
          # - DEVICE_CATEGORY,
          # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
          # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
          # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
          # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
          # - MOBILE_BRAND_NAME,
          # - MOBILE_MODEL_NAME,
          # - MOBILE_MARKETING_NAME,
          # - MOBILE_POINTING_METHOD,
          # - Social
          # - SOCIAL_NETWORK,
          # - SOCIAL_ACTION,
          # - SOCIAL_ACTION_TARGET,
          # - Custom dimension
          # - CUSTOM_DIMENSION (See accompanying field index),
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
      "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
    },
    "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
      "href": "A String", # Link to the account to which this filter belongs.
      "type": "analytics#account", # Value is "analytics#account".
    },
    "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
    "id": "A String", # Filter ID.
    "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "searchString": "A String", # Term to search.
      "replaceString": "A String", # Term to replace the search term with.
      "field": "A String", # Field to use in the filter.
    },
    "accountId": "A String", # Account ID to which this filter belongs.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics account filter.
      "kind": "analytics#filter", # Resource type for Analytics filter.
      "name": "A String", # Name of this filter.
      "created": "A String", # Time this filter was created.
      "uppercaseDetails": { # Details for the filter of the type UPPER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "updated": "A String", # Time this filter was last modified.
      "advancedDetails": { # Details for the filter of the type ADVANCED.
        "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractB": "A String", # Expression to extract from field B.
        "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
        "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "fieldARequired": True or False, # Indicates if field A is required to match.
        "fieldB": "A String", # Field B.
        "outputConstructor": "A String", # Expression used to construct the output value.
        "fieldBRequired": True or False, # Indicates if field B is required to match.
        "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
        "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractA": "A String", # Expression to extract from field A.
        "fieldA": "A String", # Field A.
        "outputToField": "A String", # Output field.
      },
      "lowercaseDetails": { # Details for the filter of the type LOWER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "selfLink": "A String", # Link for this filter.
      "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
        "href": "A String", # Link to the account to which this filter belongs.
        "type": "analytics#account", # Value is "analytics#account".
      },
      "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
      "id": "A String", # Filter ID.
      "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "searchString": "A String", # Term to search.
        "replaceString": "A String", # Term to replace the search term with.
        "field": "A String", # Field to use in the filter.
      },
      "accountId": "A String", # Account ID to which this filter belongs.
    }
list(accountId, max_results=None, start_index=None) 
Lists all filters for an account

Args:
  accountId: string, Account ID to retrieve filters for. (required)
  max_results: integer, The maximum number of filters 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 filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#filters", # Collection type.
    "items": [ # A list of filters.
      { # JSON template for an Analytics account filter.
          "kind": "analytics#filter", # Resource type for Analytics filter.
          "name": "A String", # Name of this filter.
          "created": "A String", # Time this filter was created.
          "uppercaseDetails": { # Details for the filter of the type UPPER.
            "field": "A String", # Field to use in the filter.
            "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
          },
          "updated": "A String", # Time this filter was last modified.
          "advancedDetails": { # Details for the filter of the type ADVANCED.
            "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
            "extractB": "A String", # Expression to extract from field B.
            "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
            "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
            "fieldARequired": True or False, # Indicates if field A is required to match.
            "fieldB": "A String", # Field B.
            "outputConstructor": "A String", # Expression used to construct the output value.
            "fieldBRequired": True or False, # Indicates if field B is required to match.
            "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
            "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
            "extractA": "A String", # Expression to extract from field A.
            "fieldA": "A String", # Field A.
            "outputToField": "A String", # Output field.
          },
          "lowercaseDetails": { # Details for the filter of the type LOWER.
            "field": "A String", # Field to use in the filter.
            "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
          },
          "selfLink": "A String", # Link for this filter.
          "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
            "kind": "analytics#filterExpression", # Kind value for filter expression
            "expressionValue": "A String", # Filter expression value
            "field": "A String", # Field to filter. Possible values:
                # - Content and Traffic
                # - PAGE_REQUEST_URI,
                # - PAGE_HOSTNAME,
                # - PAGE_TITLE,
                # - REFERRAL,
                # - COST_DATA_URI (Campaign target URL),
                # - HIT_TYPE,
                # - INTERNAL_SEARCH_TERM,
                # - INTERNAL_SEARCH_TYPE,
                # - SOURCE_PROPERTY_TRACKING_ID,
                # - Campaign or AdGroup
                # - CAMPAIGN_SOURCE,
                # - CAMPAIGN_MEDIUM,
                # - CAMPAIGN_NAME,
                # - CAMPAIGN_AD_GROUP,
                # - CAMPAIGN_TERM,
                # - CAMPAIGN_CONTENT,
                # - CAMPAIGN_CODE,
                # - CAMPAIGN_REFERRAL_PATH,
                # - E-Commerce
                # - TRANSACTION_COUNTRY,
                # - TRANSACTION_REGION,
                # - TRANSACTION_CITY,
                # - TRANSACTION_AFFILIATION (Store or order location),
                # - ITEM_NAME,
                # - ITEM_CODE,
                # - ITEM_VARIATION,
                # - TRANSACTION_ID,
                # - TRANSACTION_CURRENCY_CODE,
                # - PRODUCT_ACTION_TYPE,
                # - Audience/Users
                # - BROWSER,
                # - BROWSER_VERSION,
                # - BROWSER_SIZE,
                # - PLATFORM,
                # - PLATFORM_VERSION,
                # - LANGUAGE,
                # - SCREEN_RESOLUTION,
                # - SCREEN_COLORS,
                # - JAVA_ENABLED (Boolean Field),
                # - FLASH_VERSION,
                # - GEO_SPEED (Connection speed),
                # - VISITOR_TYPE,
                # - GEO_ORGANIZATION (ISP organization),
                # - GEO_DOMAIN,
                # - GEO_IP_ADDRESS,
                # - GEO_IP_VERSION,
                # - Location
                # - GEO_COUNTRY,
                # - GEO_REGION,
                # - GEO_CITY,
                # - Event
                # - EVENT_CATEGORY,
                # - EVENT_ACTION,
                # - EVENT_LABEL,
                # - Other
                # - CUSTOM_FIELD_1,
                # - CUSTOM_FIELD_2,
                # - USER_DEFINED_VALUE,
                # - Application
                # - APP_ID,
                # - APP_INSTALLER_ID,
                # - APP_NAME,
                # - APP_VERSION,
                # - SCREEN,
                # - IS_APP (Boolean Field),
                # - IS_FATAL_EXCEPTION (Boolean Field),
                # - EXCEPTION_DESCRIPTION,
                # - Mobile device
                # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
                # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
                # - DEVICE_CATEGORY,
                # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
                # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
                # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
                # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
                # - MOBILE_BRAND_NAME,
                # - MOBILE_MODEL_NAME,
                # - MOBILE_MARKETING_NAME,
                # - MOBILE_POINTING_METHOD,
                # - Social
                # - SOCIAL_NETWORK,
                # - SOCIAL_ACTION,
                # - SOCIAL_ACTION_TARGET,
                # - Custom dimension
                # - CUSTOM_DIMENSION (See accompanying field index),
            "caseSensitive": True or False, # Determines if the filter is case sensitive.
            "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
            "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
          },
          "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
            "kind": "analytics#filterExpression", # Kind value for filter expression
            "expressionValue": "A String", # Filter expression value
            "field": "A String", # Field to filter. Possible values:
                # - Content and Traffic
                # - PAGE_REQUEST_URI,
                # - PAGE_HOSTNAME,
                # - PAGE_TITLE,
                # - REFERRAL,
                # - COST_DATA_URI (Campaign target URL),
                # - HIT_TYPE,
                # - INTERNAL_SEARCH_TERM,
                # - INTERNAL_SEARCH_TYPE,
                # - SOURCE_PROPERTY_TRACKING_ID,
                # - Campaign or AdGroup
                # - CAMPAIGN_SOURCE,
                # - CAMPAIGN_MEDIUM,
                # - CAMPAIGN_NAME,
                # - CAMPAIGN_AD_GROUP,
                # - CAMPAIGN_TERM,
                # - CAMPAIGN_CONTENT,
                # - CAMPAIGN_CODE,
                # - CAMPAIGN_REFERRAL_PATH,
                # - E-Commerce
                # - TRANSACTION_COUNTRY,
                # - TRANSACTION_REGION,
                # - TRANSACTION_CITY,
                # - TRANSACTION_AFFILIATION (Store or order location),
                # - ITEM_NAME,
                # - ITEM_CODE,
                # - ITEM_VARIATION,
                # - TRANSACTION_ID,
                # - TRANSACTION_CURRENCY_CODE,
                # - PRODUCT_ACTION_TYPE,
                # - Audience/Users
                # - BROWSER,
                # - BROWSER_VERSION,
                # - BROWSER_SIZE,
                # - PLATFORM,
                # - PLATFORM_VERSION,
                # - LANGUAGE,
                # - SCREEN_RESOLUTION,
                # - SCREEN_COLORS,
                # - JAVA_ENABLED (Boolean Field),
                # - FLASH_VERSION,
                # - GEO_SPEED (Connection speed),
                # - VISITOR_TYPE,
                # - GEO_ORGANIZATION (ISP organization),
                # - GEO_DOMAIN,
                # - GEO_IP_ADDRESS,
                # - GEO_IP_VERSION,
                # - Location
                # - GEO_COUNTRY,
                # - GEO_REGION,
                # - GEO_CITY,
                # - Event
                # - EVENT_CATEGORY,
                # - EVENT_ACTION,
                # - EVENT_LABEL,
                # - Other
                # - CUSTOM_FIELD_1,
                # - CUSTOM_FIELD_2,
                # - USER_DEFINED_VALUE,
                # - Application
                # - APP_ID,
                # - APP_INSTALLER_ID,
                # - APP_NAME,
                # - APP_VERSION,
                # - SCREEN,
                # - IS_APP (Boolean Field),
                # - IS_FATAL_EXCEPTION (Boolean Field),
                # - EXCEPTION_DESCRIPTION,
                # - Mobile device
                # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
                # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
                # - DEVICE_CATEGORY,
                # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
                # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
                # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
                # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
                # - MOBILE_BRAND_NAME,
                # - MOBILE_MODEL_NAME,
                # - MOBILE_MARKETING_NAME,
                # - MOBILE_POINTING_METHOD,
                # - Social
                # - SOCIAL_NETWORK,
                # - SOCIAL_ACTION,
                # - SOCIAL_ACTION_TARGET,
                # - Custom dimension
                # - CUSTOM_DIMENSION (See accompanying field index),
            "caseSensitive": True or False, # Determines if the filter is case sensitive.
            "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
            "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
          },
          "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
            "href": "A String", # Link to the account to which this filter belongs.
            "type": "analytics#account", # Value is "analytics#account".
          },
          "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
          "id": "A String", # Filter ID.
          "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
            "caseSensitive": True or False, # Determines if the filter is case sensitive.
            "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
            "searchString": "A String", # Term to search.
            "replaceString": "A String", # Term to replace the search term with.
            "field": "A String", # Field to use in the filter.
          },
          "accountId": "A String", # Account ID to which this filter 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 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
    "previousLink": "A String", # Link to previous page for this filter 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 filter collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
patch(accountId, filterId, body) 
Updates an existing filter. This method supports patch semantics.

Args:
  accountId: string, Account ID to which the filter belongs. (required)
  filterId: string, ID of the filter to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics account filter.
    "kind": "analytics#filter", # Resource type for Analytics filter.
    "name": "A String", # Name of this filter.
    "created": "A String", # Time this filter was created.
    "uppercaseDetails": { # Details for the filter of the type UPPER.
      "field": "A String", # Field to use in the filter.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
    },
    "updated": "A String", # Time this filter was last modified.
    "advancedDetails": { # Details for the filter of the type ADVANCED.
      "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "extractB": "A String", # Expression to extract from field B.
      "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
      "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "fieldARequired": True or False, # Indicates if field A is required to match.
      "fieldB": "A String", # Field B.
      "outputConstructor": "A String", # Expression used to construct the output value.
      "fieldBRequired": True or False, # Indicates if field B is required to match.
      "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
      "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "extractA": "A String", # Expression to extract from field A.
      "fieldA": "A String", # Field A.
      "outputToField": "A String", # Output field.
    },
    "lowercaseDetails": { # Details for the filter of the type LOWER.
      "field": "A String", # Field to use in the filter.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
    },
    "selfLink": "A String", # Link for this filter.
    "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
      "kind": "analytics#filterExpression", # Kind value for filter expression
      "expressionValue": "A String", # Filter expression value
      "field": "A String", # Field to filter. Possible values:
          # - Content and Traffic
          # - PAGE_REQUEST_URI,
          # - PAGE_HOSTNAME,
          # - PAGE_TITLE,
          # - REFERRAL,
          # - COST_DATA_URI (Campaign target URL),
          # - HIT_TYPE,
          # - INTERNAL_SEARCH_TERM,
          # - INTERNAL_SEARCH_TYPE,
          # - SOURCE_PROPERTY_TRACKING_ID,
          # - Campaign or AdGroup
          # - CAMPAIGN_SOURCE,
          # - CAMPAIGN_MEDIUM,
          # - CAMPAIGN_NAME,
          # - CAMPAIGN_AD_GROUP,
          # - CAMPAIGN_TERM,
          # - CAMPAIGN_CONTENT,
          # - CAMPAIGN_CODE,
          # - CAMPAIGN_REFERRAL_PATH,
          # - E-Commerce
          # - TRANSACTION_COUNTRY,
          # - TRANSACTION_REGION,
          # - TRANSACTION_CITY,
          # - TRANSACTION_AFFILIATION (Store or order location),
          # - ITEM_NAME,
          # - ITEM_CODE,
          # - ITEM_VARIATION,
          # - TRANSACTION_ID,
          # - TRANSACTION_CURRENCY_CODE,
          # - PRODUCT_ACTION_TYPE,
          # - Audience/Users
          # - BROWSER,
          # - BROWSER_VERSION,
          # - BROWSER_SIZE,
          # - PLATFORM,
          # - PLATFORM_VERSION,
          # - LANGUAGE,
          # - SCREEN_RESOLUTION,
          # - SCREEN_COLORS,
          # - JAVA_ENABLED (Boolean Field),
          # - FLASH_VERSION,
          # - GEO_SPEED (Connection speed),
          # - VISITOR_TYPE,
          # - GEO_ORGANIZATION (ISP organization),
          # - GEO_DOMAIN,
          # - GEO_IP_ADDRESS,
          # - GEO_IP_VERSION,
          # - Location
          # - GEO_COUNTRY,
          # - GEO_REGION,
          # - GEO_CITY,
          # - Event
          # - EVENT_CATEGORY,
          # - EVENT_ACTION,
          # - EVENT_LABEL,
          # - Other
          # - CUSTOM_FIELD_1,
          # - CUSTOM_FIELD_2,
          # - USER_DEFINED_VALUE,
          # - Application
          # - APP_ID,
          # - APP_INSTALLER_ID,
          # - APP_NAME,
          # - APP_VERSION,
          # - SCREEN,
          # - IS_APP (Boolean Field),
          # - IS_FATAL_EXCEPTION (Boolean Field),
          # - EXCEPTION_DESCRIPTION,
          # - Mobile device
          # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
          # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
          # - DEVICE_CATEGORY,
          # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
          # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
          # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
          # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
          # - MOBILE_BRAND_NAME,
          # - MOBILE_MODEL_NAME,
          # - MOBILE_MARKETING_NAME,
          # - MOBILE_POINTING_METHOD,
          # - Social
          # - SOCIAL_NETWORK,
          # - SOCIAL_ACTION,
          # - SOCIAL_ACTION_TARGET,
          # - Custom dimension
          # - CUSTOM_DIMENSION (See accompanying field index),
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
      "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
    },
    "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
      "kind": "analytics#filterExpression", # Kind value for filter expression
      "expressionValue": "A String", # Filter expression value
      "field": "A String", # Field to filter. Possible values:
          # - Content and Traffic
          # - PAGE_REQUEST_URI,
          # - PAGE_HOSTNAME,
          # - PAGE_TITLE,
          # - REFERRAL,
          # - COST_DATA_URI (Campaign target URL),
          # - HIT_TYPE,
          # - INTERNAL_SEARCH_TERM,
          # - INTERNAL_SEARCH_TYPE,
          # - SOURCE_PROPERTY_TRACKING_ID,
          # - Campaign or AdGroup
          # - CAMPAIGN_SOURCE,
          # - CAMPAIGN_MEDIUM,
          # - CAMPAIGN_NAME,
          # - CAMPAIGN_AD_GROUP,
          # - CAMPAIGN_TERM,
          # - CAMPAIGN_CONTENT,
          # - CAMPAIGN_CODE,
          # - CAMPAIGN_REFERRAL_PATH,
          # - E-Commerce
          # - TRANSACTION_COUNTRY,
          # - TRANSACTION_REGION,
          # - TRANSACTION_CITY,
          # - TRANSACTION_AFFILIATION (Store or order location),
          # - ITEM_NAME,
          # - ITEM_CODE,
          # - ITEM_VARIATION,
          # - TRANSACTION_ID,
          # - TRANSACTION_CURRENCY_CODE,
          # - PRODUCT_ACTION_TYPE,
          # - Audience/Users
          # - BROWSER,
          # - BROWSER_VERSION,
          # - BROWSER_SIZE,
          # - PLATFORM,
          # - PLATFORM_VERSION,
          # - LANGUAGE,
          # - SCREEN_RESOLUTION,
          # - SCREEN_COLORS,
          # - JAVA_ENABLED (Boolean Field),
          # - FLASH_VERSION,
          # - GEO_SPEED (Connection speed),
          # - VISITOR_TYPE,
          # - GEO_ORGANIZATION (ISP organization),
          # - GEO_DOMAIN,
          # - GEO_IP_ADDRESS,
          # - GEO_IP_VERSION,
          # - Location
          # - GEO_COUNTRY,
          # - GEO_REGION,
          # - GEO_CITY,
          # - Event
          # - EVENT_CATEGORY,
          # - EVENT_ACTION,
          # - EVENT_LABEL,
          # - Other
          # - CUSTOM_FIELD_1,
          # - CUSTOM_FIELD_2,
          # - USER_DEFINED_VALUE,
          # - Application
          # - APP_ID,
          # - APP_INSTALLER_ID,
          # - APP_NAME,
          # - APP_VERSION,
          # - SCREEN,
          # - IS_APP (Boolean Field),
          # - IS_FATAL_EXCEPTION (Boolean Field),
          # - EXCEPTION_DESCRIPTION,
          # - Mobile device
          # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
          # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
          # - DEVICE_CATEGORY,
          # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
          # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
          # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
          # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
          # - MOBILE_BRAND_NAME,
          # - MOBILE_MODEL_NAME,
          # - MOBILE_MARKETING_NAME,
          # - MOBILE_POINTING_METHOD,
          # - Social
          # - SOCIAL_NETWORK,
          # - SOCIAL_ACTION,
          # - SOCIAL_ACTION_TARGET,
          # - Custom dimension
          # - CUSTOM_DIMENSION (See accompanying field index),
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
      "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
    },
    "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
      "href": "A String", # Link to the account to which this filter belongs.
      "type": "analytics#account", # Value is "analytics#account".
    },
    "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
    "id": "A String", # Filter ID.
    "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "searchString": "A String", # Term to search.
      "replaceString": "A String", # Term to replace the search term with.
      "field": "A String", # Field to use in the filter.
    },
    "accountId": "A String", # Account ID to which this filter belongs.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics account filter.
      "kind": "analytics#filter", # Resource type for Analytics filter.
      "name": "A String", # Name of this filter.
      "created": "A String", # Time this filter was created.
      "uppercaseDetails": { # Details for the filter of the type UPPER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "updated": "A String", # Time this filter was last modified.
      "advancedDetails": { # Details for the filter of the type ADVANCED.
        "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractB": "A String", # Expression to extract from field B.
        "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
        "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "fieldARequired": True or False, # Indicates if field A is required to match.
        "fieldB": "A String", # Field B.
        "outputConstructor": "A String", # Expression used to construct the output value.
        "fieldBRequired": True or False, # Indicates if field B is required to match.
        "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
        "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractA": "A String", # Expression to extract from field A.
        "fieldA": "A String", # Field A.
        "outputToField": "A String", # Output field.
      },
      "lowercaseDetails": { # Details for the filter of the type LOWER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "selfLink": "A String", # Link for this filter.
      "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
        "href": "A String", # Link to the account to which this filter belongs.
        "type": "analytics#account", # Value is "analytics#account".
      },
      "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
      "id": "A String", # Filter ID.
      "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "searchString": "A String", # Term to search.
        "replaceString": "A String", # Term to replace the search term with.
        "field": "A String", # Field to use in the filter.
      },
      "accountId": "A String", # Account ID to which this filter belongs.
    }
update(accountId, filterId, body) 
Updates an existing filter.

Args:
  accountId: string, Account ID to which the filter belongs. (required)
  filterId: string, ID of the filter to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics account filter.
    "kind": "analytics#filter", # Resource type for Analytics filter.
    "name": "A String", # Name of this filter.
    "created": "A String", # Time this filter was created.
    "uppercaseDetails": { # Details for the filter of the type UPPER.
      "field": "A String", # Field to use in the filter.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
    },
    "updated": "A String", # Time this filter was last modified.
    "advancedDetails": { # Details for the filter of the type ADVANCED.
      "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "extractB": "A String", # Expression to extract from field B.
      "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
      "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "fieldARequired": True or False, # Indicates if field A is required to match.
      "fieldB": "A String", # Field B.
      "outputConstructor": "A String", # Expression used to construct the output value.
      "fieldBRequired": True or False, # Indicates if field B is required to match.
      "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
      "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "extractA": "A String", # Expression to extract from field A.
      "fieldA": "A String", # Field A.
      "outputToField": "A String", # Output field.
    },
    "lowercaseDetails": { # Details for the filter of the type LOWER.
      "field": "A String", # Field to use in the filter.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
    },
    "selfLink": "A String", # Link for this filter.
    "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
      "kind": "analytics#filterExpression", # Kind value for filter expression
      "expressionValue": "A String", # Filter expression value
      "field": "A String", # Field to filter. Possible values:
          # - Content and Traffic
          # - PAGE_REQUEST_URI,
          # - PAGE_HOSTNAME,
          # - PAGE_TITLE,
          # - REFERRAL,
          # - COST_DATA_URI (Campaign target URL),
          # - HIT_TYPE,
          # - INTERNAL_SEARCH_TERM,
          # - INTERNAL_SEARCH_TYPE,
          # - SOURCE_PROPERTY_TRACKING_ID,
          # - Campaign or AdGroup
          # - CAMPAIGN_SOURCE,
          # - CAMPAIGN_MEDIUM,
          # - CAMPAIGN_NAME,
          # - CAMPAIGN_AD_GROUP,
          # - CAMPAIGN_TERM,
          # - CAMPAIGN_CONTENT,
          # - CAMPAIGN_CODE,
          # - CAMPAIGN_REFERRAL_PATH,
          # - E-Commerce
          # - TRANSACTION_COUNTRY,
          # - TRANSACTION_REGION,
          # - TRANSACTION_CITY,
          # - TRANSACTION_AFFILIATION (Store or order location),
          # - ITEM_NAME,
          # - ITEM_CODE,
          # - ITEM_VARIATION,
          # - TRANSACTION_ID,
          # - TRANSACTION_CURRENCY_CODE,
          # - PRODUCT_ACTION_TYPE,
          # - Audience/Users
          # - BROWSER,
          # - BROWSER_VERSION,
          # - BROWSER_SIZE,
          # - PLATFORM,
          # - PLATFORM_VERSION,
          # - LANGUAGE,
          # - SCREEN_RESOLUTION,
          # - SCREEN_COLORS,
          # - JAVA_ENABLED (Boolean Field),
          # - FLASH_VERSION,
          # - GEO_SPEED (Connection speed),
          # - VISITOR_TYPE,
          # - GEO_ORGANIZATION (ISP organization),
          # - GEO_DOMAIN,
          # - GEO_IP_ADDRESS,
          # - GEO_IP_VERSION,
          # - Location
          # - GEO_COUNTRY,
          # - GEO_REGION,
          # - GEO_CITY,
          # - Event
          # - EVENT_CATEGORY,
          # - EVENT_ACTION,
          # - EVENT_LABEL,
          # - Other
          # - CUSTOM_FIELD_1,
          # - CUSTOM_FIELD_2,
          # - USER_DEFINED_VALUE,
          # - Application
          # - APP_ID,
          # - APP_INSTALLER_ID,
          # - APP_NAME,
          # - APP_VERSION,
          # - SCREEN,
          # - IS_APP (Boolean Field),
          # - IS_FATAL_EXCEPTION (Boolean Field),
          # - EXCEPTION_DESCRIPTION,
          # - Mobile device
          # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
          # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
          # - DEVICE_CATEGORY,
          # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
          # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
          # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
          # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
          # - MOBILE_BRAND_NAME,
          # - MOBILE_MODEL_NAME,
          # - MOBILE_MARKETING_NAME,
          # - MOBILE_POINTING_METHOD,
          # - Social
          # - SOCIAL_NETWORK,
          # - SOCIAL_ACTION,
          # - SOCIAL_ACTION_TARGET,
          # - Custom dimension
          # - CUSTOM_DIMENSION (See accompanying field index),
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
      "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
    },
    "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
      "kind": "analytics#filterExpression", # Kind value for filter expression
      "expressionValue": "A String", # Filter expression value
      "field": "A String", # Field to filter. Possible values:
          # - Content and Traffic
          # - PAGE_REQUEST_URI,
          # - PAGE_HOSTNAME,
          # - PAGE_TITLE,
          # - REFERRAL,
          # - COST_DATA_URI (Campaign target URL),
          # - HIT_TYPE,
          # - INTERNAL_SEARCH_TERM,
          # - INTERNAL_SEARCH_TYPE,
          # - SOURCE_PROPERTY_TRACKING_ID,
          # - Campaign or AdGroup
          # - CAMPAIGN_SOURCE,
          # - CAMPAIGN_MEDIUM,
          # - CAMPAIGN_NAME,
          # - CAMPAIGN_AD_GROUP,
          # - CAMPAIGN_TERM,
          # - CAMPAIGN_CONTENT,
          # - CAMPAIGN_CODE,
          # - CAMPAIGN_REFERRAL_PATH,
          # - E-Commerce
          # - TRANSACTION_COUNTRY,
          # - TRANSACTION_REGION,
          # - TRANSACTION_CITY,
          # - TRANSACTION_AFFILIATION (Store or order location),
          # - ITEM_NAME,
          # - ITEM_CODE,
          # - ITEM_VARIATION,
          # - TRANSACTION_ID,
          # - TRANSACTION_CURRENCY_CODE,
          # - PRODUCT_ACTION_TYPE,
          # - Audience/Users
          # - BROWSER,
          # - BROWSER_VERSION,
          # - BROWSER_SIZE,
          # - PLATFORM,
          # - PLATFORM_VERSION,
          # - LANGUAGE,
          # - SCREEN_RESOLUTION,
          # - SCREEN_COLORS,
          # - JAVA_ENABLED (Boolean Field),
          # - FLASH_VERSION,
          # - GEO_SPEED (Connection speed),
          # - VISITOR_TYPE,
          # - GEO_ORGANIZATION (ISP organization),
          # - GEO_DOMAIN,
          # - GEO_IP_ADDRESS,
          # - GEO_IP_VERSION,
          # - Location
          # - GEO_COUNTRY,
          # - GEO_REGION,
          # - GEO_CITY,
          # - Event
          # - EVENT_CATEGORY,
          # - EVENT_ACTION,
          # - EVENT_LABEL,
          # - Other
          # - CUSTOM_FIELD_1,
          # - CUSTOM_FIELD_2,
          # - USER_DEFINED_VALUE,
          # - Application
          # - APP_ID,
          # - APP_INSTALLER_ID,
          # - APP_NAME,
          # - APP_VERSION,
          # - SCREEN,
          # - IS_APP (Boolean Field),
          # - IS_FATAL_EXCEPTION (Boolean Field),
          # - EXCEPTION_DESCRIPTION,
          # - Mobile device
          # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
          # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
          # - DEVICE_CATEGORY,
          # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
          # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
          # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
          # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
          # - MOBILE_BRAND_NAME,
          # - MOBILE_MODEL_NAME,
          # - MOBILE_MARKETING_NAME,
          # - MOBILE_POINTING_METHOD,
          # - Social
          # - SOCIAL_NETWORK,
          # - SOCIAL_ACTION,
          # - SOCIAL_ACTION_TARGET,
          # - Custom dimension
          # - CUSTOM_DIMENSION (See accompanying field index),
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
      "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
    },
    "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
      "href": "A String", # Link to the account to which this filter belongs.
      "type": "analytics#account", # Value is "analytics#account".
    },
    "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
    "id": "A String", # Filter ID.
    "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
      "caseSensitive": True or False, # Determines if the filter is case sensitive.
      "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      "searchString": "A String", # Term to search.
      "replaceString": "A String", # Term to replace the search term with.
      "field": "A String", # Field to use in the filter.
    },
    "accountId": "A String", # Account ID to which this filter belongs.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics account filter.
      "kind": "analytics#filter", # Resource type for Analytics filter.
      "name": "A String", # Name of this filter.
      "created": "A String", # Time this filter was created.
      "uppercaseDetails": { # Details for the filter of the type UPPER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "updated": "A String", # Time this filter was last modified.
      "advancedDetails": { # Details for the filter of the type ADVANCED.
        "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractB": "A String", # Expression to extract from field B.
        "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression.
        "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "fieldARequired": True or False, # Indicates if field A is required to match.
        "fieldB": "A String", # Field B.
        "outputConstructor": "A String", # Expression used to construct the output value.
        "fieldBRequired": True or False, # Indicates if field B is required to match.
        "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive.
        "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "extractA": "A String", # Expression to extract from field A.
        "fieldA": "A String", # Field A.
        "outputToField": "A String", # Output field.
      },
      "lowercaseDetails": { # Details for the filter of the type LOWER.
        "field": "A String", # Field to use in the filter.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
      },
      "selfLink": "A String", # Link for this filter.
      "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE.
        "kind": "analytics#filterExpression", # Kind value for filter expression
        "expressionValue": "A String", # Filter expression value
        "field": "A String", # Field to filter. Possible values:
            # - Content and Traffic
            # - PAGE_REQUEST_URI,
            # - PAGE_HOSTNAME,
            # - PAGE_TITLE,
            # - REFERRAL,
            # - COST_DATA_URI (Campaign target URL),
            # - HIT_TYPE,
            # - INTERNAL_SEARCH_TERM,
            # - INTERNAL_SEARCH_TYPE,
            # - SOURCE_PROPERTY_TRACKING_ID,
            # - Campaign or AdGroup
            # - CAMPAIGN_SOURCE,
            # - CAMPAIGN_MEDIUM,
            # - CAMPAIGN_NAME,
            # - CAMPAIGN_AD_GROUP,
            # - CAMPAIGN_TERM,
            # - CAMPAIGN_CONTENT,
            # - CAMPAIGN_CODE,
            # - CAMPAIGN_REFERRAL_PATH,
            # - E-Commerce
            # - TRANSACTION_COUNTRY,
            # - TRANSACTION_REGION,
            # - TRANSACTION_CITY,
            # - TRANSACTION_AFFILIATION (Store or order location),
            # - ITEM_NAME,
            # - ITEM_CODE,
            # - ITEM_VARIATION,
            # - TRANSACTION_ID,
            # - TRANSACTION_CURRENCY_CODE,
            # - PRODUCT_ACTION_TYPE,
            # - Audience/Users
            # - BROWSER,
            # - BROWSER_VERSION,
            # - BROWSER_SIZE,
            # - PLATFORM,
            # - PLATFORM_VERSION,
            # - LANGUAGE,
            # - SCREEN_RESOLUTION,
            # - SCREEN_COLORS,
            # - JAVA_ENABLED (Boolean Field),
            # - FLASH_VERSION,
            # - GEO_SPEED (Connection speed),
            # - VISITOR_TYPE,
            # - GEO_ORGANIZATION (ISP organization),
            # - GEO_DOMAIN,
            # - GEO_IP_ADDRESS,
            # - GEO_IP_VERSION,
            # - Location
            # - GEO_COUNTRY,
            # - GEO_REGION,
            # - GEO_CITY,
            # - Event
            # - EVENT_CATEGORY,
            # - EVENT_ACTION,
            # - EVENT_LABEL,
            # - Other
            # - CUSTOM_FIELD_1,
            # - CUSTOM_FIELD_2,
            # - USER_DEFINED_VALUE,
            # - Application
            # - APP_ID,
            # - APP_INSTALLER_ID,
            # - APP_NAME,
            # - APP_VERSION,
            # - SCREEN,
            # - IS_APP (Boolean Field),
            # - IS_FATAL_EXCEPTION (Boolean Field),
            # - EXCEPTION_DESCRIPTION,
            # - Mobile device
            # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
            # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
            # - DEVICE_CATEGORY,
            # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
            # - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
            # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
            # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
            # - MOBILE_BRAND_NAME,
            # - MOBILE_MODEL_NAME,
            # - MOBILE_MARKETING_NAME,
            # - MOBILE_POINTING_METHOD,
            # - Social
            # - SOCIAL_NETWORK,
            # - SOCIAL_ACTION,
            # - SOCIAL_ACTION_TARGET,
            # - Custom dimension
            # - CUSTOM_DIMENSION (See accompanying field index),
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.
        "matchType": "A String", # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.
      },
      "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs.
        "href": "A String", # Link to the account to which this filter belongs.
        "type": "analytics#account", # Value is "analytics#account".
      },
      "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
      "id": "A String", # Filter ID.
      "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE.
        "caseSensitive": True or False, # Determines if the filter is case sensitive.
        "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.
        "searchString": "A String", # Term to search.
        "replaceString": "A String", # Term to replace the search term with.
        "field": "A String", # Field to use in the filter.
      },
      "accountId": "A String", # Account ID to which this filter belongs.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.goals.html000066400000000000000000001001751300622755700266010ustar00rootroot00000000000000

Google Analytics API . management . goals

Instance Methods

get(accountId, webPropertyId, profileId, goalId)

Gets a goal to which the user has access.

insert(accountId, webPropertyId, profileId, body)

Create a new goal.

list(accountId, webPropertyId, profileId, max_results=None, start_index=None)

Lists goals to which the user has access.

patch(accountId, webPropertyId, profileId, goalId, body)

Updates an existing goal. This method supports patch semantics.

update(accountId, webPropertyId, profileId, goalId, body)

Updates an existing goal.

Method Details

get(accountId, webPropertyId, profileId, goalId) 
Gets a goal to which the user has access.

Args:
  accountId: string, Account ID to retrieve the goal for. (required)
  webPropertyId: string, Web property ID to retrieve the goal for. (required)
  profileId: string, View (Profile) ID to retrieve the goal for. (required)
  goalId: string, Goal ID to retrieve the goal for. (required)

Returns:
  An object of the form:

    { # 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.
    }
insert(accountId, webPropertyId, profileId, body) 
Create a new goal.

Args:
  accountId: string, Account ID to create the goal for. (required)
  webPropertyId: string, Web property ID to create the goal for. (required)
  profileId: string, View (Profile) ID to create the goal for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # 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.
  }


Returns:
  An object of the form:

    { # 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.
    }
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.
  }
patch(accountId, webPropertyId, profileId, goalId, body) 
Updates an existing goal. This method supports patch semantics.

Args:
  accountId: string, Account ID to update the goal. (required)
  webPropertyId: string, Web property ID to update the goal. (required)
  profileId: string, View (Profile) ID to update the goal. (required)
  goalId: string, Index of the goal to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # 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.
  }


Returns:
  An object of the form:

    { # 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.
    }
update(accountId, webPropertyId, profileId, goalId, body) 
Updates an existing goal.

Args:
  accountId: string, Account ID to update the goal. (required)
  webPropertyId: string, Web property ID to update the goal. (required)
  profileId: string, View (Profile) ID to update the goal. (required)
  goalId: string, Index of the goal to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # 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.
  }


Returns:
  An object of the form:

    { # 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.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.html000066400000000000000000000106561300622755700255010ustar00rootroot00000000000000

Google Analytics API . management

Instance Methods

accountSummaries()

Returns the accountSummaries Resource.

accountUserLinks()

Returns the accountUserLinks Resource.

accounts()

Returns the accounts Resource.

customDataSources()

Returns the customDataSources Resource.

customDimensions()

Returns the customDimensions Resource.

customMetrics()

Returns the customMetrics Resource.

experiments()

Returns the experiments Resource.

filters()

Returns the filters Resource.

goals()

Returns the goals Resource.

profileFilterLinks()

Returns the profileFilterLinks Resource.

profileUserLinks()

Returns the profileUserLinks Resource.

profiles()

Returns the profiles Resource.

remarketingAudience()

Returns the remarketingAudience Resource.

segments()

Returns the segments Resource.

unsampledReports()

Returns the unsampledReports Resource.

uploads()

Returns the uploads Resource.

webPropertyAdWordsLinks()

Returns the webPropertyAdWordsLinks Resource.

webproperties()

Returns the webproperties Resource.

webpropertyUserLinks()

Returns the webpropertyUserLinks Resource.

google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.profileFilterLinks.html000066400000000000000000000566151300622755700313140ustar00rootroot00000000000000

Google Analytics API . management . profileFilterLinks

Instance Methods

delete(accountId, webPropertyId, profileId, linkId)

Delete a profile filter link.

get(accountId, webPropertyId, profileId, linkId)

Returns a single profile filter link.

insert(accountId, webPropertyId, profileId, body)

Create a new profile filter link.

list(accountId, webPropertyId, profileId, max_results=None, start_index=None)

Lists all profile filter links for a profile.

patch(accountId, webPropertyId, profileId, linkId, body)

Update an existing profile filter link. This method supports patch semantics.

update(accountId, webPropertyId, profileId, linkId, body)

Update an existing profile filter link.

Method Details

delete(accountId, webPropertyId, profileId, linkId) 
Delete a profile filter link.

Args:
  accountId: string, Account ID to which the profile filter link belongs. (required)
  webPropertyId: string, Web property Id to which the profile filter link belongs. (required)
  profileId: string, Profile ID to which the filter link belongs. (required)
  linkId: string, ID of the profile filter link to delete. (required)
get(accountId, webPropertyId, profileId, linkId) 
Returns a single profile filter link.

Args:
  accountId: string, Account ID to retrieve profile filter link for. (required)
  webPropertyId: string, Web property Id to retrieve profile filter link for. (required)
  profileId: string, Profile ID to retrieve filter link for. (required)
  linkId: string, ID of the profile filter link. (required)

Returns:
  An object of the form:

    { # JSON template for an Analytics profile filter link.
      "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
      "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
          # For readonly (i.e., list and get) operations, the rank always starts at 1.
          # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
      "filterRef": { # JSON template for a profile filter link. # Filter for this link.
        "kind": "analytics#filterRef", # Kind value for filter reference.
        "href": "A String", # Link for this filter.
        "id": "A String", # Filter ID.
        "name": "A String", # Name of this filter.
        "accountId": "A String", # Account ID to which this filter belongs.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "id": "A String", # Profile filter link ID.
      "selfLink": "A String", # Link for this profile filter link.
    }
insert(accountId, webPropertyId, profileId, body) 
Create a new profile filter link.

Args:
  accountId: string, Account ID to create profile filter link for. (required)
  webPropertyId: string, Web property Id to create profile filter link for. (required)
  profileId: string, Profile ID to create filter link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics profile filter link.
    "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
    "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
        # For readonly (i.e., list and get) operations, the rank always starts at 1.
        # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
    "filterRef": { # JSON template for a profile filter link. # Filter for this link.
      "kind": "analytics#filterRef", # Kind value for filter reference.
      "href": "A String", # Link for this filter.
      "id": "A String", # Filter ID.
      "name": "A String", # Name of this filter.
      "accountId": "A String", # Account ID to which this filter belongs.
    },
    "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
      "kind": "analytics#profileRef", # Analytics view (profile) reference.
      "name": "A String", # Name of this view (profile).
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
      "href": "A String", # Link for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
    },
    "id": "A String", # Profile filter link ID.
    "selfLink": "A String", # Link for this profile filter link.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics profile filter link.
      "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
      "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
          # For readonly (i.e., list and get) operations, the rank always starts at 1.
          # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
      "filterRef": { # JSON template for a profile filter link. # Filter for this link.
        "kind": "analytics#filterRef", # Kind value for filter reference.
        "href": "A String", # Link for this filter.
        "id": "A String", # Filter ID.
        "name": "A String", # Name of this filter.
        "accountId": "A String", # Account ID to which this filter belongs.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "id": "A String", # Profile filter link ID.
      "selfLink": "A String", # Link for this profile filter link.
    }
list(accountId, webPropertyId, profileId, max_results=None, start_index=None) 
Lists all profile filter links for a profile.

Args:
  accountId: string, Account ID to retrieve profile filter links for. (required)
  webPropertyId: string, Web property Id for profile filter links 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, Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)
  max_results: integer, The maximum number of profile filter links 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 profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#profileFilterLinks", # Collection type.
    "items": [ # A list of profile filter links.
      { # JSON template for an Analytics profile filter link.
          "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
          "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
              # For readonly (i.e., list and get) operations, the rank always starts at 1.
              # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
          "filterRef": { # JSON template for a profile filter link. # Filter for this link.
            "kind": "analytics#filterRef", # Kind value for filter reference.
            "href": "A String", # Link for this filter.
            "id": "A String", # Filter ID.
            "name": "A String", # Name of this filter.
            "accountId": "A String", # Account ID to which this filter belongs.
          },
          "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
            "kind": "analytics#profileRef", # Analytics view (profile) reference.
            "name": "A String", # Name of this view (profile).
            "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
            "href": "A String", # Link for this view (profile).
            "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
            "id": "A String", # View (Profile) ID.
            "accountId": "A String", # Account ID to which this view (profile) belongs.
          },
          "id": "A String", # Profile filter link ID.
          "selfLink": "A String", # Link for this profile filter link.
        },
    ],
    "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 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
    "previousLink": "A String", # Link to previous page for this profile filter link collection.
    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
    "nextLink": "A String", # Link to next page for this profile filter link collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
patch(accountId, webPropertyId, profileId, linkId, body) 
Update an existing profile filter link. This method supports patch semantics.

Args:
  accountId: string, Account ID to which profile filter link belongs. (required)
  webPropertyId: string, Web property Id to which profile filter link belongs (required)
  profileId: string, Profile ID to which filter link belongs (required)
  linkId: string, ID of the profile filter link to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics profile filter link.
    "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
    "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
        # For readonly (i.e., list and get) operations, the rank always starts at 1.
        # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
    "filterRef": { # JSON template for a profile filter link. # Filter for this link.
      "kind": "analytics#filterRef", # Kind value for filter reference.
      "href": "A String", # Link for this filter.
      "id": "A String", # Filter ID.
      "name": "A String", # Name of this filter.
      "accountId": "A String", # Account ID to which this filter belongs.
    },
    "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
      "kind": "analytics#profileRef", # Analytics view (profile) reference.
      "name": "A String", # Name of this view (profile).
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
      "href": "A String", # Link for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
    },
    "id": "A String", # Profile filter link ID.
    "selfLink": "A String", # Link for this profile filter link.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics profile filter link.
      "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
      "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
          # For readonly (i.e., list and get) operations, the rank always starts at 1.
          # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
      "filterRef": { # JSON template for a profile filter link. # Filter for this link.
        "kind": "analytics#filterRef", # Kind value for filter reference.
        "href": "A String", # Link for this filter.
        "id": "A String", # Filter ID.
        "name": "A String", # Name of this filter.
        "accountId": "A String", # Account ID to which this filter belongs.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "id": "A String", # Profile filter link ID.
      "selfLink": "A String", # Link for this profile filter link.
    }
update(accountId, webPropertyId, profileId, linkId, body) 
Update an existing profile filter link.

Args:
  accountId: string, Account ID to which profile filter link belongs. (required)
  webPropertyId: string, Web property Id to which profile filter link belongs (required)
  profileId: string, Profile ID to which filter link belongs (required)
  linkId: string, ID of the profile filter link to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics profile filter link.
    "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
    "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
        # For readonly (i.e., list and get) operations, the rank always starts at 1.
        # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
    "filterRef": { # JSON template for a profile filter link. # Filter for this link.
      "kind": "analytics#filterRef", # Kind value for filter reference.
      "href": "A String", # Link for this filter.
      "id": "A String", # Filter ID.
      "name": "A String", # Name of this filter.
      "accountId": "A String", # Account ID to which this filter belongs.
    },
    "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
      "kind": "analytics#profileRef", # Analytics view (profile) reference.
      "name": "A String", # Name of this view (profile).
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
      "href": "A String", # Link for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
    },
    "id": "A String", # Profile filter link ID.
    "selfLink": "A String", # Link for this profile filter link.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics profile filter link.
      "kind": "analytics#profileFilterLink", # Resource type for Analytics filter.
      "rank": 42, # The rank of this profile filter link relative to the other filters linked to the same profile.
          # For readonly (i.e., list and get) operations, the rank always starts at 1.
          # For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.
      "filterRef": { # JSON template for a profile filter link. # Filter for this link.
        "kind": "analytics#filterRef", # Kind value for filter reference.
        "href": "A String", # Link for this filter.
        "id": "A String", # Filter ID.
        "name": "A String", # Name of this filter.
        "accountId": "A String", # Account ID to which this filter belongs.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "id": "A String", # Profile filter link ID.
      "selfLink": "A String", # Link for this profile filter link.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.profileUserLinks.html000066400000000000000000000456561300622755700310100ustar00rootroot00000000000000

Google Analytics API . management . profileUserLinks

Instance Methods

delete(accountId, webPropertyId, profileId, linkId)

Removes a user from the given view (profile).

insert(accountId, webPropertyId, profileId, body)

Adds a new user to the given view (profile).

list(accountId, webPropertyId, profileId, max_results=None, start_index=None)

Lists profile-user links for a given view (profile).

update(accountId, webPropertyId, profileId, linkId, body)

Updates permissions for an existing user on the given view (profile).

Method Details

delete(accountId, webPropertyId, profileId, linkId) 
Removes a user from the given view (profile).

Args:
  accountId: string, Account ID to delete the user link for. (required)
  webPropertyId: string, Web Property ID to delete the user link for. (required)
  profileId: string, View (Profile) ID to delete the user link for. (required)
  linkId: string, Link ID to delete the user link for. (required)
insert(accountId, webPropertyId, profileId, body) 
Adds a new user to the given view (profile).

Args:
  accountId: string, Account ID to create the user link for. (required)
  webPropertyId: string, Web Property ID to create the user link for. (required)
  profileId: string, View (Profile) ID to create the user link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
    "kind": "analytics#entityUserLink", # Resource type for entity user link.
    "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
      "accountRef": { # JSON template for a linked account. # Account for this link.
        "kind": "analytics#accountRef", # Analytics account reference.
        "href": "A String", # Link for this account.
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "userRef": { # JSON template for a user reference. # User reference.
      "kind": "analytics#userRef",
      "email": "A String", # Email ID of this user.
      "id": "A String", # User ID.
    },
    "id": "A String", # Entity user link ID
    "selfLink": "A String", # Self link for this resource.
    "permissions": { # Permissions the user has for this entity.
      "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
        "A String",
      ],
      "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
      "kind": "analytics#entityUserLink", # Resource type for entity user link.
      "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
        "accountRef": { # JSON template for a linked account. # Account for this link.
          "kind": "analytics#accountRef", # Analytics account reference.
          "href": "A String", # Link for this account.
          "id": "A String", # Account ID.
          "name": "A String", # Account name.
        },
        "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
          "kind": "analytics#profileRef", # Analytics view (profile) reference.
          "name": "A String", # Name of this view (profile).
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
          "href": "A String", # Link for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
        },
        "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "userRef": { # JSON template for a user reference. # User reference.
        "kind": "analytics#userRef",
        "email": "A String", # Email ID of this user.
        "id": "A String", # User ID.
      },
      "id": "A String", # Entity user link ID
      "selfLink": "A String", # Self link for this resource.
      "permissions": { # Permissions the user has for this entity.
        "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
          "A String",
        ],
        "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
          "A String",
        ],
      },
    }
list(accountId, webPropertyId, profileId, max_results=None, start_index=None) 
Lists profile-user links for a given view (profile).

Args:
  accountId: string, Account ID which the given view (profile) belongs to. (required)
  webPropertyId: string, Web Property ID which the given view (profile) belongs to. 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 the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)
  max_results: integer, The maximum number of profile-user links to include in this response.
  start_index: integer, An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.
    "kind": "analytics#entityUserLinks", # Collection type.
    "items": [ # A list of entity user links.
      { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
          "kind": "analytics#entityUserLink", # Resource type for entity user link.
          "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
            "accountRef": { # JSON template for a linked account. # Account for this link.
              "kind": "analytics#accountRef", # Analytics account reference.
              "href": "A String", # Link for this account.
              "id": "A String", # Account ID.
              "name": "A String", # Account name.
            },
            "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
              "kind": "analytics#profileRef", # Analytics view (profile) reference.
              "name": "A String", # Name of this view (profile).
              "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
              "href": "A String", # Link for this view (profile).
              "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
              "id": "A String", # View (Profile) ID.
              "accountId": "A String", # Account ID to which this view (profile) belongs.
            },
            "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
              "kind": "analytics#webPropertyRef", # Analytics web property reference.
              "name": "A String", # Name of this web property.
              "internalWebPropertyId": "A String", # Internal ID for this web property.
              "href": "A String", # Link for this web property.
              "id": "A String", # Web property ID of the form UA-XXXXX-YY.
              "accountId": "A String", # Account ID to which this web property belongs.
            },
          },
          "userRef": { # JSON template for a user reference. # User reference.
            "kind": "analytics#userRef",
            "email": "A String", # Email ID of this user.
            "id": "A String", # User ID.
          },
          "id": "A String", # Entity user link ID
          "selfLink": "A String", # Self link for this resource.
          "permissions": { # Permissions the user has for this entity.
            "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
              "A String",
            ],
            "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
              "A String",
            ],
          },
        },
    ],
    "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.
  }
update(accountId, webPropertyId, profileId, linkId, body) 
Updates permissions for an existing user on the given view (profile).

Args:
  accountId: string, Account ID to update the user link for. (required)
  webPropertyId: string, Web Property ID to update the user link for. (required)
  profileId: string, View (Profile ID) to update the user link for. (required)
  linkId: string, Link ID to update the user link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
    "kind": "analytics#entityUserLink", # Resource type for entity user link.
    "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
      "accountRef": { # JSON template for a linked account. # Account for this link.
        "kind": "analytics#accountRef", # Analytics account reference.
        "href": "A String", # Link for this account.
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "userRef": { # JSON template for a user reference. # User reference.
      "kind": "analytics#userRef",
      "email": "A String", # Email ID of this user.
      "id": "A String", # User ID.
    },
    "id": "A String", # Entity user link ID
    "selfLink": "A String", # Self link for this resource.
    "permissions": { # Permissions the user has for this entity.
      "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
        "A String",
      ],
      "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
      "kind": "analytics#entityUserLink", # Resource type for entity user link.
      "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
        "accountRef": { # JSON template for a linked account. # Account for this link.
          "kind": "analytics#accountRef", # Analytics account reference.
          "href": "A String", # Link for this account.
          "id": "A String", # Account ID.
          "name": "A String", # Account name.
        },
        "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
          "kind": "analytics#profileRef", # Analytics view (profile) reference.
          "name": "A String", # Name of this view (profile).
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
          "href": "A String", # Link for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
        },
        "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "userRef": { # JSON template for a user reference. # User reference.
        "kind": "analytics#userRef",
        "email": "A String", # Email ID of this user.
        "id": "A String", # User ID.
      },
      "id": "A String", # Entity user link ID
      "selfLink": "A String", # Self link for this resource.
      "permissions": { # Permissions the user has for this entity.
        "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
          "A String",
        ],
        "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
          "A String",
        ],
      },
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.profiles.html000066400000000000000000001045021300622755700273150ustar00rootroot00000000000000

Google Analytics API . management . profiles

Instance Methods

delete(accountId, webPropertyId, profileId)

Deletes a view (profile).

get(accountId, webPropertyId, profileId)

Gets a view (profile) to which the user has access.

insert(accountId, webPropertyId, body)

Create a new view (profile).

list(accountId, webPropertyId, max_results=None, start_index=None)

Lists views (profiles) to which the user has access.

patch(accountId, webPropertyId, profileId, body)

Updates an existing view (profile). This method supports patch semantics.

update(accountId, webPropertyId, profileId, body)

Updates an existing view (profile).

Method Details

delete(accountId, webPropertyId, profileId) 
Deletes a view (profile).

Args:
  accountId: string, Account ID to delete the view (profile) for. (required)
  webPropertyId: string, Web property ID to delete the view (profile) for. (required)
  profileId: string, ID of the view (profile) to be deleted. (required)
get(accountId, webPropertyId, profileId) 
Gets a view (profile) to which the user has access.

Args:
  accountId: string, Account ID to retrieve the view (profile) for. (required)
  webPropertyId: string, Web property ID to retrieve the view (profile) for. (required)
  profileId: string, View (Profile) ID to retrieve the view (profile) for. (required)

Returns:
  An object of the form:

    { # JSON template for an Analytics view (profile).
      "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
          # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
      "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
      "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
      "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
      "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
      "type": "A String", # View (Profile) type. Supported types: WEB or APP.
      "updated": "A String", # Time this view (profile) was last modified.
      "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
      },
      "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
      "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".
      },
      "permissions": { # Permissions the user has for this view (profile).
        "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
          "A String",
        ],
      },
      "defaultPage": "A String", # Default page for this view (profile).
      "kind": "analytics#profile", # Resource type for Analytics view (profile).
      "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
      "name": "A String", # Name of this view (profile).
      "created": "A String", # Time this view (profile) was created.
      "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
      "websiteUrl": "A String", # Website URL for this view (profile).
      "starred": True or False, # Indicates whether this view (profile) is starred or not.
      "selfLink": "A String", # Link for this view (profile).
    }
insert(accountId, webPropertyId, body) 
Create a new view (profile).

Args:
  accountId: string, Account ID to create the view (profile) for. (required)
  webPropertyId: string, Web property ID to create the view (profile) for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics view (profile).
    "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
        # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
    "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
    "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
    "id": "A String", # View (Profile) ID.
    "accountId": "A String", # Account ID to which this view (profile) belongs.
    "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
    "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
    "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
    "type": "A String", # View (Profile) type. Supported types: WEB or APP.
    "updated": "A String", # Time this view (profile) was last modified.
    "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
    },
    "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
    "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".
    },
    "permissions": { # Permissions the user has for this view (profile).
      "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
        "A String",
      ],
    },
    "defaultPage": "A String", # Default page for this view (profile).
    "kind": "analytics#profile", # Resource type for Analytics view (profile).
    "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
    "name": "A String", # Name of this view (profile).
    "created": "A String", # Time this view (profile) was created.
    "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
    "websiteUrl": "A String", # Website URL for this view (profile).
    "starred": True or False, # Indicates whether this view (profile) is starred or not.
    "selfLink": "A String", # Link for this view (profile).
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics view (profile).
      "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
          # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
      "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
      "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
      "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
      "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
      "type": "A String", # View (Profile) type. Supported types: WEB or APP.
      "updated": "A String", # Time this view (profile) was last modified.
      "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
      },
      "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
      "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".
      },
      "permissions": { # Permissions the user has for this view (profile).
        "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
          "A String",
        ],
      },
      "defaultPage": "A String", # Default page for this view (profile).
      "kind": "analytics#profile", # Resource type for Analytics view (profile).
      "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
      "name": "A String", # Name of this view (profile).
      "created": "A String", # Time this view (profile) was created.
      "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
      "websiteUrl": "A String", # Website URL for this view (profile).
      "starred": True or False, # Indicates whether this view (profile) is starred or not.
      "selfLink": "A String", # Link for this view (profile).
    }
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).
          "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
              # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
          "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
          "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
          "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
          "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
          "type": "A String", # View (Profile) type. Supported types: WEB or APP.
          "updated": "A String", # Time this view (profile) was last modified.
          "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
          },
          "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
          "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".
          },
          "permissions": { # Permissions the user has for this view (profile).
            "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
              "A String",
            ],
          },
          "defaultPage": "A String", # Default page for this view (profile).
          "kind": "analytics#profile", # Resource type for Analytics view (profile).
          "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
          "name": "A String", # Name of this view (profile).
          "created": "A String", # Time this view (profile) was created.
          "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
          "websiteUrl": "A String", # Website URL for this view (profile).
          "starred": True or False, # Indicates whether this view (profile) is starred or not.
          "selfLink": "A String", # Link for this view (profile).
        },
    ],
    "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.
  }
patch(accountId, webPropertyId, profileId, body) 
Updates an existing view (profile). This method supports patch semantics.

Args:
  accountId: string, Account ID to which the view (profile) belongs (required)
  webPropertyId: string, Web property ID to which the view (profile) belongs (required)
  profileId: string, ID of the view (profile) to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics view (profile).
    "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
        # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
    "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
    "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
    "id": "A String", # View (Profile) ID.
    "accountId": "A String", # Account ID to which this view (profile) belongs.
    "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
    "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
    "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
    "type": "A String", # View (Profile) type. Supported types: WEB or APP.
    "updated": "A String", # Time this view (profile) was last modified.
    "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
    },
    "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
    "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".
    },
    "permissions": { # Permissions the user has for this view (profile).
      "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
        "A String",
      ],
    },
    "defaultPage": "A String", # Default page for this view (profile).
    "kind": "analytics#profile", # Resource type for Analytics view (profile).
    "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
    "name": "A String", # Name of this view (profile).
    "created": "A String", # Time this view (profile) was created.
    "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
    "websiteUrl": "A String", # Website URL for this view (profile).
    "starred": True or False, # Indicates whether this view (profile) is starred or not.
    "selfLink": "A String", # Link for this view (profile).
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics view (profile).
      "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
          # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
      "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
      "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
      "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
      "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
      "type": "A String", # View (Profile) type. Supported types: WEB or APP.
      "updated": "A String", # Time this view (profile) was last modified.
      "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
      },
      "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
      "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".
      },
      "permissions": { # Permissions the user has for this view (profile).
        "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
          "A String",
        ],
      },
      "defaultPage": "A String", # Default page for this view (profile).
      "kind": "analytics#profile", # Resource type for Analytics view (profile).
      "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
      "name": "A String", # Name of this view (profile).
      "created": "A String", # Time this view (profile) was created.
      "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
      "websiteUrl": "A String", # Website URL for this view (profile).
      "starred": True or False, # Indicates whether this view (profile) is starred or not.
      "selfLink": "A String", # Link for this view (profile).
    }
update(accountId, webPropertyId, profileId, body) 
Updates an existing view (profile).

Args:
  accountId: string, Account ID to which the view (profile) belongs (required)
  webPropertyId: string, Web property ID to which the view (profile) belongs (required)
  profileId: string, ID of the view (profile) to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics view (profile).
    "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
        # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
    "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
    "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
    "id": "A String", # View (Profile) ID.
    "accountId": "A String", # Account ID to which this view (profile) belongs.
    "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
    "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
    "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
    "type": "A String", # View (Profile) type. Supported types: WEB or APP.
    "updated": "A String", # Time this view (profile) was last modified.
    "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
    },
    "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
    "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".
    },
    "permissions": { # Permissions the user has for this view (profile).
      "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
        "A String",
      ],
    },
    "defaultPage": "A String", # Default page for this view (profile).
    "kind": "analytics#profile", # Resource type for Analytics view (profile).
    "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
    "name": "A String", # Name of this view (profile).
    "created": "A String", # Time this view (profile) was created.
    "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
    "websiteUrl": "A String", # Website URL for this view (profile).
    "starred": True or False, # Indicates whether this view (profile) is starred or not.
    "selfLink": "A String", # Link for this view (profile).
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics view (profile).
      "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
          # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
      "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
      "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
      "id": "A String", # View (Profile) ID.
      "accountId": "A String", # Account ID to which this view (profile) belongs.
      "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
      "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
      "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
      "type": "A String", # View (Profile) type. Supported types: WEB or APP.
      "updated": "A String", # Time this view (profile) was last modified.
      "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
      },
      "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
      "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".
      },
      "permissions": { # Permissions the user has for this view (profile).
        "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
          "A String",
        ],
      },
      "defaultPage": "A String", # Default page for this view (profile).
      "kind": "analytics#profile", # Resource type for Analytics view (profile).
      "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
      "name": "A String", # Name of this view (profile).
      "created": "A String", # Time this view (profile) was created.
      "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
      "websiteUrl": "A String", # Website URL for this view (profile).
      "starred": True or False, # Indicates whether this view (profile) is starred or not.
      "selfLink": "A String", # Link for this view (profile).
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.remarketingAudience.html000066400000000000000000001321011300622755700314340ustar00rootroot00000000000000

Google Analytics API . management . remarketingAudience

Instance Methods

get(accountId, webPropertyId, remarketingAudienceId)

Gets a remarketing audience to which the user has access.

insert(accountId, webPropertyId, body)

Creates a new remarketing audience.

list(accountId, webPropertyId, max_results=None, type=None, start_index=None)

Lists remarketing audiences to which the user has access.

patch(accountId, webPropertyId, remarketingAudienceId, body)

Updates an existing remarketing audience. This method supports patch semantics.

update(accountId, webPropertyId, remarketingAudienceId, body)

Updates an existing remarketing audience.

Method Details

get(accountId, webPropertyId, remarketingAudienceId) 
Gets a remarketing audience to which the user has access.

Args:
  accountId: string, The account ID of the remarketing audience to retrieve. (required)
  webPropertyId: string, The web property ID of the remarketing audience to retrieve. (required)
  remarketingAudienceId: string, The ID of the remarketing audience to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for an Analytics remarketing audience.
      "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
        { # JSON template for an Analytics Remarketing Audience Foreign Link.
          "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
          "status": "A String", # The status of this foreign account link.
          "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
          "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
          "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
          "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
          "id": "A String", # Entity ad account link ID.
          "accountId": "A String", # Account ID to which this linked foreign account belongs.
        },
      ],
      "kind": "analytics#remarketingAudience", # Collection type.
      "description": "A String", # The description of this remarketing audience.
      "created": "A String", # Time this remarketing audience was created.
      "updated": "A String", # Time this remarketing audience was last modified.
      "name": "A String", # The name of this remarketing audience.
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
      "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
        "A String",
      ],
      "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
        "excludeConditions": { # Defines the conditions to exclude users from the audience.
          "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
          "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
        },
      },
      "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
      "accountId": "A String", # Account ID to which this remarketing audience belongs.
      "id": "A String", # Remarketing Audience ID.
      "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
      },
    }
insert(accountId, webPropertyId, body) 
Creates a new remarketing audience.

Args:
  accountId: string, The account ID for which to create the remarketing audience. (required)
  webPropertyId: string, Web property ID for which to create the remarketing audience. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics remarketing audience.
    "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
      { # JSON template for an Analytics Remarketing Audience Foreign Link.
        "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
        "status": "A String", # The status of this foreign account link.
        "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
        "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
        "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
        "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
        "id": "A String", # Entity ad account link ID.
        "accountId": "A String", # Account ID to which this linked foreign account belongs.
      },
    ],
    "kind": "analytics#remarketingAudience", # Collection type.
    "description": "A String", # The description of this remarketing audience.
    "created": "A String", # Time this remarketing audience was created.
    "updated": "A String", # Time this remarketing audience was last modified.
    "name": "A String", # The name of this remarketing audience.
    "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
      "A String",
    ],
    "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
      "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
        "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
        "segment": "A String", # The segment condition that will cause a user to be added to an audience.
        "kind": "analytics#includeConditions", # Resource type for include conditions.
        "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
        "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
      },
      "excludeConditions": { # Defines the conditions to exclude users from the audience.
        "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
        "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
      },
    },
    "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    "accountId": "A String", # Account ID to which this remarketing audience belongs.
    "id": "A String", # Remarketing Audience ID.
    "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
      "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
        "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
        "segment": "A String", # The segment condition that will cause a user to be added to an audience.
        "kind": "analytics#includeConditions", # Resource type for include conditions.
        "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
        "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
      },
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics remarketing audience.
      "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
        { # JSON template for an Analytics Remarketing Audience Foreign Link.
          "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
          "status": "A String", # The status of this foreign account link.
          "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
          "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
          "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
          "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
          "id": "A String", # Entity ad account link ID.
          "accountId": "A String", # Account ID to which this linked foreign account belongs.
        },
      ],
      "kind": "analytics#remarketingAudience", # Collection type.
      "description": "A String", # The description of this remarketing audience.
      "created": "A String", # Time this remarketing audience was created.
      "updated": "A String", # Time this remarketing audience was last modified.
      "name": "A String", # The name of this remarketing audience.
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
      "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
        "A String",
      ],
      "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
        "excludeConditions": { # Defines the conditions to exclude users from the audience.
          "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
          "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
        },
      },
      "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
      "accountId": "A String", # Account ID to which this remarketing audience belongs.
      "id": "A String", # Remarketing Audience ID.
      "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
      },
    }
list(accountId, webPropertyId, max_results=None, type=None, start_index=None) 
Lists remarketing audiences to which the user has access.

Args:
  accountId: string, The account ID of the remarketing audiences to retrieve. (required)
  webPropertyId: string, The web property ID of the remarketing audiences to retrieve. (required)
  max_results: integer, The maximum number of remarketing audiences to include in this response.
  type: string, A parameter
  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#remarketingAudiences", # Collection type.
    "items": [ # A list of remarketing audiences.
      { # JSON template for an Analytics remarketing audience.
          "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
            { # JSON template for an Analytics Remarketing Audience Foreign Link.
              "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
              "status": "A String", # The status of this foreign account link.
              "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
              "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
              "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
              "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
              "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
              "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
              "id": "A String", # Entity ad account link ID.
              "accountId": "A String", # Account ID to which this linked foreign account belongs.
            },
          ],
          "kind": "analytics#remarketingAudience", # Collection type.
          "description": "A String", # The description of this remarketing audience.
          "created": "A String", # Time this remarketing audience was created.
          "updated": "A String", # Time this remarketing audience was last modified.
          "name": "A String", # The name of this remarketing audience.
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
          "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
            "A String",
          ],
          "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
            "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
              "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
              "segment": "A String", # The segment condition that will cause a user to be added to an audience.
              "kind": "analytics#includeConditions", # Resource type for include conditions.
              "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
              "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
            },
            "excludeConditions": { # Defines the conditions to exclude users from the audience.
              "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
              "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
            },
          },
          "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
          "accountId": "A String", # Account ID to which this remarketing audience belongs.
          "id": "A String", # Remarketing Audience ID.
          "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
            "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
              "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
              "segment": "A String", # The segment condition that will cause a user to be added to an audience.
              "kind": "analytics#includeConditions", # Resource type for include conditions.
              "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
              "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
            },
          },
        },
    ],
    "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 remarketing audience collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
patch(accountId, webPropertyId, remarketingAudienceId, body) 
Updates an existing remarketing audience. This method supports patch semantics.

Args:
  accountId: string, The account ID of the remarketing audience to update. (required)
  webPropertyId: string, The web property ID of the remarketing audience to update. (required)
  remarketingAudienceId: string, The ID of the remarketing audience to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics remarketing audience.
    "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
      { # JSON template for an Analytics Remarketing Audience Foreign Link.
        "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
        "status": "A String", # The status of this foreign account link.
        "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
        "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
        "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
        "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
        "id": "A String", # Entity ad account link ID.
        "accountId": "A String", # Account ID to which this linked foreign account belongs.
      },
    ],
    "kind": "analytics#remarketingAudience", # Collection type.
    "description": "A String", # The description of this remarketing audience.
    "created": "A String", # Time this remarketing audience was created.
    "updated": "A String", # Time this remarketing audience was last modified.
    "name": "A String", # The name of this remarketing audience.
    "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
      "A String",
    ],
    "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
      "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
        "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
        "segment": "A String", # The segment condition that will cause a user to be added to an audience.
        "kind": "analytics#includeConditions", # Resource type for include conditions.
        "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
        "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
      },
      "excludeConditions": { # Defines the conditions to exclude users from the audience.
        "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
        "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
      },
    },
    "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    "accountId": "A String", # Account ID to which this remarketing audience belongs.
    "id": "A String", # Remarketing Audience ID.
    "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
      "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
        "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
        "segment": "A String", # The segment condition that will cause a user to be added to an audience.
        "kind": "analytics#includeConditions", # Resource type for include conditions.
        "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
        "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
      },
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics remarketing audience.
      "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
        { # JSON template for an Analytics Remarketing Audience Foreign Link.
          "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
          "status": "A String", # The status of this foreign account link.
          "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
          "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
          "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
          "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
          "id": "A String", # Entity ad account link ID.
          "accountId": "A String", # Account ID to which this linked foreign account belongs.
        },
      ],
      "kind": "analytics#remarketingAudience", # Collection type.
      "description": "A String", # The description of this remarketing audience.
      "created": "A String", # Time this remarketing audience was created.
      "updated": "A String", # Time this remarketing audience was last modified.
      "name": "A String", # The name of this remarketing audience.
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
      "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
        "A String",
      ],
      "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
        "excludeConditions": { # Defines the conditions to exclude users from the audience.
          "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
          "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
        },
      },
      "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
      "accountId": "A String", # Account ID to which this remarketing audience belongs.
      "id": "A String", # Remarketing Audience ID.
      "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
      },
    }
update(accountId, webPropertyId, remarketingAudienceId, body) 
Updates an existing remarketing audience.

Args:
  accountId: string, The account ID of the remarketing audience to update. (required)
  webPropertyId: string, The web property ID of the remarketing audience to update. (required)
  remarketingAudienceId: string, The ID of the remarketing audience to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics remarketing audience.
    "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
      { # JSON template for an Analytics Remarketing Audience Foreign Link.
        "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
        "status": "A String", # The status of this foreign account link.
        "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
        "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
        "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
        "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
        "id": "A String", # Entity ad account link ID.
        "accountId": "A String", # Account ID to which this linked foreign account belongs.
      },
    ],
    "kind": "analytics#remarketingAudience", # Collection type.
    "description": "A String", # The description of this remarketing audience.
    "created": "A String", # Time this remarketing audience was created.
    "updated": "A String", # Time this remarketing audience was last modified.
    "name": "A String", # The name of this remarketing audience.
    "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
      "A String",
    ],
    "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
      "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
        "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
        "segment": "A String", # The segment condition that will cause a user to be added to an audience.
        "kind": "analytics#includeConditions", # Resource type for include conditions.
        "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
        "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
      },
      "excludeConditions": { # Defines the conditions to exclude users from the audience.
        "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
        "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
      },
    },
    "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    "accountId": "A String", # Account ID to which this remarketing audience belongs.
    "id": "A String", # Remarketing Audience ID.
    "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
      "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
        "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
        "segment": "A String", # The segment condition that will cause a user to be added to an audience.
        "kind": "analytics#includeConditions", # Resource type for include conditions.
        "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
        "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
      },
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics remarketing audience.
      "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
        { # JSON template for an Analytics Remarketing Audience Foreign Link.
          "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
          "status": "A String", # The status of this foreign account link.
          "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
          "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
          "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
          "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
          "id": "A String", # Entity ad account link ID.
          "accountId": "A String", # Account ID to which this linked foreign account belongs.
        },
      ],
      "kind": "analytics#remarketingAudience", # Collection type.
      "description": "A String", # The description of this remarketing audience.
      "created": "A String", # Time this remarketing audience was created.
      "updated": "A String", # Time this remarketing audience was last modified.
      "name": "A String", # The name of this remarketing audience.
      "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
      "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
        "A String",
      ],
      "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
        "excludeConditions": { # Defines the conditions to exclude users from the audience.
          "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
          "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
        },
      },
      "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
      "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
      "accountId": "A String", # Account ID to which this remarketing audience belongs.
      "id": "A String", # Remarketing Audience ID.
      "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
        "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
          "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
          "segment": "A String", # The segment condition that will cause a user to be added to an audience.
          "kind": "analytics#includeConditions", # Resource type for include conditions.
          "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
          "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
        },
      },
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.segments.html000066400000000000000000000066541300622755700273300ustar00rootroot00000000000000

Google Analytics API . management . segments

Instance Methods

list(max_results=None, start_index=None)

Lists segments to which the user has access.

Method Details

list(max_results=None, start_index=None) 
Lists segments to which the user has access.

Args:
  max_results: integer, The maximum number of segments to include in this response.
  start_index: integer, An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#segments", # Collection type for segments.
    "items": [ # A list of segments.
      { # JSON template for an Analytics segment.
        "definition": "A String", # Segment definition.
        "kind": "analytics#segment", # Resource type for Analytics segment.
        "segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Core Reporting API.
        "created": "A String", # Time the segment was created.
        "updated": "A String", # Time the segment was last modified.
        "type": "A String", # Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".
        "id": "A String", # Segment ID.
        "selfLink": "A String", # Link for this segment.
        "name": "A String", # 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 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 segment collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.unsampledReports.html000066400000000000000000000335471300622755700310530ustar00rootroot00000000000000

Google Analytics API . management . unsampledReports

Instance Methods

delete(accountId, webPropertyId, profileId, unsampledReportId)

Deletes an unsampled report.

get(accountId, webPropertyId, profileId, unsampledReportId)

Returns a single unsampled report.

insert(accountId, webPropertyId, profileId, body)

Create a new unsampled report.

list(accountId, webPropertyId, profileId, max_results=None, start_index=None)

Lists unsampled reports to which the user has access.

Method Details

delete(accountId, webPropertyId, profileId, unsampledReportId) 
Deletes an unsampled report.

Args:
  accountId: string, Account ID to delete the unsampled report for. (required)
  webPropertyId: string, Web property ID to delete the unsampled reports for. (required)
  profileId: string, View (Profile) ID to delete the unsampled report for. (required)
  unsampledReportId: string, ID of the unsampled report to be deleted. (required)
get(accountId, webPropertyId, profileId, unsampledReportId) 
Returns a single unsampled report.

Args:
  accountId: string, Account ID to retrieve unsampled report for. (required)
  webPropertyId: string, Web property ID to retrieve unsampled reports for. (required)
  profileId: string, View (Profile) ID to retrieve unsampled report for. (required)
  unsampledReportId: string, ID of the unsampled report to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for Analytics unsampled report resource.
      "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.
      "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report.
      "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage.
        "bucketId": "A String", # Id of the bucket the file object is stored in.
        "objectId": "A String", # Id of the file object containing the report data.
      },
      "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.
      "dimensions": "A String", # The dimensions for the unsampled report.
      "created": "A String", # Time this unsampled report was created.
      "segment": "A String", # The segment for the unsampled report.
      "start-date": "A String", # The start date for the unsampled report.
      "updated": "A String", # Time this unsampled report was last modified.
      "driveDownloadDetails": { # Download details for a file stored in Google Drive.
        "documentId": "A String", # Id of the document/file containing the report data.
      },
      "metrics": "A String", # The metrics for the unsampled report.
      "title": "A String", # Title of the unsampled report.
      "filters": "A String", # The filters for the unsampled report.
      "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.
      "profileId": "A String", # View (Profile) ID to which this unsampled report belongs.
      "end-date": "A String", # The end date for the unsampled report.
      "id": "A String", # Unsampled report ID.
      "selfLink": "A String", # Link for this unsampled report.
      "accountId": "A String", # Account ID to which this unsampled report belongs.
    }
insert(accountId, webPropertyId, profileId, body) 
Create a new unsampled report.

Args:
  accountId: string, Account ID to create the unsampled report for. (required)
  webPropertyId: string, Web property ID to create the unsampled report for. (required)
  profileId: string, View (Profile) ID to create the unsampled report for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics unsampled report resource.
    "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.
    "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report.
    "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage.
      "bucketId": "A String", # Id of the bucket the file object is stored in.
      "objectId": "A String", # Id of the file object containing the report data.
    },
    "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.
    "dimensions": "A String", # The dimensions for the unsampled report.
    "created": "A String", # Time this unsampled report was created.
    "segment": "A String", # The segment for the unsampled report.
    "start-date": "A String", # The start date for the unsampled report.
    "updated": "A String", # Time this unsampled report was last modified.
    "driveDownloadDetails": { # Download details for a file stored in Google Drive.
      "documentId": "A String", # Id of the document/file containing the report data.
    },
    "metrics": "A String", # The metrics for the unsampled report.
    "title": "A String", # Title of the unsampled report.
    "filters": "A String", # The filters for the unsampled report.
    "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.
    "profileId": "A String", # View (Profile) ID to which this unsampled report belongs.
    "end-date": "A String", # The end date for the unsampled report.
    "id": "A String", # Unsampled report ID.
    "selfLink": "A String", # Link for this unsampled report.
    "accountId": "A String", # Account ID to which this unsampled report belongs.
  }


Returns:
  An object of the form:

    { # JSON template for Analytics unsampled report resource.
      "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.
      "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report.
      "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage.
        "bucketId": "A String", # Id of the bucket the file object is stored in.
        "objectId": "A String", # Id of the file object containing the report data.
      },
      "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.
      "dimensions": "A String", # The dimensions for the unsampled report.
      "created": "A String", # Time this unsampled report was created.
      "segment": "A String", # The segment for the unsampled report.
      "start-date": "A String", # The start date for the unsampled report.
      "updated": "A String", # Time this unsampled report was last modified.
      "driveDownloadDetails": { # Download details for a file stored in Google Drive.
        "documentId": "A String", # Id of the document/file containing the report data.
      },
      "metrics": "A String", # The metrics for the unsampled report.
      "title": "A String", # Title of the unsampled report.
      "filters": "A String", # The filters for the unsampled report.
      "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.
      "profileId": "A String", # View (Profile) ID to which this unsampled report belongs.
      "end-date": "A String", # The end date for the unsampled report.
      "id": "A String", # Unsampled report ID.
      "selfLink": "A String", # Link for this unsampled report.
      "accountId": "A String", # Account ID to which this unsampled report belongs.
    }
list(accountId, webPropertyId, profileId, max_results=None, start_index=None) 
Lists unsampled reports to which the user has access.

Args:
  accountId: string, Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. (required)
  webPropertyId: string, Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. (required)
  profileId: string, View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. (required)
  max_results: integer, The maximum number of unsampled reports to include in this response.
  start_index: integer, An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#unsampledReports", # Collection type.
    "items": [ # A list of unsampled reports.
      { # JSON template for Analytics unsampled report resource.
          "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.
          "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report.
          "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage.
            "bucketId": "A String", # Id of the bucket the file object is stored in.
            "objectId": "A String", # Id of the file object containing the report data.
          },
          "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.
          "dimensions": "A String", # The dimensions for the unsampled report.
          "created": "A String", # Time this unsampled report was created.
          "segment": "A String", # The segment for the unsampled report.
          "start-date": "A String", # The start date for the unsampled report.
          "updated": "A String", # Time this unsampled report was last modified.
          "driveDownloadDetails": { # Download details for a file stored in Google Drive.
            "documentId": "A String", # Id of the document/file containing the report data.
          },
          "metrics": "A String", # The metrics for the unsampled report.
          "title": "A String", # Title of the unsampled report.
          "filters": "A String", # The filters for the unsampled report.
          "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.
          "profileId": "A String", # View (Profile) ID to which this unsampled report belongs.
          "end-date": "A String", # The end date for the unsampled report.
          "id": "A String", # Unsampled report ID.
          "selfLink": "A String", # Link for this unsampled report.
          "accountId": "A String", # Account ID to which this unsampled report 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 unsampled report 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 unsampled report collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.uploads.html000066400000000000000000000160411300622755700271410ustar00rootroot00000000000000

Google Analytics API . management . uploads

Instance Methods

deleteUploadData(accountId, webPropertyId, customDataSourceId, body)

Delete data associated with a previous upload.

get(accountId, webPropertyId, customDataSourceId, uploadId)

List uploads to which the user has access.

list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)

List uploads to which the user has access.

uploadData(accountId, webPropertyId, customDataSourceId, media_body=None)

Upload data for a custom data source.

Method Details

deleteUploadData(accountId, webPropertyId, customDataSourceId, body) 
Delete data associated with a previous upload.

Args:
  accountId: string, Account Id for the uploads to be deleted. (required)
  webPropertyId: string, Web property Id for the uploads to be deleted. (required)
  customDataSourceId: string, Custom data source Id for the uploads to be deleted. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request template for the delete upload data request.
    "customDataImportUids": [ # A list of upload UIDs.
      "A String",
    ],
  }
get(accountId, webPropertyId, customDataSourceId, uploadId) 
List uploads to which the user has access.

Args:
  accountId: string, Account Id for the upload to retrieve. (required)
  webPropertyId: string, Web property Id for the upload to retrieve. (required)
  customDataSourceId: string, Custom data source Id for upload to retrieve. (required)
  uploadId: string, Upload Id to retrieve. (required)

Returns:
  An object of the form:

    { # Metadata returned for an upload operation.
    "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
    "kind": "analytics#upload", # Resource type for Analytics upload.
    "errors": [ # Data import errors collection.
      "A String",
    ],
    "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
    "id": "A String", # A unique ID for this upload.
    "accountId": "A String", # Account Id to which this upload belongs.
  }
list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None) 
List uploads to which the user has access.

Args:
  accountId: string, Account Id for the uploads to retrieve. (required)
  webPropertyId: string, Web property Id for the uploads to retrieve. (required)
  customDataSourceId: string, Custom data source Id for uploads to retrieve. (required)
  max_results: integer, The maximum number of uploads to include in this response.
  start_index: integer, A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.
    "kind": "analytics#uploads", # Collection type.
    "items": [ # A list of uploads.
      { # Metadata returned for an upload operation.
        "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
        "kind": "analytics#upload", # Resource type for Analytics upload.
        "errors": [ # Data import errors collection.
          "A String",
        ],
        "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
        "id": "A String", # A unique ID for this upload.
        "accountId": "A String", # Account Id to which this 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 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 upload collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
  }
uploadData(accountId, webPropertyId, customDataSourceId, media_body=None) 
Upload data for a custom data source.

Args:
  accountId: string, Account Id associated with the upload. (required)
  webPropertyId: string, Web property UA-string associated with the upload. (required)
  customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
  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 an upload operation.
    "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
    "kind": "analytics#upload", # Resource type for Analytics upload.
    "errors": [ # Data import errors collection.
      "A String",
    ],
    "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
    "id": "A String", # A unique ID for this upload.
    "accountId": "A String", # Account Id to which this upload belongs.
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.webPropertyAdWordsLinks.html000066400000000000000000000464571300622755700323170ustar00rootroot00000000000000

Google Analytics API . management . webPropertyAdWordsLinks

Instance Methods

delete(accountId, webPropertyId, webPropertyAdWordsLinkId)

Deletes a web property-AdWords link.

get(accountId, webPropertyId, webPropertyAdWordsLinkId)

Returns a web property-AdWords link to which the user has access.

insert(accountId, webPropertyId, body)

Creates a webProperty-AdWords link.

list(accountId, webPropertyId, max_results=None, start_index=None)

Lists webProperty-AdWords links for a given web property.

patch(accountId, webPropertyId, webPropertyAdWordsLinkId, body)

Updates an existing webProperty-AdWords link. This method supports patch semantics.

update(accountId, webPropertyId, webPropertyAdWordsLinkId, body)

Updates an existing webProperty-AdWords link.

Method Details

delete(accountId, webPropertyId, webPropertyAdWordsLinkId) 
Deletes a web property-AdWords link.

Args:
  accountId: string, ID of the account which the given web property belongs to. (required)
  webPropertyId: string, Web property ID to delete the AdWords link for. (required)
  webPropertyAdWordsLinkId: string, Web property AdWords link ID. (required)
get(accountId, webPropertyId, webPropertyAdWordsLinkId) 
Returns a web property-AdWords link to which the user has access.

Args:
  accountId: string, ID of the account which the given web property belongs to. (required)
  webPropertyId: string, Web property ID to retrieve the AdWords link for. (required)
  webPropertyAdWordsLinkId: string, Web property-AdWords link ID. (required)

Returns:
  An object of the form:

    { # JSON template for Analytics Entity AdWords Link.
      "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
      "name": "A String", # Name of the link. This field is required when creating an AdWords link.
      "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
        { # JSON template for an AdWords account.
          "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
          "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
          "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
        },
      ],
      "entity": { # Web property being linked.
        "webPropertyRef": { # JSON template for a web property reference.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
        "A String",
      ],
      "id": "A String", # Entity AdWords link ID
      "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
    }
insert(accountId, webPropertyId, body) 
Creates a webProperty-AdWords link.

Args:
  accountId: string, ID of the Google Analytics account to create the link for. (required)
  webPropertyId: string, Web property ID to create the link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Entity AdWords Link.
    "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
    "name": "A String", # Name of the link. This field is required when creating an AdWords link.
    "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
      { # JSON template for an AdWords account.
        "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
        "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
        "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
      },
    ],
    "entity": { # Web property being linked.
      "webPropertyRef": { # JSON template for a web property reference.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
      "A String",
    ],
    "id": "A String", # Entity AdWords link ID
    "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
  }


Returns:
  An object of the form:

    { # JSON template for Analytics Entity AdWords Link.
      "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
      "name": "A String", # Name of the link. This field is required when creating an AdWords link.
      "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
        { # JSON template for an AdWords account.
          "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
          "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
          "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
        },
      ],
      "entity": { # Web property being linked.
        "webPropertyRef": { # JSON template for a web property reference.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
        "A String",
      ],
      "id": "A String", # Entity AdWords link ID
      "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
    }
list(accountId, webPropertyId, max_results=None, start_index=None) 
Lists webProperty-AdWords links for a given web property.

Args:
  accountId: string, ID of the account which the given web property belongs to. (required)
  webPropertyId: string, Web property ID to retrieve the AdWords links for. (required)
  max_results: integer, The maximum number of webProperty-AdWords links to include in this response.
  start_index: integer, An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # An entity AdWords link collection provides a list of GA-AdWords links Each resource in this collection corresponds to a single link.
    "kind": "analytics#entityAdWordsLinks", # Collection type.
    "items": [ # A list of entity AdWords links.
      { # JSON template for Analytics Entity AdWords Link.
          "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
          "name": "A String", # Name of the link. This field is required when creating an AdWords link.
          "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
            { # JSON template for an AdWords account.
              "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
              "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
              "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
            },
          ],
          "entity": { # Web property being linked.
            "webPropertyRef": { # JSON template for a web property reference.
              "kind": "analytics#webPropertyRef", # Analytics web property reference.
              "name": "A String", # Name of this web property.
              "internalWebPropertyId": "A String", # Internal ID for this web property.
              "href": "A String", # Link for this web property.
              "id": "A String", # Web property ID of the form UA-XXXXX-YY.
              "accountId": "A String", # Account ID to which this web property belongs.
            },
          },
          "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
            "A String",
          ],
          "id": "A String", # Entity AdWords link ID
          "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
        },
    ],
    "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 AdWords link 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 AdWords link collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }
patch(accountId, webPropertyId, webPropertyAdWordsLinkId, body) 
Updates an existing webProperty-AdWords link. This method supports patch semantics.

Args:
  accountId: string, ID of the account which the given web property belongs to. (required)
  webPropertyId: string, Web property ID to retrieve the AdWords link for. (required)
  webPropertyAdWordsLinkId: string, Web property-AdWords link ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Entity AdWords Link.
    "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
    "name": "A String", # Name of the link. This field is required when creating an AdWords link.
    "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
      { # JSON template for an AdWords account.
        "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
        "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
        "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
      },
    ],
    "entity": { # Web property being linked.
      "webPropertyRef": { # JSON template for a web property reference.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
      "A String",
    ],
    "id": "A String", # Entity AdWords link ID
    "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
  }


Returns:
  An object of the form:

    { # JSON template for Analytics Entity AdWords Link.
      "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
      "name": "A String", # Name of the link. This field is required when creating an AdWords link.
      "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
        { # JSON template for an AdWords account.
          "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
          "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
          "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
        },
      ],
      "entity": { # Web property being linked.
        "webPropertyRef": { # JSON template for a web property reference.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
        "A String",
      ],
      "id": "A String", # Entity AdWords link ID
      "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
    }
update(accountId, webPropertyId, webPropertyAdWordsLinkId, body) 
Updates an existing webProperty-AdWords link.

Args:
  accountId: string, ID of the account which the given web property belongs to. (required)
  webPropertyId: string, Web property ID to retrieve the AdWords link for. (required)
  webPropertyAdWordsLinkId: string, Web property-AdWords link ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Analytics Entity AdWords Link.
    "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
    "name": "A String", # Name of the link. This field is required when creating an AdWords link.
    "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
      { # JSON template for an AdWords account.
        "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
        "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
        "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
      },
    ],
    "entity": { # Web property being linked.
      "webPropertyRef": { # JSON template for a web property reference.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
      "A String",
    ],
    "id": "A String", # Entity AdWords link ID
    "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
  }


Returns:
  An object of the form:

    { # JSON template for Analytics Entity AdWords Link.
      "kind": "analytics#entityAdWordsLink", # Resource type for entity AdWords link.
      "name": "A String", # Name of the link. This field is required when creating an AdWords link.
      "adWordsAccounts": [ # A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.
        { # JSON template for an AdWords account.
          "kind": "analytics#adWordsAccount", # Resource type for AdWords account.
          "customerId": "A String", # Customer ID. This field is required when creating an AdWords link.
          "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.
        },
      ],
      "entity": { # Web property being linked.
        "webPropertyRef": { # JSON template for a web property reference.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "profileIds": [ # IDs of linked Views (Profiles) represented as strings.
        "A String",
      ],
      "id": "A String", # Entity AdWords link ID
      "selfLink": "A String", # URL link for this Google Analytics - Google AdWords link.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.webproperties.html000066400000000000000000000526671300622755700304020ustar00rootroot00000000000000

Google Analytics API . management . webproperties

Instance Methods

get(accountId, webPropertyId)

Gets a web property to which the user has access.

insert(accountId, body)

Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.

list(accountId, max_results=None, start_index=None)

Lists web properties to which the user has access.

patch(accountId, webPropertyId, body)

Updates an existing web property. This method supports patch semantics.

update(accountId, webPropertyId, body)

Updates an existing web property.

Method Details

get(accountId, webPropertyId) 
Gets a web property to which the user has access.

Args:
  accountId: string, Account ID to retrieve the web property for. (required)
  webPropertyId: string, ID to retrieve the web property for. (required)

Returns:
  An object of the form:

    { # 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.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "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.
      "starred": True or False, # Indicates whether this web property is starred or not.
      "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".
      },
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "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.
    }
insert(accountId, body) 
Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.

Args:
  accountId: string, Account ID to create the web property for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # 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.
    "defaultProfileId": "A String", # Default view (profile) ID.
    "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.
    "starred": True or False, # Indicates whether this web property is starred or not.
    "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".
    },
    "permissions": { # Permissions the user has for this web property.
      "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
        "A String",
      ],
    },
    "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.
  }


Returns:
  An object of the form:

    { # 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.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "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.
      "starred": True or False, # Indicates whether this web property is starred or not.
      "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".
      },
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "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.
    }
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.
          "defaultProfileId": "A String", # Default view (profile) ID.
          "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.
          "starred": True or False, # Indicates whether this web property is starred or not.
          "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".
          },
          "permissions": { # Permissions the user has for this web property.
            "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
              "A String",
            ],
          },
          "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.
  }
patch(accountId, webPropertyId, body) 
Updates an existing web property. This method supports patch semantics.

Args:
  accountId: string, Account ID to which the web property belongs (required)
  webPropertyId: string, Web property ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # 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.
    "defaultProfileId": "A String", # Default view (profile) ID.
    "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.
    "starred": True or False, # Indicates whether this web property is starred or not.
    "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".
    },
    "permissions": { # Permissions the user has for this web property.
      "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
        "A String",
      ],
    },
    "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.
  }


Returns:
  An object of the form:

    { # 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.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "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.
      "starred": True or False, # Indicates whether this web property is starred or not.
      "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".
      },
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "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.
    }
update(accountId, webPropertyId, body) 
Updates an existing web property.

Args:
  accountId: string, Account ID to which the web property belongs (required)
  webPropertyId: string, Web property ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # 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.
    "defaultProfileId": "A String", # Default view (profile) ID.
    "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.
    "starred": True or False, # Indicates whether this web property is starred or not.
    "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".
    },
    "permissions": { # Permissions the user has for this web property.
      "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
        "A String",
      ],
    },
    "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.
  }


Returns:
  An object of the form:

    { # 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.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "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.
      "starred": True or False, # Indicates whether this web property is starred or not.
      "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".
      },
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "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.
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.management.webpropertyUserLinks.html000066400000000000000000000447051300622755700317240ustar00rootroot00000000000000

Google Analytics API . management . webpropertyUserLinks

Instance Methods

delete(accountId, webPropertyId, linkId)

Removes a user from the given web property.

insert(accountId, webPropertyId, body)

Adds a new user to the given web property.

list(accountId, webPropertyId, max_results=None, start_index=None)

Lists webProperty-user links for a given web property.

update(accountId, webPropertyId, linkId, body)

Updates permissions for an existing user on the given web property.

Method Details

delete(accountId, webPropertyId, linkId) 
Removes a user from the given web property.

Args:
  accountId: string, Account ID to delete the user link for. (required)
  webPropertyId: string, Web Property ID to delete the user link for. (required)
  linkId: string, Link ID to delete the user link for. (required)
insert(accountId, webPropertyId, body) 
Adds a new user to the given web property.

Args:
  accountId: string, Account ID to create the user link for. (required)
  webPropertyId: string, Web Property ID to create the user link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
    "kind": "analytics#entityUserLink", # Resource type for entity user link.
    "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
      "accountRef": { # JSON template for a linked account. # Account for this link.
        "kind": "analytics#accountRef", # Analytics account reference.
        "href": "A String", # Link for this account.
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "userRef": { # JSON template for a user reference. # User reference.
      "kind": "analytics#userRef",
      "email": "A String", # Email ID of this user.
      "id": "A String", # User ID.
    },
    "id": "A String", # Entity user link ID
    "selfLink": "A String", # Self link for this resource.
    "permissions": { # Permissions the user has for this entity.
      "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
        "A String",
      ],
      "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
      "kind": "analytics#entityUserLink", # Resource type for entity user link.
      "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
        "accountRef": { # JSON template for a linked account. # Account for this link.
          "kind": "analytics#accountRef", # Analytics account reference.
          "href": "A String", # Link for this account.
          "id": "A String", # Account ID.
          "name": "A String", # Account name.
        },
        "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
          "kind": "analytics#profileRef", # Analytics view (profile) reference.
          "name": "A String", # Name of this view (profile).
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
          "href": "A String", # Link for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
        },
        "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "userRef": { # JSON template for a user reference. # User reference.
        "kind": "analytics#userRef",
        "email": "A String", # Email ID of this user.
        "id": "A String", # User ID.
      },
      "id": "A String", # Entity user link ID
      "selfLink": "A String", # Self link for this resource.
      "permissions": { # Permissions the user has for this entity.
        "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
          "A String",
        ],
        "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
          "A String",
        ],
      },
    }
list(accountId, webPropertyId, max_results=None, start_index=None) 
Lists webProperty-user links for a given web property.

Args:
  accountId: string, Account ID which the given web property belongs to. (required)
  webPropertyId: string, Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)
  max_results: integer, The maximum number of webProperty-user Links to include in this response.
  start_index: integer, An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Returns:
  An object of the form:

    { # An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.
    "kind": "analytics#entityUserLinks", # Collection type.
    "items": [ # A list of entity user links.
      { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
          "kind": "analytics#entityUserLink", # Resource type for entity user link.
          "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
            "accountRef": { # JSON template for a linked account. # Account for this link.
              "kind": "analytics#accountRef", # Analytics account reference.
              "href": "A String", # Link for this account.
              "id": "A String", # Account ID.
              "name": "A String", # Account name.
            },
            "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
              "kind": "analytics#profileRef", # Analytics view (profile) reference.
              "name": "A String", # Name of this view (profile).
              "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
              "href": "A String", # Link for this view (profile).
              "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
              "id": "A String", # View (Profile) ID.
              "accountId": "A String", # Account ID to which this view (profile) belongs.
            },
            "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
              "kind": "analytics#webPropertyRef", # Analytics web property reference.
              "name": "A String", # Name of this web property.
              "internalWebPropertyId": "A String", # Internal ID for this web property.
              "href": "A String", # Link for this web property.
              "id": "A String", # Web property ID of the form UA-XXXXX-YY.
              "accountId": "A String", # Account ID to which this web property belongs.
            },
          },
          "userRef": { # JSON template for a user reference. # User reference.
            "kind": "analytics#userRef",
            "email": "A String", # Email ID of this user.
            "id": "A String", # User ID.
          },
          "id": "A String", # Entity user link ID
          "selfLink": "A String", # Self link for this resource.
          "permissions": { # Permissions the user has for this entity.
            "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
              "A String",
            ],
            "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
              "A String",
            ],
          },
        },
    ],
    "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.
  }
update(accountId, webPropertyId, linkId, body) 
Updates permissions for an existing user on the given web property.

Args:
  accountId: string, Account ID to update the account-user link for. (required)
  webPropertyId: string, Web property ID to update the account-user link for. (required)
  linkId: string, Link ID to update the account-user link for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
    "kind": "analytics#entityUserLink", # Resource type for entity user link.
    "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
      "accountRef": { # JSON template for a linked account. # Account for this link.
        "kind": "analytics#accountRef", # Analytics account reference.
        "href": "A String", # Link for this account.
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
      "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
        "kind": "analytics#profileRef", # Analytics view (profile) reference.
        "name": "A String", # Name of this view (profile).
        "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
        "href": "A String", # Link for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
      },
      "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
        "kind": "analytics#webPropertyRef", # Analytics web property reference.
        "name": "A String", # Name of this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "href": "A String", # Link for this web property.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    },
    "userRef": { # JSON template for a user reference. # User reference.
      "kind": "analytics#userRef",
      "email": "A String", # Email ID of this user.
      "id": "A String", # User ID.
    },
    "id": "A String", # Entity user link ID
    "selfLink": "A String", # Self link for this resource.
    "permissions": { # Permissions the user has for this entity.
      "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
        "A String",
      ],
      "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.
      "kind": "analytics#entityUserLink", # Resource type for entity user link.
      "entity": { # Entity for this link. It can be an account, a web property, or a view (profile).
        "accountRef": { # JSON template for a linked account. # Account for this link.
          "kind": "analytics#accountRef", # Analytics account reference.
          "href": "A String", # Link for this account.
          "id": "A String", # Account ID.
          "name": "A String", # Account name.
        },
        "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link.
          "kind": "analytics#profileRef", # Analytics view (profile) reference.
          "name": "A String", # Name of this view (profile).
          "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
          "href": "A String", # Link for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
        },
        "webPropertyRef": { # JSON template for a web property reference. # Web property for this link.
          "kind": "analytics#webPropertyRef", # Analytics web property reference.
          "name": "A String", # Name of this web property.
          "internalWebPropertyId": "A String", # Internal ID for this web property.
          "href": "A String", # Link for this web property.
          "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          "accountId": "A String", # Account ID to which this web property belongs.
        },
      },
      "userRef": { # JSON template for a user reference. # User reference.
        "kind": "analytics#userRef",
        "email": "A String", # Email ID of this user.
        "id": "A String", # User ID.
      },
      "id": "A String", # Entity user link ID
      "selfLink": "A String", # Self link for this resource.
      "permissions": { # Permissions the user has for this entity.
        "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.
          "A String",
        ],
        "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.
          "A String",
        ],
      },
    }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.metadata.columns.html000066400000000000000000000045731300622755700266250ustar00rootroot00000000000000

Google Analytics API . metadata . columns

Instance Methods

list(reportType)

Lists all columns for a report type

Method Details

list(reportType) 
Lists all columns for a report type

Args:
  reportType: string, Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API (required)

Returns:
  An object of the form:

    { # Lists columns (dimensions and metrics) for a particular report type.
    "items": [ # List of columns for a report type.
      { # JSON template for a metadata column.
        "attributes": { # Map of attribute name and value for this column.
          "a_key": "A String", # The name of the attribute.
        },
        "kind": "analytics#column", # Resource type for Analytics column.
        "id": "A String", # Column id.
      },
    ],
    "kind": "analytics#columns", # Collection type.
    "etag": "A String", # Etag of collection. This etag can be compared with the last response etag to check if response has changed.
    "totalResults": 42, # Total number of columns returned in the response.
    "attributeNames": [ # List of attributes names returned by columns.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/analytics_v3.metadata.html000066400000000000000000000023421300622755700251360ustar00rootroot00000000000000

Google Analytics API . metadata

Instance Methods

columns()

Returns the columns Resource.

google-api-python-client-1.5.5/docs/dyn/analytics_v3.provisioning.html000066400000000000000000000402701300622755700261060ustar00rootroot00000000000000

Google Analytics API . provisioning

Instance Methods

createAccountTicket(body)

Creates an account ticket.

Method Details

createAccountTicket(body) 
Creates an account ticket.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
    "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
        "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
            # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
        "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
        "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
        "id": "A String", # View (Profile) ID.
        "accountId": "A String", # Account ID to which this view (profile) belongs.
        "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
        "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
        "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
        "type": "A String", # View (Profile) type. Supported types: WEB or APP.
        "updated": "A String", # Time this view (profile) was last modified.
        "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
        },
        "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
        "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".
        },
        "permissions": { # Permissions the user has for this view (profile).
          "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
            "A String",
          ],
        },
        "defaultPage": "A String", # Default page for this view (profile).
        "kind": "analytics#profile", # Resource type for Analytics view (profile).
        "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
        "name": "A String", # Name of this view (profile).
        "created": "A String", # Time this view (profile) was created.
        "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
        "websiteUrl": "A String", # Website URL for this view (profile).
        "starred": True or False, # Indicates whether this view (profile) is starred or not.
        "selfLink": "A String", # Link for this view (profile).
      },
    "account": { # JSON template for Analytics account entry. # Account for this ticket.
      "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".
      },
      "starred": True or False, # Indicates whether this account is starred or not.
      "id": "A String", # Account ID.
      "selfLink": "A String", # Link for this account.
      "permissions": { # Permissions the user has for this account.
        "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
          "A String",
        ],
      },
    },
    "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
        "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.
        "defaultProfileId": "A String", # Default view (profile) ID.
        "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.
        "starred": True or False, # Indicates whether this web property is starred or not.
        "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".
        },
        "permissions": { # Permissions the user has for this web property.
          "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
            "A String",
          ],
        },
        "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.
      },
    "kind": "analytics#accountTicket", # Resource type for account ticket.
    "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
    "id": "A String", # Account ticket ID used to access the account ticket.
  }


Returns:
  An object of the form:

    { # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
      "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
          "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
              # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
          "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
          "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
          "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
          "id": "A String", # View (Profile) ID.
          "accountId": "A String", # Account ID to which this view (profile) belongs.
          "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
          "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
          "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
          "type": "A String", # View (Profile) type. Supported types: WEB or APP.
          "updated": "A String", # Time this view (profile) was last modified.
          "excludeQueryParameters": "A String", # The query parameters that are excluded from 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".
          },
          "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
          "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".
          },
          "permissions": { # Permissions the user has for this view (profile).
            "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
              "A String",
            ],
          },
          "defaultPage": "A String", # Default page for this view (profile).
          "kind": "analytics#profile", # Resource type for Analytics view (profile).
          "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
          "name": "A String", # Name of this view (profile).
          "created": "A String", # Time this view (profile) was created.
          "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
          "websiteUrl": "A String", # Website URL for this view (profile).
          "starred": True or False, # Indicates whether this view (profile) is starred or not.
          "selfLink": "A String", # Link for this view (profile).
        },
      "account": { # JSON template for Analytics account entry. # Account for this ticket.
        "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".
        },
        "starred": True or False, # Indicates whether this account is starred or not.
        "id": "A String", # Account ID.
        "selfLink": "A String", # Link for this account.
        "permissions": { # Permissions the user has for this account.
          "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
            "A String",
          ],
        },
      },
      "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
          "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.
          "defaultProfileId": "A String", # Default view (profile) ID.
          "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.
          "starred": True or False, # Indicates whether this web property is starred or not.
          "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".
          },
          "permissions": { # Permissions the user has for this web property.
            "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
              "A String",
            ],
          },
          "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.
        },
      "kind": "analytics#accountTicket", # Resource type for account ticket.
      "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
      "id": "A String", # Account ticket ID used to access the account ticket.
    }
google-api-python-client-1.5.5/docs/dyn/analyticsreporting_v4.html000066400000000000000000000041601300622755700253120ustar00rootroot00000000000000

Google Analytics Reporting API

Instance Methods

reports()

Returns the reports Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/analyticsreporting_v4.reports.html000066400000000000000000001547631300622755700270260ustar00rootroot00000000000000

Google Analytics Reporting API . reports

Instance Methods

batchGet(body, x__xgafv=None)

Returns the Analytics data.

Method Details

batchGet(body, x__xgafv=None) 
Returns the Analytics data.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The batch request containing multiple report request.
    "reportRequests": [ # Requests, each request will have a separate response.
        # There can be a maximum of 5 requests. All requests should have the same
        # `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
      { # The main request class which specifies the Reporting API request.
        "pivots": [ # The pivot definitions. Requests can have a maximum of 2 pivots.
          { # The Pivot describes the pivot section in the request.
              # The Pivot helps rearrange the information in the table for certain reports
              # by pivoting your data on a second dimension.
            "metrics": [ # The pivot metrics. Pivot metrics are part of the
                # restriction on total number of metrics allowed in the request.
              { # [Metrics](https://support.google.com/analytics/answer/1033861)
                  # are the quantitative measurements. For example, the metric `ga:users`
                  # indicates the total number of users for the requested time period.
                "alias": "A String", # An alias for the metric expression is an alternate name for the
                    # expression. The alias can be used for filtering and sorting. This field
                    # is optional and is useful if the expression is not a single metric but
                    # a complex expression which cannot be used in filtering and sorting.
                    # The alias is also used in the response column header.
                "expression": "A String", # A metric expression in the request. An expression is constructed from one
                    # or more metrics and numbers. Accepted operators include: Plus (+), Minus
                    # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
                    # Positive cardinal numbers (0-9), can include decimals and is limited to
                    # 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
                    # metric expression is just a single metric name like `ga:users`.
                    # Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
                    # will result in unexpected results.
                "formattingType": "A String", # Specifies how the metric expression should be formatted, for example
                    # `INTEGER`.
              },
            ],
            "startGroup": 42, # If k metrics were requested, then the response will contain some
                # data-dependent multiple of k columns in the report.  E.g., if you pivoted
                # on the dimension `ga:browser` then you'd get k columns for "Firefox", k
                # columns for "IE", k columns for "Chrome", etc. The ordering of the groups
                # of columns is determined by descending order of "total" for the first of
                # the k values.  Ties are broken by lexicographic ordering of the first
                # pivot dimension, then lexicographic ordering of the second pivot
                # dimension, and so on.  E.g., if the totals for the first value for
                # Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns
                # would be Chrome, Firefox, IE.
                #
                # The following let you choose which of the groups of k columns are
                # included in the response.
            "dimensions": [ # A list of dimensions to show as pivot columns. A Pivot can have a maximum
                # of 4 dimensions. Pivot dimensions are part of the restriction on the
                # total number of dimensions allowed in the request.
              { # [Dimensions](https://support.google.com/analytics/answer/1033861)
                  # are attributes of your data. For example, the dimension `ga:city`
                  # indicates the city, for example, "Paris" or "New York", from which
                  # a session originates.
                "name": "A String", # Name of the dimension to fetch, for example `ga:browser`.
                "histogramBuckets": [ # If non-empty, we place dimension values into buckets after string to
                    # int64. Dimension values that are not the string representation of an
                    # integral value will be converted to zero.  The bucket values have to be in
                    # increasing order.  Each bucket is closed on the lower end, and open on the
                    # upper end. The "first" bucket includes all values less than the first
                    # boundary, the "last" bucket includes all values up to infinity. Dimension
                    # values that fall in a bucket get transformed to a new dimension value. For
                    # example, if one gives a list of "0, 1, 3, 4, 7", then we return the
                    # following buckets:
                    #
                    # - bucket #1: values < 0, dimension value "<0"
                    # - bucket #2: values in [0,1), dimension value "0"
                    # - bucket #3: values in [1,3), dimension value "1-2"
                    # - bucket #4: values in [3,4), dimension value "3"
                    # - bucket #5: values in [4,7), dimension value "4-6"
                    # - bucket #6: values >= 7, dimension value "7+"
                    #
                    # NOTE: If you are applying histogram mutation on any dimension, and using
                    # that dimension in sort, you will want to use the sort type
                    # `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values
                    # will be sorted according to dictionary
                    # (lexicographic) order. For example the ascending dictionary order is:
                    #
                    #    "<50", "1001+", "121-1000", "50-120"
                    #
                    # And the ascending `HISTOGRAM_BUCKET` order is:
                    #
                    #    "<50", "50-120", "121-1000", "1001+"
                    #
                    # The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"`
                    # for a histogram-mutated dimension.
                  "A String",
                ],
              },
            ],
            "dimensionFilterClauses": [ # DimensionFilterClauses are logically combined with an `AND` operator: only
                # data that is included by all these DimensionFilterClauses contributes to
                # the values in this pivot region. Dimension filters can be used to restrict
                # the columns shown in the pivot region. For example if you have
                # `ga:browser` as the requested dimension in the pivot region, and you
                # specify key filters to restrict `ga:browser` to only "IE" or "Firefox",
                # then only those two browsers would show up as columns.
              { # A group of dimension filters. Set the operator value to specify how
                  # the filters are logically combined.
                "operator": "A String", # The operator for combining multiple dimension filters. If unspecified, it
                    # is treated as an `OR`.
                "filters": [ # The repeated set of filters. They are logically combined based on the
                    # operator specified.
                  { # Dimension filter specifies the filtering options on a dimension.
                    "dimensionName": "A String", # The dimension to filter on. A DimensionFilter must contain a dimension.
                    "operator": "A String", # How to match the dimension to the expression. The default is REGEXP.
                    "expressions": [ # Strings or regular expression to match against. Only the first value of
                        # the list is used for comparison unless the operator is `IN_LIST`.
                        # If `IN_LIST` operator, then the entire list is used to filter the
                        # dimensions as explained in the description of the `IN_LIST` operator.
                      "A String",
                    ],
                    "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
                        # dimension values will be excluded in the report. The default is false.
                    "caseSensitive": True or False, # Should the match be case sensitive? Default is false.
                  },
                ],
              },
            ],
            "maxGroupCount": 42, # Specifies the maximum number of groups to return.
                # The default value is 10, also the maximum value is 1,000.
          },
        ],
        "hideTotals": True or False, # If set to true, hides the total of all metrics for all the matching rows,
            # for every date range. The default false and will return the totals.
        "metrics": [ # The metrics requested.
            # Requests must specify at least one metric. Requests can have a
            # total of 10 metrics.
          { # [Metrics](https://support.google.com/analytics/answer/1033861)
              # are the quantitative measurements. For example, the metric `ga:users`
              # indicates the total number of users for the requested time period.
            "alias": "A String", # An alias for the metric expression is an alternate name for the
                # expression. The alias can be used for filtering and sorting. This field
                # is optional and is useful if the expression is not a single metric but
                # a complex expression which cannot be used in filtering and sorting.
                # The alias is also used in the response column header.
            "expression": "A String", # A metric expression in the request. An expression is constructed from one
                # or more metrics and numbers. Accepted operators include: Plus (+), Minus
                # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
                # Positive cardinal numbers (0-9), can include decimals and is limited to
                # 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
                # metric expression is just a single metric name like `ga:users`.
                # Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
                # will result in unexpected results.
            "formattingType": "A String", # Specifies how the metric expression should be formatted, for example
                # `INTEGER`.
          },
        ],
        "dimensions": [ # The dimensions requested.
            # Requests can have a total of 7 dimensions.
          { # [Dimensions](https://support.google.com/analytics/answer/1033861)
              # are attributes of your data. For example, the dimension `ga:city`
              # indicates the city, for example, "Paris" or "New York", from which
              # a session originates.
            "name": "A String", # Name of the dimension to fetch, for example `ga:browser`.
            "histogramBuckets": [ # If non-empty, we place dimension values into buckets after string to
                # int64. Dimension values that are not the string representation of an
                # integral value will be converted to zero.  The bucket values have to be in
                # increasing order.  Each bucket is closed on the lower end, and open on the
                # upper end. The "first" bucket includes all values less than the first
                # boundary, the "last" bucket includes all values up to infinity. Dimension
                # values that fall in a bucket get transformed to a new dimension value. For
                # example, if one gives a list of "0, 1, 3, 4, 7", then we return the
                # following buckets:
                #
                # - bucket #1: values < 0, dimension value "<0"
                # - bucket #2: values in [0,1), dimension value "0"
                # - bucket #3: values in [1,3), dimension value "1-2"
                # - bucket #4: values in [3,4), dimension value "3"
                # - bucket #5: values in [4,7), dimension value "4-6"
                # - bucket #6: values >= 7, dimension value "7+"
                #
                # NOTE: If you are applying histogram mutation on any dimension, and using
                # that dimension in sort, you will want to use the sort type
                # `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values
                # will be sorted according to dictionary
                # (lexicographic) order. For example the ascending dictionary order is:
                #
                #    "<50", "1001+", "121-1000", "50-120"
                #
                # And the ascending `HISTOGRAM_BUCKET` order is:
                #
                #    "<50", "50-120", "121-1000", "1001+"
                #
                # The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"`
                # for a histogram-mutated dimension.
              "A String",
            ],
          },
        ],
        "dimensionFilterClauses": [ # The dimension filter clauses for filtering Dimension Values. They are
            # logically combined with the `AND` operator. Note that filtering occurs
            # before any dimensions are aggregated, so that the returned metrics
            # represent the total for only the relevant dimensions.
          { # A group of dimension filters. Set the operator value to specify how
              # the filters are logically combined.
            "operator": "A String", # The operator for combining multiple dimension filters. If unspecified, it
                # is treated as an `OR`.
            "filters": [ # The repeated set of filters. They are logically combined based on the
                # operator specified.
              { # Dimension filter specifies the filtering options on a dimension.
                "dimensionName": "A String", # The dimension to filter on. A DimensionFilter must contain a dimension.
                "operator": "A String", # How to match the dimension to the expression. The default is REGEXP.
                "expressions": [ # Strings or regular expression to match against. Only the first value of
                    # the list is used for comparison unless the operator is `IN_LIST`.
                    # If `IN_LIST` operator, then the entire list is used to filter the
                    # dimensions as explained in the description of the `IN_LIST` operator.
                  "A String",
                ],
                "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
                    # dimension values will be excluded in the report. The default is false.
                "caseSensitive": True or False, # Should the match be case sensitive? Default is false.
              },
            ],
          },
        ],
        "includeEmptyRows": True or False, # If set to false, the response does not include rows if all the retrieved
            # metrics are equal to zero. The default is false which will exclude these
            # rows.
        "filtersExpression": "A String", # Dimension or metric filters that restrict the data returned for your
            # request. To use the `filtersExpression`, supply a dimension or metric on
            # which to filter, followed by the filter expression. For example, the
            # following expression selects `ga:browser` dimension which starts with
            # Firefox; `ga:browser=~^Firefox`. For more information on dimensions
            # and metric filters, see
            # [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
        "segments": [ # Segment the data returned for the request. A segment definition helps look
            # at a subset of the segment request. A request can contain up to four
            # segments. Every [ReportRequest](#ReportRequest) within a
            # `batchGet` method must contain the same `segments` definition. Requests
            # with segments must have the `ga:segment` dimension.
          { # The segment definition, if the report needs to be segmented.
              # A Segment is a subset of the Analytics data. For example, of the entire
              # set of users, one Segment might be users from a particular country or city.
            "dynamicSegment": { # Dynamic segment definition for defining the segment within the request. # A dynamic segment definition in the request.
                # A segment can select users, sessions or both.
              "sessionSegment": { # SegmentDefinition defines the segment to be a set of SegmentFilters which # Session Segment to select sessions to include in the segment.
                  # are combined together with a logical `AND` operation.
                "segmentFilters": [ # A segment is defined by a set of segment filters which are combined
                    # together with a logical `AND` operation.
                  { # SegmentFilter defines the segment to be either a simple or a sequence
                      # segment. A simple segment condition contains dimension and metric conditions
                      # to select the sessions or users. A sequence segment condition can be used to
                      # select users or sessions based on sequential conditions.
                    "not": True or False, # If true, match the complement of simple or sequence segment.
                        # For example, to match all visits not from "New York", we can define the
                        # segment as follows:
                        #
                        #       "sessionSegment": {
                        #         "segmentFilters": [{
                        #           "simpleSegment" :{
                        #             "orFiltersForSegment": [{
                        #               "segmentFilterClauses":[{
                        #                 "dimensionFilter": {
                        #                   "dimensionName": "ga:city",
                        #                   "expressions": ["New York"]
                        #                 }
                        #               }]
                        #             }]
                        #           },
                        #           "not": "True"
                        #         }]
                        #       },
                    "simpleSegment": { # A Simple segment conditions consist of one or more dimension/metric # A Simple segment conditions consist of one or more dimension/metric
                        # conditions that can be combined
                        # conditions that can be combined.
                      "orFiltersForSegment": [ # A list of segment filters groups which are combined with logical `AND`
                          # operator.
                        { # A list of segment filters in the `OR` group are combined with the logical OR
                            # operator.
                          "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
                            { # Filter Clause to be used in a segment definition, can be wither a metric or
                                # a dimension filter.
                              "not": True or False, # Matches the complement (`!`) of the filter.
                              "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
                                "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
                                "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
                                "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
                                "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
                                "operator": "A String", # The operator to use to match the dimension with the expressions.
                                "expressions": [ # The list of expressions, only the first element is used for all operators
                                  "A String",
                                ],
                              },
                              "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
                                "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
                                    # is `EQUAL`.
                                "scope": "A String", # Scope for a metric defines the level at which that metric is defined.  The
                                    # specified metric scope must be equal to or greater than its primary scope
                                    # as defined in the data model. The primary scope is defined by if the
                                    # segment is selecting users or sessions.
                                "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
                                    # treated as minimum comparison value.
                                "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
                                "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
                                    # metric name.
                              },
                            },
                          ],
                        },
                      ],
                    },
                    "sequenceSegment": { # Sequence conditions consist of one or more steps, where each step is defined # Sequence conditions consist of one or more steps, where each step is
                        # defined by one or more dimension/metric conditions. Multiple steps can
                        # be combined with special sequence operators.
                        # by one or more dimension/metric conditions. Multiple steps can be combined
                        # with special sequence operators.
                      "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
                          # the date range).
                      "segmentSequenceSteps": [ # The list of steps in the sequence.
                        { # A segment sequence definition.
                          "matchType": "A String", # Specifies if the step immediately precedes or can be any time before the
                              # next step.
                          "orFiltersForSegment": [ # A sequence is specified with a list of Or grouped filters which are
                              # combined with `AND` operator.
                            { # A list of segment filters in the `OR` group are combined with the logical OR
                                # operator.
                              "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
                                { # Filter Clause to be used in a segment definition, can be wither a metric or
                                    # a dimension filter.
                                  "not": True or False, # Matches the complement (`!`) of the filter.
                                  "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
                                    "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
                                    "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
                                    "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
                                    "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
                                    "operator": "A String", # The operator to use to match the dimension with the expressions.
                                    "expressions": [ # The list of expressions, only the first element is used for all operators
                                      "A String",
                                    ],
                                  },
                                  "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
                                    "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
                                        # is `EQUAL`.
                                    "scope": "A String", # Scope for a metric defines the level at which that metric is defined.  The
                                        # specified metric scope must be equal to or greater than its primary scope
                                        # as defined in the data model. The primary scope is defined by if the
                                        # segment is selecting users or sessions.
                                    "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
                                        # treated as minimum comparison value.
                                    "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
                                    "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
                                        # metric name.
                                  },
                                },
                              ],
                            },
                          ],
                        },
                      ],
                    },
                  },
                ],
              },
              "name": "A String", # The name of the dynamic segment.
              "userSegment": { # SegmentDefinition defines the segment to be a set of SegmentFilters which # User Segment to select users to include in the segment.
                  # are combined together with a logical `AND` operation.
                "segmentFilters": [ # A segment is defined by a set of segment filters which are combined
                    # together with a logical `AND` operation.
                  { # SegmentFilter defines the segment to be either a simple or a sequence
                      # segment. A simple segment condition contains dimension and metric conditions
                      # to select the sessions or users. A sequence segment condition can be used to
                      # select users or sessions based on sequential conditions.
                    "not": True or False, # If true, match the complement of simple or sequence segment.
                        # For example, to match all visits not from "New York", we can define the
                        # segment as follows:
                        #
                        #       "sessionSegment": {
                        #         "segmentFilters": [{
                        #           "simpleSegment" :{
                        #             "orFiltersForSegment": [{
                        #               "segmentFilterClauses":[{
                        #                 "dimensionFilter": {
                        #                   "dimensionName": "ga:city",
                        #                   "expressions": ["New York"]
                        #                 }
                        #               }]
                        #             }]
                        #           },
                        #           "not": "True"
                        #         }]
                        #       },
                    "simpleSegment": { # A Simple segment conditions consist of one or more dimension/metric # A Simple segment conditions consist of one or more dimension/metric
                        # conditions that can be combined
                        # conditions that can be combined.
                      "orFiltersForSegment": [ # A list of segment filters groups which are combined with logical `AND`
                          # operator.
                        { # A list of segment filters in the `OR` group are combined with the logical OR
                            # operator.
                          "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
                            { # Filter Clause to be used in a segment definition, can be wither a metric or
                                # a dimension filter.
                              "not": True or False, # Matches the complement (`!`) of the filter.
                              "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
                                "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
                                "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
                                "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
                                "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
                                "operator": "A String", # The operator to use to match the dimension with the expressions.
                                "expressions": [ # The list of expressions, only the first element is used for all operators
                                  "A String",
                                ],
                              },
                              "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
                                "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
                                    # is `EQUAL`.
                                "scope": "A String", # Scope for a metric defines the level at which that metric is defined.  The
                                    # specified metric scope must be equal to or greater than its primary scope
                                    # as defined in the data model. The primary scope is defined by if the
                                    # segment is selecting users or sessions.
                                "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
                                    # treated as minimum comparison value.
                                "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
                                "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
                                    # metric name.
                              },
                            },
                          ],
                        },
                      ],
                    },
                    "sequenceSegment": { # Sequence conditions consist of one or more steps, where each step is defined # Sequence conditions consist of one or more steps, where each step is
                        # defined by one or more dimension/metric conditions. Multiple steps can
                        # be combined with special sequence operators.
                        # by one or more dimension/metric conditions. Multiple steps can be combined
                        # with special sequence operators.
                      "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
                          # the date range).
                      "segmentSequenceSteps": [ # The list of steps in the sequence.
                        { # A segment sequence definition.
                          "matchType": "A String", # Specifies if the step immediately precedes or can be any time before the
                              # next step.
                          "orFiltersForSegment": [ # A sequence is specified with a list of Or grouped filters which are
                              # combined with `AND` operator.
                            { # A list of segment filters in the `OR` group are combined with the logical OR
                                # operator.
                              "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
                                { # Filter Clause to be used in a segment definition, can be wither a metric or
                                    # a dimension filter.
                                  "not": True or False, # Matches the complement (`!`) of the filter.
                                  "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
                                    "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
                                    "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
                                    "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
                                    "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
                                    "operator": "A String", # The operator to use to match the dimension with the expressions.
                                    "expressions": [ # The list of expressions, only the first element is used for all operators
                                      "A String",
                                    ],
                                  },
                                  "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
                                    "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
                                        # is `EQUAL`.
                                    "scope": "A String", # Scope for a metric defines the level at which that metric is defined.  The
                                        # specified metric scope must be equal to or greater than its primary scope
                                        # as defined in the data model. The primary scope is defined by if the
                                        # segment is selecting users or sessions.
                                    "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
                                        # treated as minimum comparison value.
                                    "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
                                    "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
                                        # metric name.
                                  },
                                },
                              ],
                            },
                          ],
                        },
                      ],
                    },
                  },
                ],
              },
            },
            "segmentId": "A String", # The segment ID of a built-in or custom segment, for example `gaid::-3`.
          },
        ],
        "hideValueRanges": True or False, # If set to true, hides the minimum and maximum across all matching rows.
            # The default is false and the value ranges are returned.
        "orderBys": [ # Sort order on output rows. To compare two rows, the elements of the
            # following are applied in order until a difference is found.  All date
            # ranges in the output get the same row order.
          { # Specifies the sorting options.
            "orderType": "A String", # The order type. The default orderType is `VALUE`.
            "fieldName": "A String", # The field which to sort by. The default sort order is ascending. Example:
                # `ga:browser`.
                # Note, that you can only specify one field for sort here. For example,
                # `ga:browser, ga:city` is not valid.
            "sortOrder": "A String", # The sorting order for the field.
          },
        ],
        "cohortGroup": { # Defines a cohort group. # Cohort group associated with this request. If there is a cohort group
            # in the request the `ga:cohort` dimension must be present.
            # Every [ReportRequest](#ReportRequest) within a `batchGet` method must
            # contain the same `cohortGroup` definition.
            # For example:
            #
            #     "cohortGroup": {
            #       "cohorts": [{
            #         "name": "cohort 1",
            #         "type": "FIRST_VISIT_DATE",
            #         "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
            #       },{
            #         "name": "cohort 2"
            #          "type": "FIRST_VISIT_DATE"
            #          "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
            #       }]
            #     }
          "cohorts": [ # The definition for the cohort.
            { # Defines a cohort. A cohort is a group of users who share a common
                # characteristic. For example, all users with the same acquisition date
                # belong to the same cohort.
              "dateRange": { # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. # This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users
                  # whose first visit date is between start date and end date defined in the
                  # DateRange. The date ranges should be aligned for cohort requests. If the
                  # request contains `ga:cohortNthDay` it should be exactly one day long,
                  # if `ga:cohortNthWeek` it should be aligned to the week boundary (starting
                  # at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range
                  # should be aligned to the month (starting at the first and ending on the
                  # last day of the month).
                  # For LTV requests there are no such restrictions.
                  # You do not need to supply a date range for the
                  # `reportsRequest.dateRanges` field.
                  # The start and end dates are specified in
                  # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
                "startDate": "A String", # The start date for the query in the format `YYYY-MM-DD`.
                "endDate": "A String", # The end date for the query in the format `YYYY-MM-DD`.
              },
              "type": "A String", # Type of the cohort. The only supported type as of now is
                  # `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated
                  # as `FIRST_VISIT_DATE` type cohort.
              "name": "A String", # A unique name for the cohort. If not defined name will be auto-generated
                  # with values cohort_[1234...].
            },
          ],
          "lifetimeValue": True or False, # Enable Life Time Value (LTV).  LTV measures lifetime value for users
              # acquired through different channels.
              # Please see:
              # [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and
              # [Lifetime Value](https://support.google.com/analytics/answer/6182550)
              # If the value of lifetimeValue is false:
              #
              # - The metric values are similar to the values in the web interface cohort
              #   report.
              # - The cohort definition date ranges must be aligned to the calendar week
              #   and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in
              #   the cohort definition should be a Sunday and the `endDate` should be the
              #   following Saturday, and for `ga:cohortNthMonth`, the `startDate`
              #   should be the 1st of the month and `endDate` should be the last day
              #   of the month.
              #
              # When the lifetimeValue is true:
              #
              # - The metric values will correspond to the values in the web interface
              #   LifeTime value report.
              # - The Lifetime Value report shows you how user value (Revenue) and
              #   engagement (Appviews, Goal Completions, Sessions, and Session Duration)
              #   grow during the 90 days after a user is acquired.
              # - The metrics are calculated as a cumulative average per user per the time
              #   increment.
              # - The cohort definition date ranges need not be aligned to the calendar
              #   week and month boundaries.
              # - The `viewId` must be an
              #   [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)
        },
        "dateRanges": [ # Date ranges in the request. The request can have a maximum of 2 date
            # ranges. The response will contain a set of metric values for each
            # combination of the dimensions for each date range in the request. So, if
            # there are two date ranges, there will be two set of metric values, one for
            # the original date range and one for the second date range.
            # The `reportRequest.dateRanges` field should not be specified for cohorts
            # or Lifetime value requests.
            # If a date range is not provided, the default date range is (startDate:
            # current date - 7 days, endDate: current date - 1 day). Every
            # [ReportRequest](#ReportRequest) within a `batchGet` method must
            # contain the same `dateRanges` definition.
          { # A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
              # The start and end dates are specified in
              # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
            "startDate": "A String", # The start date for the query in the format `YYYY-MM-DD`.
            "endDate": "A String", # The end date for the query in the format `YYYY-MM-DD`.
          },
        ],
        "pageToken": "A String", # A continuation token to get the next page of the results. Adding this to
            # the request will return the rows after the pageToken. The pageToken should
            # be the value returned in the nextPageToken parameter in the response to
            # the GetReports request.
        "samplingLevel": "A String", # The desired report
            # [sample](https://support.google.com/analytics/answer/2637192) size.
            # If the the `samplingLevel` field is unspecified the `DEFAULT` sampling
            # level is used. Every [ReportRequest](#ReportRequest) within a
            # `batchGet` method must contain the same `samplingLevel` definition. See
            # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
            #  for details.
        "pageSize": 42, # Page size is for paging and specifies the maximum number of returned rows.
            # Page size should be >= 0. A query returns the default of 1,000 rows.
            # The Analytics Core Reporting API returns a maximum of 10,000 rows per
            # request, no matter how many you ask for. It can also return fewer rows
            # than requested, if there aren't as many dimension segments as you expect.
            # For instance, there are fewer than 300 possible values for `ga:country`,
            # so when segmenting only by country, you can't get more than 300 rows,
            # even if you set `pageSize` to a higher value.
        "metricFilterClauses": [ # The metric filter clauses. They are logically combined with the `AND`
            # operator.  Metric filters look at only the first date range and not the
            # comparing date range. Note that filtering on metrics occurs after the
            # metrics are aggregated.
          { # Represents a group of metric filters.
              # Set the operator value to specify how the filters are logically combined.
            "operator": "A String", # The operator for combining multiple metric filters. If unspecified, it is
                # treated as an `OR`.
            "filters": [ # The repeated set of filters. They are logically combined based on the
                # operator specified.
              { # MetricFilter specifies the filter on a metric.
                "operator": "A String", # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
                    # comparisonValue, the default is `EQUAL`. If the operator is
                    # `IS_MISSING`, checks if the metric is missing and would ignore the
                    # comparisonValue.
                "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
                    # metric values will be excluded in the report. The default is false.
                "comparisonValue": "A String", # The value to compare against.
                "metricName": "A String", # The metric that will be filtered on. A metricFilter must contain a metric
                    # name. A metric name can be an alias earlier defined as a metric or it can
                    # also be a metric expression.
              },
            ],
          },
        ],
        "viewId": "A String", # The Analytics
            # [view ID](https://support.google.com/analytics/answer/1009618)
            # from which to retrieve data. Every [ReportRequest](#ReportRequest)
            # within a `batchGet` method must contain the same `viewId`.
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The main response class which holds the reports from the Reporting API
      # `batchGet` call.
    "reports": [ # Responses corresponding to each of the request.
      { # The data response corresponding to the request.
        "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
        "data": { # The data part of the report. # Response data.
          "rows": [ # There's one ReportRow for every unique combination of dimensions.
            { # A row in the report.
              "metrics": [ # List of metrics for each requested DateRange.
                { # Used to return a list of metrics for a single DateRange / dimension
                    # combination
                  "values": [ # Each value corresponds to each Metric in the request.
                    "A String",
                  ],
                  "pivotValueRegions": [ # The values of each pivot region.
                    { # The metric values in the pivot region.
                      "values": [ # The values of the metrics in each of the pivot regions.
                        "A String",
                      ],
                    },
                  ],
                },
              ],
              "dimensions": [ # List of requested dimensions.
                "A String",
              ],
            },
          ],
          "maximums": [ # Minimum and maximum values seen over all matching rows. These are both
              # empty when `hideValueRanges` in the request is false, or when
              # rowCount is zero.
            { # Used to return a list of metrics for a single DateRange / dimension
                # combination
              "values": [ # Each value corresponds to each Metric in the request.
                "A String",
              ],
              "pivotValueRegions": [ # The values of each pivot region.
                { # The metric values in the pivot region.
                  "values": [ # The values of the metrics in each of the pivot regions.
                    "A String",
                  ],
                },
              ],
            },
          ],
          "minimums": [ # Minimum and maximum values seen over all matching rows. These are both
              # empty when `hideValueRanges` in the request is false, or when
              # rowCount is zero.
            { # Used to return a list of metrics for a single DateRange / dimension
                # combination
              "values": [ # Each value corresponds to each Metric in the request.
                "A String",
              ],
              "pivotValueRegions": [ # The values of each pivot region.
                { # The metric values in the pivot region.
                  "values": [ # The values of the metrics in each of the pivot regions.
                    "A String",
                  ],
                },
              ],
            },
          ],
          "isDataGolden": True or False, # Indicates if response to this request is golden or not. Data is
              # golden when the exact same request will not produce any new results if
              # asked at a later point in time.
          "samplingSpaceSizes": [ # If the results are
              # [sampled](https://support.google.com/analytics/answer/2637192),
              # this returns the total number of
              # samples present, one entry per date range. If the results are not sampled
              # this field will not be defined. See
              # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
              # for details.
            "A String",
          ],
          "totals": [ # For each requested date range, for the set of all rows that match
              # the query, every requested value format gets a total. The total
              # for a value format is computed by first totaling the metrics
              # mentioned in the value format and then evaluating the value
              # format as a scalar expression.  E.g., The "totals" for
              # `3 / (ga:sessions + 2)` we compute
              # `3 / ((sum of all relevant ga:sessions) + 2)`.
              # Totals are computed before pagination.
            { # Used to return a list of metrics for a single DateRange / dimension
                # combination
              "values": [ # Each value corresponds to each Metric in the request.
                "A String",
              ],
              "pivotValueRegions": [ # The values of each pivot region.
                { # The metric values in the pivot region.
                  "values": [ # The values of the metrics in each of the pivot regions.
                    "A String",
                  ],
                },
              ],
            },
          ],
          "rowCount": 42, # Total number of matching rows for this query.
          "samplesReadCounts": [ # If the results are
              # [sampled](https://support.google.com/analytics/answer/2637192),
              # this returns the total number of samples read, one entry per date range.
              # If the results are not sampled this field will not be defined. See
              # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
              # for details.
            "A String",
          ],
        },
        "columnHeader": { # Column headers. # The column headers.
          "dimensions": [ # The dimension names in the response.
            "A String",
          ],
          "metricHeader": { # The headers for the metrics. # Metric headers for the metrics in the response.
            "pivotHeaders": [ # Headers for the pivots in the response.
              { # The headers for each of the pivot sections defined in the request.
                "totalPivotGroupsCount": 42, # The total number of groups for this pivot.
                "pivotHeaderEntries": [ # A single pivot section header.
                  { # The headers for the each of the metric column corresponding to the metrics
                      # requested in the pivots section of the response.
                    "dimensionValues": [ # The values for the dimensions in the pivot.
                      "A String",
                    ],
                    "dimensionNames": [ # The name of the dimensions in the pivot response.
                      "A String",
                    ],
                    "metric": { # Header for the metrics. # The metric header for the metric in the pivot.
                      "type": "A String", # The type of the metric, for example `INTEGER`.
                      "name": "A String", # The name of the header.
                    },
                  },
                ],
              },
            ],
            "metricHeaderEntries": [ # Headers for the metrics in the response.
              { # Header for the metrics.
                "type": "A String", # The type of the metric, for example `INTEGER`.
                "name": "A String", # The name of the header.
              },
            ],
          },
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.collections.html000066400000000000000000000434341300622755700274330ustar00rootroot00000000000000

Google Play EMM API . collections

Instance Methods

delete(enterpriseId, collectionId)

Deletes a collection.

get(enterpriseId, collectionId)

Retrieves the details of a collection.

insert(enterpriseId, body)

Creates a new collection.

list(enterpriseId)

Retrieves the IDs of all the collections for an enterprise.

patch(enterpriseId, collectionId, body)

Updates a collection. This method supports patch semantics.

update(enterpriseId, collectionId, body)

Updates a collection.

Method Details

delete(enterpriseId, collectionId) 
Deletes a collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
get(enterpriseId, collectionId) 
Retrieves the details of a collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)

Returns:
  An object of the form:

    { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
        #
        # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
      "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
      "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
        "A String",
      ],
      "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
      "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
          #
          # The "allUsers" setting is deprecated, and will be removed.
      "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
    }
insert(enterpriseId, body) 
Creates a new collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
      # 
      # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
    "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
    "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
      "A String",
    ],
    "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
    "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
        # 
        # The "allUsers" setting is deprecated, and will be removed.
    "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
  }


Returns:
  An object of the form:

    { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
        #
        # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
      "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
      "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
        "A String",
      ],
      "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
      "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
          #
          # The "allUsers" setting is deprecated, and will be removed.
      "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
    }
list(enterpriseId) 
Retrieves the IDs of all the collections for an enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    { # The collection resources for the enterprise.
    "kind": "androidenterprise#collectionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionsListResponse".
    "collection": [ # An ordered collection of products which can be made visible on the Google Play Store to a selected group of users.
      { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
            #
            # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
          "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
          "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
            "A String",
          ],
          "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
          "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
              #
              # The "allUsers" setting is deprecated, and will be removed.
          "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
        },
    ],
  }
patch(enterpriseId, collectionId, body) 
Updates a collection. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
      # 
      # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
    "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
    "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
      "A String",
    ],
    "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
    "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
        # 
        # The "allUsers" setting is deprecated, and will be removed.
    "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
  }


Returns:
  An object of the form:

    { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
        #
        # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
      "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
      "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
        "A String",
      ],
      "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
      "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
          #
          # The "allUsers" setting is deprecated, and will be removed.
      "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
    }
update(enterpriseId, collectionId, body) 
Updates a collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
      # 
      # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
    "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
    "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
      "A String",
    ],
    "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
    "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
        # 
        # The "allUsers" setting is deprecated, and will be removed.
    "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
  }


Returns:
  An object of the form:

    { # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
        #
        # Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
      "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
      "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
        "A String",
      ],
      "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
      "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
          #
          # The "allUsers" setting is deprecated, and will be removed.
      "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.collectionviewers.html000066400000000000000000000446311300622755700306550ustar00rootroot00000000000000

Google Play EMM API . collectionviewers

Instance Methods

delete(enterpriseId, collectionId, userId)

Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.

get(enterpriseId, collectionId, userId)

Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.

list(enterpriseId, collectionId)

Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.

patch(enterpriseId, collectionId, userId, body)

Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.

update(enterpriseId, collectionId, userId, body)

Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.

Method Details

delete(enterpriseId, collectionId, userId) 
Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
  userId: string, The ID of the user. (required)
get(enterpriseId, collectionId, userId) 
Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
list(enterpriseId, collectionId) 
Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)

Returns:
  An object of the form:

    { # The user resources for the collection.
    "kind": "androidenterprise#collectionViewersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionViewersListResponse".
    "user": [ # A user of an enterprise.
      { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
            # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
            # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
          "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
          "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
          "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
          "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
          "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
          "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
          "id": "A String", # The unique ID for the user.
        },
    ],
  }
patch(enterpriseId, collectionId, userId, body) 
Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
  userId: string, The ID of the user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
      # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
      # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
    "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
    "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
    "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
    "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
    "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
    "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
    "id": "A String", # The unique ID for the user.
  }


Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
update(enterpriseId, collectionId, userId, body) 
Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  collectionId: string, The ID of the collection. (required)
  userId: string, The ID of the user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
      # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
      # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
    "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
    "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
    "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
    "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
    "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
    "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
    "id": "A String", # The unique ID for the user.
  }


Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.devices.html000066400000000000000000000220071300622755700265300ustar00rootroot00000000000000

Google Play EMM API . devices

Instance Methods

get(enterpriseId, userId, deviceId)

Retrieves the details of a device.

getState(enterpriseId, userId, deviceId)

Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

list(enterpriseId, userId)

Retrieves the IDs of all of a user's devices.

setState(enterpriseId, userId, deviceId, body)

Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

Method Details

get(enterpriseId, userId, deviceId) 
Retrieves the details of a device.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The ID of the device. (required)

Returns:
  An object of the form:

    { # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
      #
      # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
    "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
    "managementType": "A String", # Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations.
        #
        # Possible values include:
        # - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner,
        # - "managedProfile", a device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC,
        # - "containerApp", a device running the Android for Work App. The Android for Work App is managed by the DPC,
        # - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.
    "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
  }
getState(enterpriseId, userId, deviceId) 
Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The ID of the device. (required)

Returns:
  An object of the form:

    { # The state of a user's device, as accessed by the getState and setState methods on device resources.
      "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
      "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
    }
list(enterpriseId, userId) 
Retrieves the IDs of all of a user's devices.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # The device resources for the user.
    "device": [ # A managed device.
      { # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
          #
          # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
        "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
        "managementType": "A String", # Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations.
            #
            # Possible values include:
            # - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner,
            # - "managedProfile", a device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC,
            # - "containerApp", a device running the Android for Work App. The Android for Work App is managed by the DPC,
            # - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.
        "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
      },
    ],
    "kind": "androidenterprise#devicesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
  }
setState(enterpriseId, userId, deviceId, body) 
Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The ID of the device. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
    "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
    "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
  }


Returns:
  An object of the form:

    { # The state of a user's device, as accessed by the getState and setState methods on device resources.
      "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
      "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.enterprises.html000066400000000000000000001107071300622755700274560ustar00rootroot00000000000000

Google Play EMM API . enterprises

Instance Methods

acknowledgeNotificationSet(notificationSetId=None)

Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.

completeSignup(completionToken=None, enterpriseToken=None)

Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.

createWebToken(enterpriseId, body)

Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the Play for Work javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.

delete(enterpriseId)

Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.

enroll(token, body)

Enrolls an enterprise with the calling EMM.

generateSignupUrl(callbackUrl=None)

Generates a sign-up URL.

get(enterpriseId)

Retrieves the name and domain of an enterprise.

getServiceAccount(enterpriseId, keyType=None)

Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.

getStoreLayout(enterpriseId)

Returns the store layout for the enterprise. If the store layout has not been set, or if the store layout has no homepageId set, returns a NOT_FOUND error.

insert(token, body)

Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.

list(domain)

Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.

pullNotificationSet(requestMode=None)

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.

sendTestPushNotification(enterpriseId)

Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.

setAccount(enterpriseId, body)

Set the account that will be used to authenticate to the API as the enterprise.

setStoreLayout(enterpriseId, body)

Sets the store layout for the enterprise.

unenroll(enterpriseId)

Unenrolls an enterprise from the calling EMM.

Method Details

acknowledgeNotificationSet(notificationSetId=None) 
Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.

Args:
  notificationSetId: string, The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.
completeSignup(completionToken=None, enterpriseToken=None) 
Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.

Args:
  completionToken: string, The Completion token initially returned by GenerateSignupUrl.
  enterpriseToken: string, The Enterprise token appended to the Callback URL.

Returns:
  An object of the form:

    { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
        # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
        # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
      "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
        { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
          "email": "A String", # The administrator's email address.
        },
      ],
      "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
      "id": "A String", # The unique ID for the enterprise.
      "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
      "name": "A String", # The name of the enterprise, for example, "Example, Inc".
    }
createWebToken(enterpriseId, body) 
Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the Play for Work javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.
    "kind": "androidenterprise#administratorWebTokenSpec", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebTokenSpec".
    "parent": "A String", # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https.
    "permission": [ # The list of permissions the admin is granted within the iframe. The admin will only be allowed to view an iframe if they have all of the permissions associated with it.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # A token authorizing an administrator to access an iframe.
    "kind": "androidenterprise#administratorWebToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebToken".
    "token": "A String", # An opaque token to be passed to the Play front-end to generate an iframe.
  }
delete(enterpriseId) 
Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
enroll(token, body) 
Enrolls an enterprise with the calling EMM.

Args:
  token: string, The token provided by the enterprise to register the EMM. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
      # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
      # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
    "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
      { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
        "email": "A String", # The administrator's email address.
      },
    ],
    "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
    "id": "A String", # The unique ID for the enterprise.
    "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
    "name": "A String", # The name of the enterprise, for example, "Example, Inc".
  }


Returns:
  An object of the form:

    { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
        # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
        # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
      "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
        { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
          "email": "A String", # The administrator's email address.
        },
      ],
      "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
      "id": "A String", # The unique ID for the enterprise.
      "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
      "name": "A String", # The name of the enterprise, for example, "Example, Inc".
    }
generateSignupUrl(callbackUrl=None) 
Generates a sign-up URL.

Args:
  callbackUrl: string, The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request.
Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.

Returns:
  An object of the form:

    { # A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.
    "url": "A String", # A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe.
    "kind": "androidenterprise#signupInfo", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#signupInfo".
    "completionToken": "A String", # An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup.
  }
get(enterpriseId) 
Retrieves the name and domain of an enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
        # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
        # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
      "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
        { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
          "email": "A String", # The administrator's email address.
        },
      ],
      "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
      "id": "A String", # The unique ID for the enterprise.
      "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
      "name": "A String", # The name of the enterprise, for example, "Example, Inc".
    }
getServiceAccount(enterpriseId, keyType=None) 
Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.

This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.

Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.

Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  keyType: string, The type of credential to return with the service account. Required.
    Allowed values
      googleCredentials - 
      pkcs12 - 

Returns:
  An object of the form:

    { # A service account identity, including the name and credentials that can be used to authenticate as the service account.
    "kind": "androidenterprise#serviceAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccount".
    "name": "A String", # The account name of the service account, in the form of an email address. Assigned by the server.
    "key": { # Credentials that can be used to authenticate as a service account. # Credentials that can be used to authenticate as this ServiceAccount.
      "type": "A String", # The file format of the generated key data.
      "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey".
      "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
      "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
    },
  }
getStoreLayout(enterpriseId) 
Returns the store layout for the enterprise. If the store layout has not been set, or if the store layout has no homepageId set, returns a NOT_FOUND error.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    { # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
    "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
        #
        # If a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store.
        #
        # If there exists at least one page, this field must be set to the ID of a valid page.
    "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
    "storeLayoutType": "A String", # Sets a store layout type. If set to "custom", "homepageId" must be specified. If set to "basic", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, "homepageId" must not be specified. The "basic" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.
  }
insert(token, body) 
Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.

Args:
  token: string, The token provided by the enterprise to register the EMM. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
      # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
      # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
    "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
      { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
        "email": "A String", # The administrator's email address.
      },
    ],
    "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
    "id": "A String", # The unique ID for the enterprise.
    "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
    "name": "A String", # The name of the enterprise, for example, "Example, Inc".
  }


Returns:
  An object of the form:

    { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
        # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
        # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
      "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
        { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
          "email": "A String", # The administrator's email address.
        },
      ],
      "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
      "id": "A String", # The unique ID for the enterprise.
      "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
      "name": "A String", # The name of the enterprise, for example, "Example, Inc".
    }
list(domain) 
Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.

Args:
  domain: string, The exact primary domain name of the enterprise to look up. (required)

Returns:
  An object of the form:

    { # The matching enterprise resources.
    "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
    "enterprise": [ # An enterprise.
      { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
            # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.
            # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
          "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
            { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.
              "email": "A String", # The administrator's email address.
            },
          ],
          "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com".
          "id": "A String", # The unique ID for the enterprise.
          "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
          "name": "A String", # The name of the enterprise, for example, "Example, Inc".
        },
    ],
  }
pullNotificationSet(requestMode=None) 
Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.
A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises​.AcknowledgeNotificationSet, unless the notification set is empty.
Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.
Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending.
If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.

Args:
  requestMode: string, The request mode for pulling notifications.
Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time.
Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.
If omitted, defaults to waitForNotifications.
    Allowed values
      returnImmediately - 
      waitForNotifications - 

Returns:
  An object of the form:

    { # A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.
    "notification": [ # The notifications received, or empty if no notifications are present.
      { # A notification of one event relating to an enterprise.
        "appRestrictionsSchemaChangeEvent": { # An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API. # Notifications about new app restrictions schema changes.
          "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the app restriction schema changed. This field will always be present.
        },
        "newPermissionsEvent": { # An event generated when new permissions are added to an app. # Notifications about new app permissions.
          "approvedPermissions": [ # The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions.
            "A String",
          ],
          "requestedPermissions": [ # The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.
            "A String",
          ],
          "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which new permissions were added. This field will always be present.
        },
        "productAvailabilityChangeEvent": { # An event generated whenever a product's availability changes. # Notifications about product availability changes.
          "availabilityStatus": "A String", # The new state of the product. This field will always be present.
          "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the product availability changed. This field will always be present.
        },
        "productApprovalEvent": { # An event generated when a product's approval status is changed. # Notifications about changes to a product's approval status.
          "approved": "A String", # Whether the product was approved or unapproved. This field will always be present.
          "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the approval status has changed. This field will always be present.
        },
        "enterpriseId": "A String", # The ID of the enterprise for which the notification is sent. This will always be present.
        "installFailureEvent": { # An event generated when an app installation failed on a device # Notifications about an app installation failure.
          "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the install failure event occured. This field will always be present.
          "userId": "A String", # The ID of the user. This field will always be present.
          "deviceId": "A String", # The Android ID of the device. This field will always be present.
          "failureDetails": "A String", # Additional details on the failure if applicable.
          "failureReason": "A String", # The reason for the installation failure. This field will always be present.
        },
        "appUpdateEvent": { # An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API. # Notifications about app updates.
          "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") that was updated. This field will always be present.
        },
        "timestampMillis": "A String", # The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present.
      },
    ],
    "kind": "androidenterprise#notificationSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet".
    "notificationSetId": "A String", # The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present.
  }
sendTestPushNotification(enterpriseId) 
Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    {
    "topicName": "A String", # The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent.
    "messageId": "A String", # The message ID of the test push notification that was sent.
  }
setAccount(enterpriseId, body) 
Set the account that will be used to authenticate to the API as the enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
    "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
    "accountEmail": "A String", # The email address of the service account.
  }


Returns:
  An object of the form:

    { # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
      "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
      "accountEmail": "A String", # The email address of the service account.
    }
setStoreLayout(enterpriseId, body) 
Sets the store layout for the enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
  "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
      # 
      # If a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store.
      # 
      # If there exists at least one page, this field must be set to the ID of a valid page.
  "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
  "storeLayoutType": "A String", # Sets a store layout type. If set to "custom", "homepageId" must be specified. If set to "basic", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, "homepageId" must not be specified. The "basic" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.
}


Returns:
  An object of the form:

    { # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
    "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
        #
        # If a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store.
        #
        # If there exists at least one page, this field must be set to the ID of a valid page.
    "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
    "storeLayoutType": "A String", # Sets a store layout type. If set to "custom", "homepageId" must be specified. If set to "basic", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, "homepageId" must not be specified. The "basic" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.
  }
unenroll(enterpriseId) 
Unenrolls an enterprise from the calling EMM.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.entitlements.html000066400000000000000000000440551300622755700276300ustar00rootroot00000000000000

Google Play EMM API . entitlements

Instance Methods

delete(enterpriseId, userId, entitlementId)

Removes an entitlement to an app for a user and uninstalls it.

get(enterpriseId, userId, entitlementId)

Retrieves details of an entitlement.

list(enterpriseId, userId)

List of all entitlements for the specified user. Only the ID is set.

patch(enterpriseId, userId, entitlementId, body, install=None)

Adds or updates an entitlement to an app for a user. This method supports patch semantics.

update(enterpriseId, userId, entitlementId, body, install=None)

Adds or updates an entitlement to an app for a user.

Method Details

delete(enterpriseId, userId, entitlementId) 
Removes an entitlement to an app for a user and uninstalls it.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
get(enterpriseId, userId, entitlementId) 
Retrieves details of an entitlement.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)

Returns:
  An object of the form:

    { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
        #
        # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
        #
        # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
        #
        # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
        #
        # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
      "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
      "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
      "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
    }
list(enterpriseId, userId) 
List of all entitlements for the specified user. Only the ID is set.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # The entitlement resources for the user.
    "kind": "androidenterprise#entitlementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse".
    "entitlement": [ # An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.
      { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
            #
            # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
            #
            # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
            #
            # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
            #
            # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
          "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
          "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
          "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
        },
    ],
  }
patch(enterpriseId, userId, entitlementId, body, install=None) 
Adds or updates an entitlement to an app for a user. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
      # 
      # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
      # 
      # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
      # 
      # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
      # 
      # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
    "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
    "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
    "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
  }

  install: boolean, Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.

Returns:
  An object of the form:

    { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
        #
        # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
        #
        # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
        #
        # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
        #
        # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
      "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
      "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
      "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
    }
update(enterpriseId, userId, entitlementId, body, install=None) 
Adds or updates an entitlement to an app for a user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
      # 
      # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
      # 
      # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
      # 
      # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
      # 
      # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
    "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
    "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
    "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
  }

  install: boolean, Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.

Returns:
  An object of the form:

    { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.
        #
        # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.
        #
        # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.
        #
        # The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.
        #
        # Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
      "kind": "androidenterprise#entitlement", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
      "reason": "A String", # The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
      "productId": "A String", # The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.grouplicenses.html000066400000000000000000000166621300622755700300020ustar00rootroot00000000000000

Google Play EMM API . grouplicenses

Instance Methods

get(enterpriseId, groupLicenseId)

Retrieves details of an enterprise's group license for a product.

list(enterpriseId)

Retrieves IDs of all products for which the enterprise has a group license.

Method Details

get(enterpriseId, groupLicenseId) 
Retrieves details of an enterprise's group license for a product.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  groupLicenseId: string, The ID of the product the group license is for, e.g. "app:com.google.android.gm". (required)

Returns:
  An object of the form:

    { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin.
      #
      # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product.
      #
      # Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
    "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
    "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free").
    "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
    "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this group license object was created because the enterprise purchased licenses for this product; this is "free" otherwise (for free products).
    "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise, as either "approved" or "unapproved". Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections and new entitlements to them should not normally be created.
    "productId": "A String", # The ID of the product that the license is for, e.g. "app:com.google.android.gm".
  }
list(enterpriseId) 
Retrieves IDs of all products for which the enterprise has a group license.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    { # The grouplicense resources for the enterprise.
    "groupLicense": [ # A group license for a product approved for use in the enterprise.
      { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin.
          #
          # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product.
          #
          # Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
        "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
        "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free").
        "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
        "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this group license object was created because the enterprise purchased licenses for this product; this is "free" otherwise (for free products).
        "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise, as either "approved" or "unapproved". Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections and new entitlements to them should not normally be created.
        "productId": "A String", # The ID of the product that the license is for, e.g. "app:com.google.android.gm".
      },
    ],
    "kind": "androidenterprise#groupLicensesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.grouplicenseusers.html000066400000000000000000000102771300622755700306750ustar00rootroot00000000000000

Google Play EMM API . grouplicenseusers

Instance Methods

list(enterpriseId, groupLicenseId)

Retrieves the IDs of the users who have been granted entitlements under the license.

Method Details

list(enterpriseId, groupLicenseId) 
Retrieves the IDs of the users who have been granted entitlements under the license.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  groupLicenseId: string, The ID of the product the group license is for, e.g. "app:com.google.android.gm". (required)

Returns:
  An object of the form:

    { # The user resources for the group license.
    "kind": "androidenterprise#groupLicenseUsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse".
    "user": [ # A user of an enterprise.
      { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
            # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
            # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
          "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
          "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
          "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
          "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
          "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
          "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
          "id": "A String", # The unique ID for the user.
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.html000066400000000000000000000114121300622755700251050ustar00rootroot00000000000000

Google Play EMM API

Instance Methods

collections()

Returns the collections Resource.

collectionviewers()

Returns the collectionviewers Resource.

devices()

Returns the devices Resource.

enterprises()

Returns the enterprises Resource.

entitlements()

Returns the entitlements Resource.

grouplicenses()

Returns the grouplicenses Resource.

grouplicenseusers()

Returns the grouplicenseusers Resource.

installs()

Returns the installs Resource.

managedconfigurationsfordevice()

Returns the managedconfigurationsfordevice Resource.

managedconfigurationsforuser()

Returns the managedconfigurationsforuser Resource.

permissions()

Returns the permissions Resource.

products()

Returns the products Resource.

serviceaccountkeys()

Returns the serviceaccountkeys Resource.

storelayoutclusters()

Returns the storelayoutclusters Resource.

storelayoutpages()

Returns the storelayoutpages Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.installs.html000066400000000000000000000427411300622755700267460ustar00rootroot00000000000000

Google Play EMM API . installs

Instance Methods

delete(enterpriseId, userId, deviceId, installId)

Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.

get(enterpriseId, userId, deviceId, installId)

Retrieves details of an installation of an app on a device.

list(enterpriseId, userId, deviceId)

Retrieves the details of all apps installed on the specified device.

patch(enterpriseId, userId, deviceId, installId, body)

Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary. This method supports patch semantics.

update(enterpriseId, userId, deviceId, installId, body)

Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary.

Method Details

delete(enterpriseId, userId, deviceId, installId) 
Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
get(enterpriseId, userId, deviceId, installId) 
Retrieves details of an installation of an app on a device.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)

Returns:
  An object of the form:

    { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
        #
        # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
        #
        # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
        #
        # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
        #
        # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
        #
        # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
      "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
      "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
      "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
      "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
    }
list(enterpriseId, userId, deviceId) 
Retrieves the details of all apps installed on the specified device.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)

Returns:
  An object of the form:

    { # The install resources for the device.
    "kind": "androidenterprise#installsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse".
    "install": [ # An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.
      { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
            #
            # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
            #
            # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
            #
            # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
            #
            # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
            #
            # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
          "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
          "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
          "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
          "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
        },
    ],
  }
patch(enterpriseId, userId, deviceId, installId, body) 
Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
      # 
      # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
      # 
      # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
      # 
      # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
      # 
      # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
      # 
      # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
    "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
    "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
    "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
    "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
  }


Returns:
  An object of the form:

    { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
        #
        # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
        #
        # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
        #
        # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
        #
        # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
        #
        # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
      "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
      "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
      "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
      "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
    }
update(enterpriseId, userId, deviceId, installId, body) 
Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
      # 
      # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
      # 
      # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
      # 
      # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
      # 
      # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
      # 
      # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
    "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
    "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
    "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
    "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
  }


Returns:
  An object of the form:

    { # The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).
        #
        # The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.
        #
        # The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.
        #
        # Note that it is not possible to force the installation of a specific version of an app; the version code is read-only.
        #
        # If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.
        #
        # The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
      "installState": "A String", # Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
      "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed".
      "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
      "productId": "A String", # The ID of the product that the install is for, e.g. "app:com.google.android.gm".
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html000066400000000000000000000446161300622755700333560ustar00rootroot00000000000000

Google Play EMM API . managedconfigurationsfordevice

Instance Methods

delete(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)

Removes a per-device managed configuration for an app for the specified device.

get(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)

Retrieves details of a per-device managed configuration.

list(enterpriseId, userId, deviceId)

Lists all the per-device managed configurations for the specified device. Only the ID is set.

patch(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)

Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.

update(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)

Adds or updates a per-device managed configuration for an app for the specified device.

Method Details

delete(enterpriseId, userId, deviceId, managedConfigurationForDeviceId) 
Removes a per-device managed configuration for an app for the specified device.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
get(enterpriseId, userId, deviceId, managedConfigurationForDeviceId) 
Retrieves details of a per-device managed configuration.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)

Returns:
  An object of the form:

    { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
      "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
      "managedProperty": [ # The set of managed properties for this configuration.
        { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
          "key": "A String", # The unique key that identifies the property.
          "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
          "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
            "A String",
          ],
          "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
          "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              "managedProperty": [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
        },
      ],
      "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
    }
list(enterpriseId, userId, deviceId) 
Lists all the per-device managed configurations for the specified device. Only the ID is set.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)

Returns:
  An object of the form:

    { # The managed configuration resources for the device.
    "kind": "androidenterprise#managedConfigurationsForDeviceListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForDeviceListResponse".
    "managedConfigurationForDevice": [ # A managed configuration for an app on a specific device.
      { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
          "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
          "managedProperty": [ # The set of managed properties for this configuration.
            { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
              "key": "A String", # The unique key that identifies the property.
              "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
              "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
                "A String",
              ],
              "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
              "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
                { # A bundle of managed properties.
                  "managedProperty": [ # The list of managed properties.
                    # Object with schema name: ManagedProperty
                  ],
                },
              ],
              "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
                "managedProperty": [ # The list of managed properties.
                  # Object with schema name: ManagedProperty
                ],
              },
              "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
            },
          ],
          "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
        },
    ],
  }
patch(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body) 
Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
    "managedProperty": [ # The set of managed properties for this configuration.
      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
        "key": "A String", # The unique key that identifies the property.
        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
          "A String",
        ],
        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
          { # A bundle of managed properties.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
        ],
        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
          "managedProperty": [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
      },
    ],
    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
  }


Returns:
  An object of the form:

    { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
      "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
      "managedProperty": [ # The set of managed properties for this configuration.
        { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
          "key": "A String", # The unique key that identifies the property.
          "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
          "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
            "A String",
          ],
          "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
          "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              "managedProperty": [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
        },
      ],
      "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
    }
update(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body) 
Adds or updates a per-device managed configuration for an app for the specified device.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  deviceId: string, The Android ID of the device. (required)
  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
    "managedProperty": [ # The set of managed properties for this configuration.
      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
        "key": "A String", # The unique key that identifies the property.
        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
          "A String",
        ],
        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
          { # A bundle of managed properties.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
        ],
        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
          "managedProperty": [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
      },
    ],
    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
  }


Returns:
  An object of the form:

    { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
      "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
      "managedProperty": [ # The set of managed properties for this configuration.
        { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
          "key": "A String", # The unique key that identifies the property.
          "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
          "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
            "A String",
          ],
          "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
          "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              "managedProperty": [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
        },
      ],
      "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html000066400000000000000000000437641300622755700331000ustar00rootroot00000000000000

Google Play EMM API . managedconfigurationsforuser

Instance Methods

delete(enterpriseId, userId, managedConfigurationForUserId)

Removes a per-user managed configuration for an app for the specified user.

get(enterpriseId, userId, managedConfigurationForUserId)

Retrieves details of a per-user managed configuration for an app for the specified user.

list(enterpriseId, userId)

Lists all the per-user managed configurations for the specified user. Only the ID is set.

patch(enterpriseId, userId, managedConfigurationForUserId, body)

Adds or updates a per-user managed configuration for an app for the specified user. This method supports patch semantics.

update(enterpriseId, userId, managedConfigurationForUserId, body)

Adds or updates a per-user managed configuration for an app for the specified user.

Method Details

delete(enterpriseId, userId, managedConfigurationForUserId) 
Removes a per-user managed configuration for an app for the specified user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
get(enterpriseId, userId, managedConfigurationForUserId) 
Retrieves details of a per-user managed configuration for an app for the specified user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)

Returns:
  An object of the form:

    { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
      "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
      "managedProperty": [ # The set of managed properties for this configuration.
        { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
          "key": "A String", # The unique key that identifies the property.
          "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
          "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
            "A String",
          ],
          "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
          "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              "managedProperty": [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
        },
      ],
      "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
    }
list(enterpriseId, userId) 
Lists all the per-user managed configurations for the specified user. Only the ID is set.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # The managed configuration resources for the user.
    "kind": "androidenterprise#managedConfigurationsForUserListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForUserListResponse".
    "managedConfigurationForUser": [ # A managed configuration for an app for a specific user.
      { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
          "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
          "managedProperty": [ # The set of managed properties for this configuration.
            { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
              "key": "A String", # The unique key that identifies the property.
              "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
              "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
                "A String",
              ],
              "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
              "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
                { # A bundle of managed properties.
                  "managedProperty": [ # The list of managed properties.
                    # Object with schema name: ManagedProperty
                  ],
                },
              ],
              "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
                "managedProperty": [ # The list of managed properties.
                  # Object with schema name: ManagedProperty
                ],
              },
              "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
            },
          ],
          "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
        },
    ],
  }
patch(enterpriseId, userId, managedConfigurationForUserId, body) 
Adds or updates a per-user managed configuration for an app for the specified user. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
    "managedProperty": [ # The set of managed properties for this configuration.
      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
        "key": "A String", # The unique key that identifies the property.
        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
          "A String",
        ],
        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
          { # A bundle of managed properties.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
        ],
        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
          "managedProperty": [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
      },
    ],
    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
  }


Returns:
  An object of the form:

    { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
      "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
      "managedProperty": [ # The set of managed properties for this configuration.
        { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
          "key": "A String", # The unique key that identifies the property.
          "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
          "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
            "A String",
          ],
          "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
          "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              "managedProperty": [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
        },
      ],
      "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
    }
update(enterpriseId, userId, managedConfigurationForUserId, body) 
Adds or updates a per-user managed configuration for an app for the specified user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
    "managedProperty": [ # The set of managed properties for this configuration.
      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
        "key": "A String", # The unique key that identifies the property.
        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
          "A String",
        ],
        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
          { # A bundle of managed properties.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
        ],
        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
          "managedProperty": [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
      },
    ],
    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
  }


Returns:
  An object of the form:

    { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema.
      "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
      "managedProperty": [ # The set of managed properties for this configuration.
        { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
          "key": "A String", # The unique key that identifies the property.
          "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
          "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
            "A String",
          ],
          "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
          "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              "managedProperty": [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            "managedProperty": [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
        },
      ],
      "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.permissions.html000066400000000000000000000050651300622755700274660ustar00rootroot00000000000000

Google Play EMM API . permissions

Instance Methods

get(permissionId, language=None)

Retrieves details of an Android app permission for display to an enterprise admin.

Method Details

get(permissionId, language=None) 
Retrieves details of an Android app permission for display to an enterprise admin.

Args:
  permissionId: string, The ID of the permission. (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de")

Returns:
  An object of the form:

    { # A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.
      #
      # The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the EMM user interface when obtaining consent from the enterprise.
    "permissionId": "A String", # An opaque string uniquely identifying the permission.
    "kind": "androidenterprise#permission", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission".
    "description": "A String", # A longer description of the permissions giving more details of what it affects.
    "name": "A String", # The name of the permission.
  }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.products.html000066400000000000000000000536451300622755700267650ustar00rootroot00000000000000

Google Play EMM API . products

Instance Methods

approve(enterpriseId, productId, body)

Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000.

generateApprovalUrl(enterpriseId, productId, languageCode=None)

Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.

get(enterpriseId, productId, language=None)

Retrieves details of a product for display to an enterprise admin.

getAppRestrictionsSchema(enterpriseId, productId, language=None)

Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an administrator to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.

getPermissions(enterpriseId, productId)

Retrieves the Android app permissions required by this app.

list(enterpriseId, language=None, maxResults=None, token=None, query=None, approved=None)

Finds approved products that match a query, or all approved products if there is no query.

unapprove(enterpriseId, productId)

Unapproves the specified product (and the relevant app permissions, if any)

updatePermissions(enterpriseId, productId, body)

This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements.

Method Details

approve(enterpriseId, productId, body) 
Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000.

To learn how to use Google Play for Work to design and create a store layout to display approved products to your users, see Store Layout Design.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "approvalUrlInfo": { # Information on an approval URL. # The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated.
      "kind": "androidenterprise#approvalUrlInfo", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo".
      "approvalUrl": "A String", # A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.
    },
  }
generateApprovalUrl(enterpriseId, productId, languageCode=None) 
Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.

Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  languageCode: string, The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".

Returns:
  An object of the form:

    {
    "url": "A String", # A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
  }
get(enterpriseId, productId, language=None) 
Retrieves details of a product for display to an enterprise admin.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product, e.g. "app:com.google.android.gm". (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

Returns:
  An object of the form:

    { # A Products resource represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)
      #
      # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
    "smallIconUrl": "A String", # A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px.
    "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
    "distributionChannel": "A String", # How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.
    "title": "A String", # The name of the product.
    "workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
    "appVersion": [ # App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included.
      { # This represents a single version of the app.
        "versionCode": 42, # Unique increasing identifier for the app version.
        "versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4").
      },
    ],
    "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it).
    "iconUrl": "A String", # A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.
    "authorName": "A String", # The name of the author of the product (e.g. the app developer).
    "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app.
    "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
    "productId": "A String", # A string of the form app:. For example, app:com.google.android.gm represents the Gmail app.
  }
getAppRestrictionsSchema(enterpriseId, productId, language=None) 
Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an administrator to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

Returns:
  An object of the form:

    { # Represents the list of app restrictions available to be pre-configured for the product.
    "restrictions": [ # The set of restrictions that make up this schema.
      { # A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
        "description": "A String", # A longer description of the restriction, giving more detail of what it affects.
        "title": "A String", # The name of the restriction.
        "defaultValue": { # A typed value for the restriction. # The default value of the restriction. bundle and bundleArray restrictions never have a default value.
          "valueBool": True or False, # The boolean value - this will only be present if type is bool.
          "valueString": "A String", # The string value - this will be present for types string, choice and hidden.
          "type": "A String", # The type of the value being provided.
          "valueMultiselect": [ # The list of string values - this will only be present if type is multiselect.
            "A String",
          ],
          "valueInteger": 42, # The integer value - this will only be present if type is integer.
        },
        "nestedRestriction": [ # For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.
          # Object with schema name: AppRestrictionsSchemaRestriction
        ],
        "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.
          "A String",
        ],
        "key": "A String", # The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
        "entry": [ # For choice or multiselect restrictions, the list of possible entries' human-readable names.
          "A String",
        ],
        "restrictionType": "A String", # The type of the restriction.
      },
    ],
    "kind": "androidenterprise#appRestrictionsSchema", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema".
  }
getPermissions(enterpriseId, productId) 
Retrieves the Android app permissions required by this app.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)

Returns:
  An object of the form:

    { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
      "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
      "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
      "permission": [ # The permissions required by the app.
        { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
            #
            # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
          "permissionId": "A String", # An opaque string uniquely identifying the permission.
          "state": "A String", # Whether the permission has been accepted or not.
        },
      ],
    }
list(enterpriseId, language=None, maxResults=None, token=None, query=None, approved=None) 
Finds approved products that match a query, or all approved products if there is no query.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language.
  maxResults: integer, Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response.
  token: string, A pagination token is contained in a request’s response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request.
  query: string, The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).
  approved: boolean, Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified.

Returns:
  An object of the form:

    { # The matching products.
    "product": [ # Information about a product (e.g. an app) in the Google Play Store, for display to an enterprise admin.
      { # A Products resource represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)
          #
          # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
        "smallIconUrl": "A String", # A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px.
        "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
        "distributionChannel": "A String", # How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.
        "title": "A String", # The name of the product.
        "workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
        "appVersion": [ # App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included.
          { # This represents a single version of the app.
            "versionCode": 42, # Unique increasing identifier for the app version.
            "versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4").
          },
        ],
        "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it).
        "iconUrl": "A String", # A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.
        "authorName": "A String", # The name of the author of the product (e.g. the app developer).
        "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app.
        "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
        "productId": "A String", # A string of the form app:. For example, app:com.google.android.gm represents the Gmail app.
      },
    ],
    "kind": "androidenterprise#productsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse".
    "tokenPagination": { # Pagination information for token pagination.
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": { # General pagination information.
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
  }
unapprove(enterpriseId, productId) 
Unapproves the specified product (and the relevant app permissions, if any)

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
updatePermissions(enterpriseId, productId, body) 
This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the  generateApprovalUrl and  approve methods of the Products resource. For more information, see the  Play EMM API usage requirements.

The updatePermissions method (deprecated) updates the set of Android app permissions for this app that have been accepted by the enterprise.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
    "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
    "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
    "permission": [ # The permissions required by the app.
      { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
          #
          # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
        "permissionId": "A String", # An opaque string uniquely identifying the permission.
        "state": "A String", # Whether the permission has been accepted or not.
      },
    ],
  }


Returns:
  An object of the form:

    { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
      "kind": "androidenterprise#productPermissions", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
      "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
      "permission": [ # The permissions required by the app.
        { # A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
            #
            # The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
          "permissionId": "A String", # An opaque string uniquely identifying the permission.
          "state": "A String", # Whether the permission has been accepted or not.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.serviceaccountkeys.html000066400000000000000000000134361300622755700310250ustar00rootroot00000000000000

Google Play EMM API . serviceaccountkeys

Instance Methods

delete(enterpriseId, keyId)

Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

insert(enterpriseId, body)

Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

list(enterpriseId)

Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

Method Details

delete(enterpriseId, keyId) 
Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  keyId: string, The ID of the key. (required)
insert(enterpriseId, body) 
Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

Only the type of the key should be populated in the resource to be inserted.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Credentials that can be used to authenticate as a service account.
  "type": "A String", # The file format of the generated key data.
  "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey".
  "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
  "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
}


Returns:
  An object of the form:

    { # Credentials that can be used to authenticate as a service account.
    "type": "A String", # The file format of the generated key data.
    "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey".
    "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
    "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
  }
list(enterpriseId) 
Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    {
    "serviceAccountKey": [ # The service account credentials.
      { # Credentials that can be used to authenticate as a service account.
        "type": "A String", # The file format of the generated key data.
        "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey".
        "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
        "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.storelayoutclusters.html000066400000000000000000000400051300622755700312630ustar00rootroot00000000000000

Google Play EMM API . storelayoutclusters

Instance Methods

delete(enterpriseId, pageId, clusterId)

Deletes a cluster.

get(enterpriseId, pageId, clusterId)

Retrieves details of a cluster.

insert(enterpriseId, pageId, body)

Inserts a new cluster in a page.

list(enterpriseId, pageId)

Retrieves the details of all clusters on the specified page.

patch(enterpriseId, pageId, clusterId, body)

Updates a cluster. This method supports patch semantics.

update(enterpriseId, pageId, clusterId, body)

Updates a cluster.

Method Details

delete(enterpriseId, pageId, clusterId) 
Deletes a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
get(enterpriseId, pageId, clusterId) 
Retrieves details of a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)

Returns:
  An object of the form:

    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
insert(enterpriseId, pageId, body) 
Inserts a new cluster in a page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
        # 
        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
list(enterpriseId, pageId) 
Retrieves the details of all clusters on the specified page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)

Returns:
  An object of the form:

    { # The store page resources for the enterprise.
    "cluster": [ # A store cluster of an enterprise.
      { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
          "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
          "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
              #
              # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
          "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
            "A String",
          ],
          "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
          "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
            { # A localized string with its locale.
              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
              "text": "A String", # The text localized in the associated locale.
            },
          ],
        },
    ],
    "kind": "androidenterprise#storeLayoutClustersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
  }
patch(enterpriseId, pageId, clusterId, body) 
Updates a cluster. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
        # 
        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
update(enterpriseId, pageId, clusterId, body) 
Updates a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
        # 
        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.storelayoutpages.html000066400000000000000000000351751300622755700305320ustar00rootroot00000000000000

Google Play EMM API . storelayoutpages

Instance Methods

delete(enterpriseId, pageId)

Deletes a store page.

get(enterpriseId, pageId)

Retrieves details of a store page.

insert(enterpriseId, body)

Inserts a new store page.

list(enterpriseId)

Retrieves the details of all pages in the store.

patch(enterpriseId, pageId, body)

Updates the content of a store page. This method supports patch semantics.

update(enterpriseId, pageId, body)

Updates the content of a store page.

Method Details

delete(enterpriseId, pageId) 
Deletes a store page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
get(enterpriseId, pageId) 
Retrieves details of a store page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)

Returns:
  An object of the form:

    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
          #
          # No attempt is made to verify that all pages are reachable from the homepage.
        "A String",
      ],
      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
insert(enterpriseId, body) 
Inserts a new store page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
        # 
        # No attempt is made to verify that all pages are reachable from the homepage.
      "A String",
    ],
    "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
          #
          # No attempt is made to verify that all pages are reachable from the homepage.
        "A String",
      ],
      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
list(enterpriseId) 
Retrieves the details of all pages in the store.

Args:
  enterpriseId: string, The ID of the enterprise. (required)

Returns:
  An object of the form:

    { # The store page resources for the enterprise.
    "kind": "androidenterprise#storeLayoutPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse".
    "page": [ # A store page of an enterprise.
      { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
          "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
          "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
              #
              # No attempt is made to verify that all pages are reachable from the homepage.
            "A String",
          ],
          "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
          "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
            { # A localized string with its locale.
              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
              "text": "A String", # The text localized in the associated locale.
            },
          ],
        },
    ],
  }
patch(enterpriseId, pageId, body) 
Updates the content of a store page. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
        # 
        # No attempt is made to verify that all pages are reachable from the homepage.
      "A String",
    ],
    "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
          #
          # No attempt is made to verify that all pages are reachable from the homepage.
        "A String",
      ],
      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
update(enterpriseId, pageId, body) 
Updates the content of a store page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
        # 
        # No attempt is made to verify that all pages are reachable from the homepage.
      "A String",
    ],
    "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
          #
          # No attempt is made to verify that all pages are reachable from the homepage.
        "A String",
      ],
      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/androidenterprise_v1.users.html000066400000000000000000000714571300622755700262640ustar00rootroot00000000000000

Google Play EMM API . users

Instance Methods

delete(enterpriseId, userId)

Deleted an EMM-managed user.

generateAuthenticationToken(enterpriseId, userId)

Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.

generateToken(enterpriseId, userId)

Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.

get(enterpriseId, userId)

Retrieves a user's details.

getAvailableProductSet(enterpriseId, userId)

Retrieves the set of products a user is entitled to access.

insert(enterpriseId, body)

Creates a new EMM-managed user.

list(enterpriseId, email)

Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.

patch(enterpriseId, userId, body)

Updates the details of an EMM-managed user.

revokeToken(enterpriseId, userId)

Revokes a previously generated token (activation code) for the user.

setAvailableProductSet(enterpriseId, userId, body)

Modifies the set of products a user is entitled to access.

update(enterpriseId, userId, body)

Updates the details of an EMM-managed user.

Method Details

delete(enterpriseId, userId) 
Deleted an EMM-managed user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
generateAuthenticationToken(enterpriseId, userId) 
Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.

This call only works with EMM-managed accounts.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
    "kind": "androidenterprise#authenticationToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken".
    "token": "A String", # The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.
  }
generateToken(enterpriseId, userId) 
Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.

This call only works with Google managed accounts.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.
    "kind": "androidenterprise#userToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
    "userId": "A String", # The unique ID for the user.
    "token": "A String", # The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
  }
get(enterpriseId, userId) 
Retrieves a user's details.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
getAvailableProductSet(enterpriseId, userId) 
Retrieves the set of products a user is entitled to access.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)

Returns:
  An object of the form:

    { # A set of products.
      "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
      "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and ignored if received. "whitelist" means that this product set constitutes a whitelist. "includeAll" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be "whitelist" for backwards compatibility.
      "productId": [ # The list of product IDs making up the set of products.
        "A String",
      ],
    }
insert(enterpriseId, body) 
Creates a new EMM-managed user.

The Users resource passed in the body of the request should include an accountIdentifier and an accountType.
If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
      # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
      # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
    "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
    "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
    "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
    "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
    "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
    "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
    "id": "A String", # The unique ID for the user.
  }


Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
list(enterpriseId, email) 
Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  email: string, The exact primary email address of the user to look up. (required)

Returns:
  An object of the form:

    { # The matching user resources.
    "kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
    "user": [ # A user of an enterprise.
      { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
            # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
            # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
          "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
          "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
          "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
          "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
          "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
          "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
          "id": "A String", # The unique ID for the user.
        },
    ],
  }
patch(enterpriseId, userId, body) 
Updates the details of an EMM-managed user.

Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
      # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
      # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
    "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
    "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
    "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
    "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
    "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
    "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
    "id": "A String", # The unique ID for the user.
  }


Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
revokeToken(enterpriseId, userId) 
Revokes a previously generated token (activation code) for the user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
setAvailableProductSet(enterpriseId, userId, body) 
Modifies the set of products a user is entitled to access.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A set of products.
    "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
    "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and ignored if received. "whitelist" means that this product set constitutes a whitelist. "includeAll" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be "whitelist" for backwards compatibility.
    "productId": [ # The list of product IDs making up the set of products.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # A set of products.
      "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
      "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and ignored if received. "whitelist" means that this product set constitutes a whitelist. "includeAll" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be "whitelist" for backwards compatibility.
      "productId": [ # The list of product IDs making up the set of products.
        "A String",
      ],
    }
update(enterpriseId, userId, body) 
Updates the details of an EMM-managed user.

Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
      # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
      # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
    "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
    "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
    "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
    "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
    "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
    "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
    "id": "A String", # The unique ID for the user.
  }


Returns:
  An object of the form:

    { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
        # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
        # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
      "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
      "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
      "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
      "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
      "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
      "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
      "id": "A String", # The unique ID for the user.
    }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v1.html000066400000000000000000000041551300622755700247300ustar00rootroot00000000000000

Google Play Developer API

Instance Methods

purchases()

Returns the purchases Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v1.purchases.html000066400000000000000000000064551300622755700267310ustar00rootroot00000000000000

Google Play Developer API . purchases

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 SubscriptionPurchase resource indicates the status of a user's subscription purchase.
    "initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since the 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 the Epoch.
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v1_1.html000066400000000000000000000044451300622755700251520ustar00rootroot00000000000000

Google Play Developer API

Instance Methods

inapppurchases()

Returns the inapppurchases Resource.

purchases()

Returns the purchases Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v1_1.inapppurchases.html000066400000000000000000000050751300622755700301760ustar00rootroot00000000000000

Google Play Developer API . inapppurchases

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:

    { # An InappPurchase resource indicates the status of a user's inapp product purchase.
    "consumptionState": 42, # The consumption state of the inapp product. Possible values are:
        # - Yet to be consumed
        # - Consumed
    "developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
    "kind": "androidpublisher#inappPurchase", # This kind represents an 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
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v1_1.purchases.html000066400000000000000000000064611300622755700271460ustar00rootroot00000000000000

Google Play Developer API . purchases

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 SubscriptionPurchase resource indicates the status of a user's subscription purchase.
    "initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since the 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 the Epoch.
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.apklistings.html000066400000000000000000000174531300622755700303740ustar00rootroot00000000000000

Google Play Developer API . edits . apklistings

Instance Methods

delete(packageName, editId, apkVersionCode, language)

Deletes the APK-specific localized listing for a specified APK and language code.

deleteall(packageName, editId, apkVersionCode)

Deletes all the APK-specific localized listings for a specified APK.

get(packageName, editId, apkVersionCode, language)

Fetches the APK-specific localized listing for a specified APK and language code.

list(packageName, editId, apkVersionCode)

Lists all the APK-specific localized listings for a specified APK.

patch(packageName, editId, apkVersionCode, language, body)

Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.

update(packageName, editId, apkVersionCode, language, body)

Updates or creates the APK-specific localized listing for a specified APK and language code.

Method Details

delete(packageName, editId, apkVersionCode, language) 
Deletes the APK-specific localized listing for a specified APK and language code.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The APK version code whose APK-specific listings should be read or modified. (required)
  language: string, The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)
deleteall(packageName, editId, apkVersionCode) 
Deletes all the APK-specific localized listings for a specified APK.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The APK version code whose APK-specific listings should be read or modified. (required)
get(packageName, editId, apkVersionCode, language) 
Fetches the APK-specific localized listing for a specified APK and language code.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The APK version code whose APK-specific listings should be read or modified. (required)
  language: string, The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)

Returns:
  An object of the form:

    {
    "recentChanges": "A String", # Describe what's new in your APK.
    "language": "A String", # The language code, in BCP 47 format (eg "en-US").
  }
list(packageName, editId, apkVersionCode) 
Lists all the APK-specific localized listings for a specified APK.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The APK version code whose APK-specific listings should be read or modified. (required)

Returns:
  An object of the form:

    {
    "kind": "androidpublisher#apkListingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apkListingsListResponse".
    "listings": [
      {
        "recentChanges": "A String", # Describe what's new in your APK.
        "language": "A String", # The language code, in BCP 47 format (eg "en-US").
      },
    ],
  }
patch(packageName, editId, apkVersionCode, language, body) 
Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The APK version code whose APK-specific listings should be read or modified. (required)
  language: string, The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "recentChanges": "A String", # Describe what's new in your APK.
  "language": "A String", # The language code, in BCP 47 format (eg "en-US").
}


Returns:
  An object of the form:

    {
    "recentChanges": "A String", # Describe what's new in your APK.
    "language": "A String", # The language code, in BCP 47 format (eg "en-US").
  }
update(packageName, editId, apkVersionCode, language, body) 
Updates or creates the APK-specific localized listing for a specified APK and language code.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The APK version code whose APK-specific listings should be read or modified. (required)
  language: string, The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "recentChanges": "A String", # Describe what's new in your APK.
  "language": "A String", # The language code, in BCP 47 format (eg "en-US").
}


Returns:
  An object of the form:

    {
    "recentChanges": "A String", # Describe what's new in your APK.
    "language": "A String", # The language code, in BCP 47 format (eg "en-US").
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.apks.html000066400000000000000000000203561300622755700267760ustar00rootroot00000000000000

Google Play Developer API . edits . apks

Instance Methods

addexternallyhosted(packageName, editId, body)

Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.

list(packageName, editId)

A description of how to use this function

upload(packageName, editId, media_body=None)

A description of how to use this function

Method Details

addexternallyhosted(packageName, editId, body) 
Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "externallyHostedApk": { # Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel # The definition of the externally-hosted APK and where it is located.
      "iconBase64": "A String", # The icon image from the APK, as a base64 encoded byte array.
      "certificateBase64s": [ # A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.
        "A String",
      ],
      "externallyHostedUrl": "A String", # The URL at which the APK is hosted. This must be an https URL.
      "maximumSdk": 42, # The maximum SDK supported by this APK (optional).
      "fileSha256Base64": "A String", # The SHA256 checksum of this APK, represented as a base64 encoded byte array.
      "usesPermissions": [ # The permissions requested by this APK.
        { # A permission used by this APK.
          "maxSdkVersion": 42, # Optionally, the maximum SDK version for which the permission is required.
          "name": "A String", # The name of the permission requested.
        },
      ],
      "fileSha1Base64": "A String", # The SHA1 checksum of this APK, represented as a base64 encoded byte array.
      "usesFeatures": [ # The features required by this APK (optional).
        "A String",
      ],
      "fileSize": "A String", # The file size in bytes of this APK.
      "versionName": "A String", # The version name of this APK.
      "versionCode": 42, # The version code of this APK.
      "packageName": "A String", # The package name.
      "minimumSdk": 42, # The minimum SDK targeted by this APK.
      "applicationLabel": "A String", # The application label.
      "nativeCodes": [ # The native code environments supported by this APK (optional).
        "A String",
      ],
    },
  }


Returns:
  An object of the form:

    {
    "externallyHostedApk": { # Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel # The definition of the externally-hosted APK and where it is located.
      "iconBase64": "A String", # The icon image from the APK, as a base64 encoded byte array.
      "certificateBase64s": [ # A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.
        "A String",
      ],
      "externallyHostedUrl": "A String", # The URL at which the APK is hosted. This must be an https URL.
      "maximumSdk": 42, # The maximum SDK supported by this APK (optional).
      "fileSha256Base64": "A String", # The SHA256 checksum of this APK, represented as a base64 encoded byte array.
      "usesPermissions": [ # The permissions requested by this APK.
        { # A permission used by this APK.
          "maxSdkVersion": 42, # Optionally, the maximum SDK version for which the permission is required.
          "name": "A String", # The name of the permission requested.
        },
      ],
      "fileSha1Base64": "A String", # The SHA1 checksum of this APK, represented as a base64 encoded byte array.
      "usesFeatures": [ # The features required by this APK (optional).
        "A String",
      ],
      "fileSize": "A String", # The file size in bytes of this APK.
      "versionName": "A String", # The version name of this APK.
      "versionCode": 42, # The version code of this APK.
      "packageName": "A String", # The package name.
      "minimumSdk": 42, # The minimum SDK targeted by this APK.
      "applicationLabel": "A String", # The application label.
      "nativeCodes": [ # The native code environments supported by this APK (optional).
        "A String",
      ],
    },
  }
list(packageName, editId) 
A description of how to use this function

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    {
    "apks": [
      {
        "versionCode": 42, # The version code of the APK, as specified in the APK's manifest file.
        "binary": { # Represents the binary payload of an APK. # Information about the binary payload of this APK.
          "sha1": "A String", # A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
        },
      },
    ],
    "kind": "androidpublisher#apksListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse".
  }
upload(packageName, editId, media_body=None) 
A description of how to use this function

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    {
    "versionCode": 42, # The version code of the APK, as specified in the APK's manifest file.
    "binary": { # Represents the binary payload of an APK. # Information about the binary payload of this APK.
      "sha1": "A String", # A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
    },
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.deobfuscationfiles.html000066400000000000000000000047061300622755700317110ustar00rootroot00000000000000

Google Play Developer API . edits . deobfuscationfiles

Instance Methods

upload(packageName, editId, apkVersionCode, deobfuscationFileType, media_body=None)

Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.

Method Details

upload(packageName, editId, apkVersionCode, deobfuscationFileType, media_body=None) 
Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.

Args:
  packageName: string, Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The version code of the APK whose deobfuscation file is being uploaded. (required)
  deobfuscationFileType: string, A parameter (required)
    Allowed values
      proguard - 
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    {
    "deobfuscationFile": { # Represents a deobfuscation file.
      "symbolType": "A String", # The type of the deobfuscation file.
    },
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.details.html000066400000000000000000000115161300622755700274630ustar00rootroot00000000000000

Google Play Developer API . edits . details

Instance Methods

get(packageName, editId)

Fetches app details for this edit. This includes the default language and developer support contact information.

patch(packageName, editId, body)

Updates app details for this edit. This method supports patch semantics.

update(packageName, editId, body)

Updates app details for this edit.

Method Details

get(packageName, editId) 
Fetches app details for this edit. This includes the default language and developer support contact information.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    {
      "contactEmail": "A String", # The user-visible support email for this app.
      "contactPhone": "A String", # The user-visible support telephone number for this app.
      "contactWebsite": "A String", # The user-visible website for this app.
      "defaultLanguage": "A String", # Default language code, in BCP 47 format (eg "en-US").
    }
patch(packageName, editId, body) 
Updates app details for this edit. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "contactEmail": "A String", # The user-visible support email for this app.
    "contactPhone": "A String", # The user-visible support telephone number for this app.
    "contactWebsite": "A String", # The user-visible website for this app.
    "defaultLanguage": "A String", # Default language code, in BCP 47 format (eg "en-US").
  }


Returns:
  An object of the form:

    {
      "contactEmail": "A String", # The user-visible support email for this app.
      "contactPhone": "A String", # The user-visible support telephone number for this app.
      "contactWebsite": "A String", # The user-visible website for this app.
      "defaultLanguage": "A String", # Default language code, in BCP 47 format (eg "en-US").
    }
update(packageName, editId, body) 
Updates app details for this edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "contactEmail": "A String", # The user-visible support email for this app.
    "contactPhone": "A String", # The user-visible support telephone number for this app.
    "contactWebsite": "A String", # The user-visible website for this app.
    "defaultLanguage": "A String", # Default language code, in BCP 47 format (eg "en-US").
  }


Returns:
  An object of the form:

    {
      "contactEmail": "A String", # The user-visible support email for this app.
      "contactPhone": "A String", # The user-visible support telephone number for this app.
      "contactWebsite": "A String", # The user-visible website for this app.
      "defaultLanguage": "A String", # Default language code, in BCP 47 format (eg "en-US").
    }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.expansionfiles.html000066400000000000000000000172571300622755700310750ustar00rootroot00000000000000

Google Play Developer API . edits . expansionfiles

Instance Methods

get(packageName, editId, apkVersionCode, expansionFileType)

Fetches the Expansion File configuration for the APK specified.

patch(packageName, editId, apkVersionCode, expansionFileType, body)

Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.

update(packageName, editId, apkVersionCode, expansionFileType, body)

Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.

upload(packageName, editId, apkVersionCode, expansionFileType, media_body=None)

Uploads and attaches a new Expansion File to the APK specified.

Method Details

get(packageName, editId, apkVersionCode, expansionFileType) 
Fetches the Expansion File configuration for the APK specified.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The version code of the APK whose Expansion File configuration is being read or modified. (required)
  expansionFileType: string, A parameter (required)
    Allowed values
      main - 
      patch - 

Returns:
  An object of the form:

    {
      "referencesVersion": 42, # If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
      "fileSize": "A String", # If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
    }
patch(packageName, editId, apkVersionCode, expansionFileType, body) 
Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The version code of the APK whose Expansion File configuration is being read or modified. (required)
  expansionFileType: string, A parameter (required)
    Allowed values
      main - 
      patch - 
  body: object, The request body. (required)
    The object takes the form of:

{
    "referencesVersion": 42, # If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
    "fileSize": "A String", # If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
  }


Returns:
  An object of the form:

    {
      "referencesVersion": 42, # If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
      "fileSize": "A String", # If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
    }
update(packageName, editId, apkVersionCode, expansionFileType, body) 
Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The version code of the APK whose Expansion File configuration is being read or modified. (required)
  expansionFileType: string, A parameter (required)
    Allowed values
      main - 
      patch - 
  body: object, The request body. (required)
    The object takes the form of:

{
    "referencesVersion": 42, # If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
    "fileSize": "A String", # If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
  }


Returns:
  An object of the form:

    {
      "referencesVersion": 42, # If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
      "fileSize": "A String", # If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
    }
upload(packageName, editId, apkVersionCode, expansionFileType, media_body=None) 
Uploads and attaches a new Expansion File to the APK specified.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  apkVersionCode: integer, The version code of the APK whose Expansion File configuration is being read or modified. (required)
  expansionFileType: string, A parameter (required)
    Allowed values
      main - 
      patch - 
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    {
    "expansionFile": {
        "referencesVersion": 42, # If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.
        "fileSize": "A String", # If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.
      },
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.html000066400000000000000000000175411300622755700260430ustar00rootroot00000000000000

Google Play Developer API . edits

Instance Methods

apklistings()

Returns the apklistings Resource.

apks()

Returns the apks Resource.

deobfuscationfiles()

Returns the deobfuscationfiles Resource.

details()

Returns the details Resource.

expansionfiles()

Returns the expansionfiles Resource.

images()

Returns the images Resource.

listings()

Returns the listings Resource.

testers()

Returns the testers Resource.

tracks()

Returns the tracks Resource.

commit(packageName, editId)

Commits/applies the changes made in this edit back to the app.

delete(packageName, editId)

Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.

get(packageName, editId)

Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).

insert(packageName, body)

Creates a new edit for an app, populated with the app's current state.

validate(packageName, editId)

Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.

Method Details

commit(packageName, editId) 
Commits/applies the changes made in this edit back to the app.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
    "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
    "id": "A String", # The ID of the edit that can be used in subsequent API calls.
  }
delete(packageName, editId) 
Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
get(packageName, editId) 
Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
    "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
    "id": "A String", # The ID of the edit that can be used in subsequent API calls.
  }
insert(packageName, body) 
Creates a new edit for an app, populated with the app's current state.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
  "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
  "id": "A String", # The ID of the edit that can be used in subsequent API calls.
}


Returns:
  An object of the form:

    { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
    "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
    "id": "A String", # The ID of the edit that can be used in subsequent API calls.
  }
validate(packageName, editId) 
Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
    "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
    "id": "A String", # The ID of the edit that can be used in subsequent API calls.
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.images.html000066400000000000000000000147121300622755700273040ustar00rootroot00000000000000

Google Play Developer API . edits . images

Instance Methods

delete(packageName, editId, language, imageType, imageId)

Deletes the image (specified by id) from the edit.

deleteall(packageName, editId, language, imageType)

Deletes all images for the specified language and image type.

list(packageName, editId, language, imageType)

Lists all images for the specified language and image type.

upload(packageName, editId, language, imageType, media_body=None)

Uploads a new image and adds it to the list of images for the specified language and image type.

Method Details

delete(packageName, editId, language, imageType, imageId) 
Deletes the image (specified by id) from the edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
  imageType: string, A parameter (required)
    Allowed values
      featureGraphic - 
      icon - 
      phoneScreenshots - 
      promoGraphic - 
      sevenInchScreenshots - 
      tenInchScreenshots - 
      tvBanner - 
      tvScreenshots - 
      wearScreenshots - 
  imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
deleteall(packageName, editId, language, imageType) 
Deletes all images for the specified language and image type.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
  imageType: string, A parameter (required)
    Allowed values
      featureGraphic - 
      icon - 
      phoneScreenshots - 
      promoGraphic - 
      sevenInchScreenshots - 
      tenInchScreenshots - 
      tvBanner - 
      tvScreenshots - 
      wearScreenshots - 

Returns:
  An object of the form:

    {
    "deleted": [
      {
        "url": "A String", # A URL that will serve a preview of the image.
        "sha1": "A String", # A sha1 hash of the image that was uploaded.
        "id": "A String", # A unique id representing this image.
      },
    ],
  }
list(packageName, editId, language, imageType) 
Lists all images for the specified language and image type.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
  imageType: string, A parameter (required)
    Allowed values
      featureGraphic - 
      icon - 
      phoneScreenshots - 
      promoGraphic - 
      sevenInchScreenshots - 
      tenInchScreenshots - 
      tvBanner - 
      tvScreenshots - 
      wearScreenshots - 

Returns:
  An object of the form:

    {
    "images": [
      {
        "url": "A String", # A URL that will serve a preview of the image.
        "sha1": "A String", # A sha1 hash of the image that was uploaded.
        "id": "A String", # A unique id representing this image.
      },
    ],
  }
upload(packageName, editId, language, imageType, media_body=None) 
Uploads a new image and adds it to the list of images for the specified language and image type.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
  imageType: string, A parameter (required)
    Allowed values
      featureGraphic - 
      icon - 
      phoneScreenshots - 
      promoGraphic - 
      sevenInchScreenshots - 
      tenInchScreenshots - 
      tvBanner - 
      tvScreenshots - 
      wearScreenshots - 
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    {
    "image": {
      "url": "A String", # A URL that will serve a preview of the image.
      "sha1": "A String", # A sha1 hash of the image that was uploaded.
      "id": "A String", # A unique id representing this image.
    },
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.listings.html000066400000000000000000000207651300622755700277000ustar00rootroot00000000000000

Google Play Developer API . edits . listings

Instance Methods

delete(packageName, editId, language)

Deletes the specified localized store listing from an edit.

deleteall(packageName, editId)

Deletes all localized listings from an edit.

get(packageName, editId, language)

Fetches information about a localized store listing.

list(packageName, editId)

Returns all of the localized store listings attached to this edit.

patch(packageName, editId, language, body)

Creates or updates a localized store listing. This method supports patch semantics.

update(packageName, editId, language, body)

Creates or updates a localized store listing.

Method Details

delete(packageName, editId, language) 
Deletes the specified localized store listing from an edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)
deleteall(packageName, editId) 
Deletes all localized listings from an edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
get(packageName, editId, language) 
Fetches information about a localized store listing.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)

Returns:
  An object of the form:

    {
    "shortDescription": "A String", # Short description of the app (previously known as promo text); this may be up to 80 characters in length.
    "video": "A String", # URL of a promotional YouTube video for the app.
    "fullDescription": "A String", # Full description of the app; this may be up to 4000 characters in length.
    "language": "A String", # Language localization code (for example, "de-AT" for Austrian German).
    "title": "A String", # App's localized title.
  }
list(packageName, editId) 
Returns all of the localized store listings attached to this edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    {
    "kind": "androidpublisher#listingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse".
    "listings": [
      {
        "shortDescription": "A String", # Short description of the app (previously known as promo text); this may be up to 80 characters in length.
        "video": "A String", # URL of a promotional YouTube video for the app.
        "fullDescription": "A String", # Full description of the app; this may be up to 4000 characters in length.
        "language": "A String", # Language localization code (for example, "de-AT" for Austrian German).
        "title": "A String", # App's localized title.
      },
    ],
  }
patch(packageName, editId, language, body) 
Creates or updates a localized store listing. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "shortDescription": "A String", # Short description of the app (previously known as promo text); this may be up to 80 characters in length.
  "video": "A String", # URL of a promotional YouTube video for the app.
  "fullDescription": "A String", # Full description of the app; this may be up to 4000 characters in length.
  "language": "A String", # Language localization code (for example, "de-AT" for Austrian German).
  "title": "A String", # App's localized title.
}


Returns:
  An object of the form:

    {
    "shortDescription": "A String", # Short description of the app (previously known as promo text); this may be up to 80 characters in length.
    "video": "A String", # URL of a promotional YouTube video for the app.
    "fullDescription": "A String", # Full description of the app; this may be up to 4000 characters in length.
    "language": "A String", # Language localization code (for example, "de-AT" for Austrian German).
    "title": "A String", # App's localized title.
  }
update(packageName, editId, language, body) 
Creates or updates a localized store listing.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  language: string, The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "shortDescription": "A String", # Short description of the app (previously known as promo text); this may be up to 80 characters in length.
  "video": "A String", # URL of a promotional YouTube video for the app.
  "fullDescription": "A String", # Full description of the app; this may be up to 4000 characters in length.
  "language": "A String", # Language localization code (for example, "de-AT" for Austrian German).
  "title": "A String", # App's localized title.
}


Returns:
  An object of the form:

    {
    "shortDescription": "A String", # Short description of the app (previously known as promo text); this may be up to 80 characters in length.
    "video": "A String", # URL of a promotional YouTube video for the app.
    "fullDescription": "A String", # Full description of the app; this may be up to 4000 characters in length.
    "language": "A String", # Language localization code (for example, "de-AT" for Austrian German).
    "title": "A String", # App's localized title.
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.testers.html000066400000000000000000000076651300622755700275410ustar00rootroot00000000000000

Google Play Developer API . edits . testers

Instance Methods

get(packageName, editId, track)

A description of how to use this function

patch(packageName, editId, track, body)

A description of how to use this function

update(packageName, editId, track, body)

A description of how to use this function

Method Details

get(packageName, editId, track) 
A description of how to use this function

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  track: string, A parameter (required)
    Allowed values
      alpha - 
      beta - 
      production - 
      rollout - 

Returns:
  An object of the form:

    {
      "googleGroups": [
        "A String",
      ],
      "googlePlusCommunities": [
        "A String",
      ],
    }
patch(packageName, editId, track, body) 
A description of how to use this function

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  track: string, A parameter (required)
    Allowed values
      alpha - 
      beta - 
      production - 
      rollout - 
  body: object, The request body. (required)
    The object takes the form of:

{
    "googleGroups": [
      "A String",
    ],
    "googlePlusCommunities": [
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
      "googleGroups": [
        "A String",
      ],
      "googlePlusCommunities": [
        "A String",
      ],
    }
update(packageName, editId, track, body) 
A description of how to use this function

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  track: string, A parameter (required)
    Allowed values
      alpha - 
      beta - 
      production - 
      rollout - 
  body: object, The request body. (required)
    The object takes the form of:

{
    "googleGroups": [
      "A String",
    ],
    "googlePlusCommunities": [
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
      "googleGroups": [
        "A String",
      ],
      "googlePlusCommunities": [
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.edits.tracks.html000066400000000000000000000130621300622755700273230ustar00rootroot00000000000000

Google Play Developer API . edits . tracks

Instance Methods

get(packageName, editId, track)

Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.

list(packageName, editId)

Lists all the track configurations for this edit.

patch(packageName, editId, track, body)

Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.

update(packageName, editId, track, body)

Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.

Method Details

get(packageName, editId, track) 
Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  track: string, The track type to read or modify. (required)
    Allowed values
      alpha - 
      beta - 
      production - 
      rollout - 

Returns:
  An object of the form:

    {
      "track": "A String",
      "userFraction": 3.14,
      "versionCodes": [
        42,
      ],
    }
list(packageName, editId) 
Lists all the track configurations for this edit.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)

Returns:
  An object of the form:

    {
    "kind": "androidpublisher#tracksListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse".
    "tracks": [
      {
          "track": "A String",
          "userFraction": 3.14,
          "versionCodes": [
            42,
          ],
        },
    ],
  }
patch(packageName, editId, track, body) 
Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  track: string, The track type to read or modify. (required)
    Allowed values
      alpha - 
      beta - 
      production - 
      rollout - 
  body: object, The request body. (required)
    The object takes the form of:

{
    "track": "A String",
    "userFraction": 3.14,
    "versionCodes": [
      42,
    ],
  }


Returns:
  An object of the form:

    {
      "track": "A String",
      "userFraction": 3.14,
      "versionCodes": [
        42,
      ],
    }
update(packageName, editId, track, body) 
Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.

Args:
  packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
  editId: string, Unique identifier for this edit. (required)
  track: string, The track type to read or modify. (required)
    Allowed values
      alpha - 
      beta - 
      production - 
      rollout - 
  body: object, The request body. (required)
    The object takes the form of:

{
    "track": "A String",
    "userFraction": 3.14,
    "versionCodes": [
      42,
    ],
  }


Returns:
  An object of the form:

    {
      "track": "A String",
      "userFraction": 3.14,
      "versionCodes": [
        42,
      ],
    }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.entitlements.html000066400000000000000000000054011300622755700274360ustar00rootroot00000000000000

Google Play Developer API . entitlements

Instance Methods

list(packageName, token=None, maxResults=None, startIndex=None, productId=None)

Lists the user's current inapp item or subscription entitlements

Method Details

list(packageName, token=None, maxResults=None, startIndex=None, productId=None) 
Lists the user's current inapp item or subscription entitlements

Args:
  packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
  token: string, A parameter
  maxResults: integer, A parameter
  startIndex: integer, A parameter
  productId: string, The product id of the inapp product (for example, 'sku1'). This can be used to restrict the result set.

Returns:
  An object of the form:

    {
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "resources": [
      { # An Entitlement resource indicates a user's current entitlement to an inapp item or subscription.
        "kind": "androidpublisher#entitlement", # This kind represents an entitlement object in the androidpublisher service.
        "token": "A String", # The token which can be verified using the subscriptions or products API.
        "productType": "A String", # The type of the inapp product. Possible values are:
            # - In-app item: "inapp"
            # - Subscription: "subs"
        "productId": "A String", # The SKU of the product.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.html000066400000000000000000000053741300622755700247350ustar00rootroot00000000000000

Google Play Developer API

Instance Methods

edits()

Returns the edits Resource.

entitlements()

Returns the entitlements Resource.

inappproducts()

Returns the inappproducts Resource.

purchases()

Returns the purchases Resource.

reviews()

Returns the reviews Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.inappproducts.html000066400000000000000000001441231300622755700276230ustar00rootroot00000000000000

Google Play Developer API . inappproducts

Instance Methods

batch(body)

A description of how to use this function

delete(packageName, sku)

Delete an in-app product for an app.

get(packageName, sku)

Returns information about the in-app product specified.

insert(packageName, body, autoConvertMissingPrices=None)

Creates a new in-app product for an app.

list(packageName, token=None, maxResults=None, startIndex=None)

List all the in-app products for an Android app, both subscriptions and managed in-app products..

patch(packageName, sku, body, autoConvertMissingPrices=None)

Updates the details of an in-app product. This method supports patch semantics.

update(packageName, sku, body, autoConvertMissingPrices=None)

Updates the details of an in-app product.

Method Details

batch(body) 
A description of how to use this function

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entrys": [
      {
        "batchId": 42,
        "inappproductsinsertrequest": {
          "inappproduct": {
              "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
              "status": "A String",
              "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
              "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
                "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
                  {
                    "start": { # Defines the first day on which the price takes effect.
                      "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                      "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                    },
                    "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
                      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                    },
                  },
                ],
                "end": { # Inclusive end date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
                "start": { # Inclusive start date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
              },
              "packageName": "A String", # The package name of the parent app.
              "listings": { # List of localized title and description data.
                "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
                  "description": "A String",
                  "title": "A String",
                },
              },
              "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
              "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
              "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
              "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
                "a_key": { # Region code, as defined by ISO 3166-2.
                  "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                  "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                },
              },
              "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
                "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
              },
            },
        },
        "methodName": "A String",
        "inappproductsupdaterequest": {
          "inappproduct": {
              "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
              "status": "A String",
              "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
              "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
                "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
                  {
                    "start": { # Defines the first day on which the price takes effect.
                      "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                      "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                    },
                    "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
                      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                    },
                  },
                ],
                "end": { # Inclusive end date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
                "start": { # Inclusive start date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
              },
              "packageName": "A String", # The package name of the parent app.
              "listings": { # List of localized title and description data.
                "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
                  "description": "A String",
                  "title": "A String",
                },
              },
              "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
              "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
              "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
              "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
                "a_key": { # Region code, as defined by ISO 3166-2.
                  "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                  "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                },
              },
              "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
                "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
              },
            },
        },
      },
    ],
  }


Returns:
  An object of the form:

    {
    "entrys": [
      {
        "batchId": 42,
        "inappproductsupdateresponse": {
          "inappproduct": {
              "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
              "status": "A String",
              "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
              "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
                "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
                  {
                    "start": { # Defines the first day on which the price takes effect.
                      "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                      "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                    },
                    "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
                      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                    },
                  },
                ],
                "end": { # Inclusive end date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
                "start": { # Inclusive start date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
              },
              "packageName": "A String", # The package name of the parent app.
              "listings": { # List of localized title and description data.
                "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
                  "description": "A String",
                  "title": "A String",
                },
              },
              "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
              "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
              "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
              "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
                "a_key": { # Region code, as defined by ISO 3166-2.
                  "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                  "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                },
              },
              "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
                "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
              },
            },
        },
        "inappproductsinsertresponse": {
          "inappproduct": {
              "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
              "status": "A String",
              "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
              "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
                "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
                  {
                    "start": { # Defines the first day on which the price takes effect.
                      "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                      "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                    },
                    "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
                      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                    },
                  },
                ],
                "end": { # Inclusive end date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
                "start": { # Inclusive start date of the recurrence period.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
              },
              "packageName": "A String", # The package name of the parent app.
              "listings": { # List of localized title and description data.
                "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
                  "description": "A String",
                  "title": "A String",
                },
              },
              "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
              "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
              "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
              "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
                "a_key": { # Region code, as defined by ISO 3166-2.
                  "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                  "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                },
              },
              "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
                "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
              },
            },
        },
      },
    ],
    "kind": "androidpublisher#inappproductsBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsBatchResponse".
  }
delete(packageName, sku) 
Delete an in-app product for an app.

Args:
  packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required)
  sku: string, Unique identifier for the in-app product. (required)
get(packageName, sku) 
Returns information about the in-app product specified.

Args:
  packageName: string, A parameter (required)
  sku: string, Unique identifier for the in-app product. (required)

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
      "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
        "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
          {
            "start": { # Defines the first day on which the price takes effect.
              "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
              "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
            },
            "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
            },
          },
        ],
        "end": { # Inclusive end date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
        "start": { # Inclusive start date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
      },
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
insert(packageName, body, autoConvertMissingPrices=None) 
Creates a new in-app product for an app.

Args:
  packageName: string, Unique identifier for the Android app; for example, "com.spiffygame". (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
    "status": "A String",
    "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
    "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
      "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
        {
          "start": { # Defines the first day on which the price takes effect.
            "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
            "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
          },
          "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
            "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
          },
        },
      ],
      "end": { # Inclusive end date of the recurrence period.
        "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
        "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
      },
      "start": { # Inclusive start date of the recurrence period.
        "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
        "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
      },
    },
    "packageName": "A String", # The package name of the parent app.
    "listings": { # List of localized title and description data.
      "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
        "description": "A String",
        "title": "A String",
      },
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
    "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
    "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
    "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
      "a_key": { # Region code, as defined by ISO 3166-2.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    },
    "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
    },
  }

  autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
      "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
        "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
          {
            "start": { # Defines the first day on which the price takes effect.
              "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
              "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
            },
            "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
            },
          },
        ],
        "end": { # Inclusive end date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
        "start": { # Inclusive start date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
      },
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
list(packageName, token=None, maxResults=None, startIndex=None) 
List all the in-app products for an Android app, both subscriptions and managed in-app products..

Args:
  packageName: string, Unique identifier for the Android app with in-app products; for example, "com.spiffygame". (required)
  token: string, A parameter
  maxResults: integer, A parameter
  startIndex: integer, A parameter

Returns:
  An object of the form:

    {
    "kind": "androidpublisher#inappproductsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse".
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "inappproduct": [
      {
          "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
          "status": "A String",
          "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
          "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
            "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
              {
                "start": { # Defines the first day on which the price takes effect.
                  "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
                  "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
                },
                "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
                  "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                  "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
                },
              },
            ],
            "end": { # Inclusive end date of the recurrence period.
              "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
              "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
            },
            "start": { # Inclusive start date of the recurrence period.
              "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
              "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
            },
          },
          "packageName": "A String", # The package name of the parent app.
          "listings": { # List of localized title and description data.
            "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
              "description": "A String",
              "title": "A String",
            },
          },
          "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
          "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
          "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
          "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
            "a_key": { # Region code, as defined by ISO 3166-2.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
            },
          },
          "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
            "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
          },
        },
    ],
  }
patch(packageName, sku, body, autoConvertMissingPrices=None) 
Updates the details of an in-app product. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required)
  sku: string, Unique identifier for the in-app product. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
    "status": "A String",
    "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
    "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
      "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
        {
          "start": { # Defines the first day on which the price takes effect.
            "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
            "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
          },
          "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
            "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
          },
        },
      ],
      "end": { # Inclusive end date of the recurrence period.
        "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
        "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
      },
      "start": { # Inclusive start date of the recurrence period.
        "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
        "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
      },
    },
    "packageName": "A String", # The package name of the parent app.
    "listings": { # List of localized title and description data.
      "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
        "description": "A String",
        "title": "A String",
      },
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
    "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
    "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
    "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
      "a_key": { # Region code, as defined by ISO 3166-2.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    },
    "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
    },
  }

  autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
      "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
        "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
          {
            "start": { # Defines the first day on which the price takes effect.
              "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
              "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
            },
            "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
            },
          },
        ],
        "end": { # Inclusive end date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
        "start": { # Inclusive start date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
      },
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
update(packageName, sku, body, autoConvertMissingPrices=None) 
Updates the details of an in-app product.

Args:
  packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required)
  sku: string, Unique identifier for the in-app product. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
    "status": "A String",
    "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
    "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
      "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
        {
          "start": { # Defines the first day on which the price takes effect.
            "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
            "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
          },
          "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
            "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
          },
        },
      ],
      "end": { # Inclusive end date of the recurrence period.
        "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
        "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
      },
      "start": { # Inclusive start date of the recurrence period.
        "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
        "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
      },
    },
    "packageName": "A String", # The package name of the parent app.
    "listings": { # List of localized title and description data.
      "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
        "description": "A String",
        "title": "A String",
      },
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
    "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
    "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
    "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
      "a_key": { # Region code, as defined by ISO 3166-2.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    },
    "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
    },
  }

  autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
      "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
        "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.
          {
            "start": { # Defines the first day on which the price takes effect.
              "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
              "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
            },
            "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
            },
          },
        ],
        "end": { # Inclusive end date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
        "start": { # Inclusive start date of the recurrence period.
          "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month.
          "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc.
        },
      },
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.purchases.html000066400000000000000000000026731300622755700267300ustar00rootroot00000000000000

Google Play Developer API . purchases

Instance Methods

products()

Returns the products Resource.

subscriptions()

Returns the subscriptions Resource.

google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.purchases.products.html000066400000000000000000000051751300622755700305720ustar00rootroot00000000000000

Google Play Developer API . purchases . products

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 ProductPurchase resource indicates the status of a user's inapp product purchase.
    "consumptionState": 42, # The consumption state of the inapp product. Possible values are:
        # - Yet to be consumed
        # - Consumed
    "developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
    "kind": "androidpublisher#productPurchase", # This kind represents an inappPurchase object in the androidpublisher service.
    "purchaseTimeMillis": "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
  }
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.purchases.subscriptions.html000066400000000000000000000175301300622755700316340ustar00rootroot00000000000000

Google Play Developer API . purchases . subscriptions

Instance Methods

cancel(packageName, subscriptionId, token)

Cancels a user's subscription purchase. The subscription remains valid until its expiration time.

defer(packageName, subscriptionId, token, body)

Defers a user's subscription purchase until a specified future expiration time.

get(packageName, subscriptionId, token)

Checks whether a user's subscription purchase is valid and returns its expiry time.

refund(packageName, subscriptionId, token)

Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

revoke(packageName, subscriptionId, token)

Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

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)
defer(packageName, subscriptionId, token, body) 
Defers a user's subscription purchase until a specified future 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)
  body: object, The request body. (required)
    The object takes the form of:

{
    "deferralInfo": { # A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time. # The information about the new desired expiry time for the subscription.
      "expectedExpiryTimeMillis": "A String", # The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur.
      "desiredExpiryTimeMillis": "A String", # The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription.
    },
  }


Returns:
  An object of the form:

    {
    "newExpiryTimeMillis": "A String", # The new expiry time for the subscription in milliseconds since the Epoch.
  }
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 SubscriptionPurchase resource indicates the status of a user's subscription purchase.
    "kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.
    "countryCode": "A String", # ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
    "developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
    "autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.
    "paymentState": 42, # The payment state of the subscription. Possible values are:
        # - Payment pending
        # - Payment received
    "priceCurrencyCode": "A String", # ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".
    "expiryTimeMillis": "A String", # Time at which the subscription will expire, in milliseconds since the Epoch.
    "cancelReason": 42, # The reason why a subscription was cancelled or is not auto-renewing. Possible values are:
        # - User cancelled the subscription
        # - Subscription was cancelled by the system, for example because of a billing problem
    "startTimeMillis": "A String", # Time at which the subscription was granted, in milliseconds since the Epoch.
    "priceAmountMicros": "A String", # Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.
  }
refund(packageName, subscriptionId, token) 
Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

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)
revoke(packageName, subscriptionId, token) 
Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

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)
google-api-python-client-1.5.5/docs/dyn/androidpublisher_v2.reviews.html000066400000000000000000000161751300622755700264210ustar00rootroot00000000000000

Google Play Developer API . reviews

Instance Methods

get(packageName, reviewId)

Returns a single review.

list(packageName, token=None, maxResults=None, startIndex=None)

Returns a list of reviews.

reply(packageName, reviewId, body)

Reply to a single review, or update an existing reply.

Method Details

get(packageName, reviewId) 
Returns a single review.

Args:
  packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
  reviewId: string, A parameter (required)

Returns:
  An object of the form:

    {
    "authorName": "A String", # The name of the user who wrote the review.
    "reviewId": "A String", # Unique identifier for this review.
    "comments": [ # A repeated field containing comments for the review.
      {
        "developerComment": { # A comment from a developer.
          "lastModified": { # The last time at which this comment was updated.
            "nanos": 42,
            "seconds": "A String",
          },
          "text": "A String", # The content of the comment, i.e. reply body.
        },
        "userComment": { # A comment from a user.
          "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
          "reviewerLanguage": "A String", # Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
          "lastModified": { # The last time at which this comment was updated.
            "nanos": 42,
            "seconds": "A String",
          },
          "starRating": 42, # The star rating associated with the review, from 1 to 5.
          "text": "A String", # The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
          "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
          "androidOsVersion": 42, # Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
          "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
        },
      },
    ],
  }
list(packageName, token=None, maxResults=None, startIndex=None) 
Returns a list of reviews.

Args:
  packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
  token: string, A parameter
  maxResults: integer, A parameter
  startIndex: integer, A parameter

Returns:
  An object of the form:

    {
    "reviews": [
      {
        "authorName": "A String", # The name of the user who wrote the review.
        "reviewId": "A String", # Unique identifier for this review.
        "comments": [ # A repeated field containing comments for the review.
          {
            "developerComment": { # A comment from a developer.
              "lastModified": { # The last time at which this comment was updated.
                "nanos": 42,
                "seconds": "A String",
              },
              "text": "A String", # The content of the comment, i.e. reply body.
            },
            "userComment": { # A comment from a user.
              "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
              "reviewerLanguage": "A String", # Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
              "lastModified": { # The last time at which this comment was updated.
                "nanos": 42,
                "seconds": "A String",
              },
              "starRating": 42, # The star rating associated with the review, from 1 to 5.
              "text": "A String", # The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
              "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
              "androidOsVersion": 42, # Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
              "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
            },
          },
        ],
      },
    ],
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
  }
reply(packageName, reviewId, body) 
Reply to a single review, or update an existing reply.

Args:
  packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
  reviewId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "replyText": "A String", # The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.
  }


Returns:
  An object of the form:

    {
    "result": {
      "replyText": "A String", # The reply text that was applied.
      "lastEdited": { # The time at which the reply took effect.
        "nanos": 42,
        "seconds": "A String",
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1.apps.html000066400000000000000000000425211300622755700243010ustar00rootroot00000000000000

Google App Engine Admin API . apps

Instance Methods

locations()

Returns the locations Resource.

operations()

Returns the operations Resource.

services()

Returns the services Resource.

get(appsId, x__xgafv=None)

Gets information about an application.

patch(appsId, body, updateMask=None, x__xgafv=None)

Updates application parameters.

repair(appsId, body, x__xgafv=None)

Recreates the required App Engine features for the application in your project, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example "*Error retrieving the App Engine service account*".

Method Details

get(appsId, x__xgafv=None) 
Gets information about an application.

Args:
  appsId: string, Part of `name`. Name of the Application resource to get. Example: `apps/myapp`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An Application resource contains the top-level configuration of an App Engine application.
      "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine. @OutputOnly
      "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
      "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
      "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
      "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
        { # Rules to match an HTTP request and dispatch that request to a service.
          "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
          "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
          "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
        },
      ],
      "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
      "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
      "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
      "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
    }
patch(appsId, body, updateMask=None, x__xgafv=None) 
Updates application parameters.

Args:
  appsId: string, Part of `name`. Name of the application to update. Example: `apps/myapp`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Application resource contains the top-level configuration of an App Engine application.
    "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine. @OutputOnly
    "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
    "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
    "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
    "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
      { # Rules to match an HTTP request and dispatch that request to a service.
        "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
        "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
        "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
      },
    ],
    "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
    "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
    "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
    "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
  }

  updateMask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
repair(appsId, body, x__xgafv=None) 
Recreates the required App Engine features for the application in your project, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example "*Error retrieving the App Engine service account*".

Args:
  appsId: string, Part of `name`. Name of the application to repair. Example: `apps/myapp` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for 'Applications.RepairApplication'.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1.apps.locations.html000066400000000000000000000112671300622755700262760ustar00rootroot00000000000000

Google App Engine Admin API . apps . locations

Instance Methods

get(appsId, locationsId, x__xgafv=None)

Get information about a location.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, locationsId, x__xgafv=None) 
Get information about a location.

Args:
  appsId: string, Part of `name`. Resource name for the location. (required)
  locationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A resource that represents Google Cloud Platform location.
    "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
      "a_key": "A String",
    },
    "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
    "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
    "metadata": { # Service-specific metadata. For example the available capacity at the given location.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists information about the supported locations for this service.

Args:
  appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for LocationService.ListLocations.
    "nextPageToken": "A String", # The standard List next-page token.
    "locations": [ # A list of locations that matches the specified filter in the request.
      { # A resource that represents Google Cloud Platform location.
        "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
          "a_key": "A String",
        },
        "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
        "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
        "metadata": { # Service-specific metadata. For example the available capacity at the given location.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1.apps.operations.html000066400000000000000000000316501300622755700264640ustar00rootroot00000000000000

Google App Engine Admin API . apps . operations

Instance Methods

get(appsId, operationsId, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, operationsId, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  appsId: string, Part of `name`. The name of the operation resource. (required)
  operationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  appsId: string, Part of `name`. The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1.apps.services.html000066400000000000000000000475561300622755700261400ustar00rootroot00000000000000

Google App Engine Admin API . apps . services

Instance Methods

versions()

Returns the versions Resource.

delete(appsId, servicesId, x__xgafv=None)

Deletes the specified service and all enclosed versions.

get(appsId, servicesId, x__xgafv=None)

Gets the current configuration of the specified service.

list(appsId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the services in the application.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(appsId, servicesId, body, migrateTraffic=None, updateMask=None, x__xgafv=None)

Updates the configuration of the specified service.

Method Details

delete(appsId, servicesId, x__xgafv=None) 
Deletes the specified service and all enclosed versions.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, servicesId, x__xgafv=None) 
Gets the current configuration of the specified service.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
      "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
        "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
        "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
          "a_key": 3.14,
        },
      },
      "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
      "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
    }
list(appsId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all the services in the application.

Args:
  appsId: string, Part of `parent`. Name of the parent Application resource. Example: `apps/myapp`. (required)
  pageSize: integer, Maximum results to return per page.
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `Services.ListServices`.
    "services": [ # The services belonging to the requested application.
      { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
          "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
            "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
            "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
              "a_key": 3.14,
            },
          },
          "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
          "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
        },
    ],
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
  }
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(appsId, servicesId, body, migrateTraffic=None, updateMask=None, x__xgafv=None) 
Updates the configuration of the specified service.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
    "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
      "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
      "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
        "a_key": 3.14,
      },
    },
    "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
    "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
  }

  migrateTraffic: boolean, Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
  updateMask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1.apps.services.versions.html000066400000000000000000002531271300622755700300000ustar00rootroot00000000000000

Google App Engine Admin API . apps . services . versions

Instance Methods

instances()

Returns the instances Resource.

create(appsId, servicesId, body, x__xgafv=None)

Deploys code and resource files to a new version.

delete(appsId, servicesId, versionsId, x__xgafv=None)

Deletes an existing Version resource.

get(appsId, servicesId, versionsId, x__xgafv=None, view=None)

Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)

Lists the versions of a service.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Method Details

create(appsId, servicesId, body, x__xgafv=None) 
Deploys code and resource files to a new version.

Args:
  appsId: string, Part of `parent`. Name of the parent resource to create this version under. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
    "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
      "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
      "maxInstances": 42, # Maximum number of instances to create for this version.
    },
    "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
      "a_key": "A String",
    },
    "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
    "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
    "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
      { # Custom static error page to be served when an error occurs.
        "errorCode": "A String", # Error condition this handler applies to.
        "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
        "staticFile": "A String", # Static file content to be served for this error.
      },
    ],
    "id": "A String", # Relative name of the version within the service. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
    "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
      "url": "A String", # URL to serve the endpoint at.
      "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
      "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
      "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
      "script": "A String", # Path to the script from the application root directory.
    },
    "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
    "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
      "checkInterval": "A String", # Interval between health checks.
      "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
      "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
      "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
      "timeout": "A String", # Time before the health check is considered failed.
      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
    },
    "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
    "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com" @OutputOnly
    "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application. Only returned in `GET` requests if `view=FULL` is set.
      { # Third-party Python runtime library that is required by the application.
        "version": "A String", # Version of the library to select, or "latest".
        "name": "A String", # Name of the library. Example: "django".
      },
    ],
    "env": "A String", # App Engine execution environment for this version. Defaults to `standard`.
    "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk. @OutputOnly
    "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
      "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
      "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
        "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
        "targetSentPacketsPerSecond": 42, # Target packets sent per second.
        "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
        "targetSentBytesPerSecond": 42, # Target bytes sent per second.
      },
      "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
        "targetReadOpsPerSecond": 42, # Target ops read per seconds.
        "targetWriteBytesPerSecond": 42, # Target bytes written per second.
        "targetReadBytesPerSecond": 42, # Target bytes read per second.
        "targetWriteOpsPerSecond": 42, # Target ops written per second.
      },
      "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
      "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
      "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
      "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
        "targetConcurrentRequests": 42, # Target number of concurrent requests.
        "targetRequestCountPerSecond": 42, # Target requests per second.
      },
      "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
      "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
      "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
      "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
        "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
        "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
      },
    },
    "envVariables": { # Environment variables available to the application. Only returned in `GET` requests if `view=FULL` is set.
      "a_key": "A String",
    },
    "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
      "diskGb": 3.14, # Disk size (GB) needed.
      "cpu": 3.14, # Number of CPU cores needed.
      "memoryGb": 3.14, # Memory (GB) needed.
    },
    "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
      "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
    },
    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
      "A String",
    ],
    "createdBy": "A String", # Email address of the user who created this version. @OutputOnly
    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
      "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
        "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
          "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
          "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
          "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
        },
      },
      "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
        "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
      },
      "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
        "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
        "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
      },
    },
    "createTime": "A String", # Time that this version was created. @OutputOnly
    "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
      "instanceTag": "A String", # Tag to apply to the VM instance during creation.
      "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
        "A String",
      ],
      "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
    },
    "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
    "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
    "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
      { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
          "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
        },
        "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "login": "A String", # Level of login required to access this resource.
        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
      },
    ],
    "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
    "runtime": "A String", # Desired runtime. Example: `python27`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(appsId, servicesId, versionsId, x__xgafv=None) 
Deletes an existing Version resource.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, servicesId, versionsId, x__xgafv=None, view=None) 
Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.
  view: string, Controls the set of fields returned in the `Get` response.

Returns:
  An object of the form:

    { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
      "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
        "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
        "maxInstances": 42, # Maximum number of instances to create for this version.
      },
      "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
        "a_key": "A String",
      },
      "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
      "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
      "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
        { # Custom static error page to be served when an error occurs.
          "errorCode": "A String", # Error condition this handler applies to.
          "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
          "staticFile": "A String", # Static file content to be served for this error.
        },
      ],
      "id": "A String", # Relative name of the version within the service. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
      "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
        "url": "A String", # URL to serve the endpoint at.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
        "script": "A String", # Path to the script from the application root directory.
      },
      "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
      "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
        "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
        "checkInterval": "A String", # Interval between health checks.
        "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
        "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
        "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
        "timeout": "A String", # Time before the health check is considered failed.
        "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
      },
      "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
      "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com" @OutputOnly
      "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application. Only returned in `GET` requests if `view=FULL` is set.
        { # Third-party Python runtime library that is required by the application.
          "version": "A String", # Version of the library to select, or "latest".
          "name": "A String", # Name of the library. Example: "django".
        },
      ],
      "env": "A String", # App Engine execution environment for this version. Defaults to `standard`.
      "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk. @OutputOnly
      "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
        "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
        "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
          "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
          "targetSentPacketsPerSecond": 42, # Target packets sent per second.
          "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
          "targetSentBytesPerSecond": 42, # Target bytes sent per second.
        },
        "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
          "targetReadOpsPerSecond": 42, # Target ops read per seconds.
          "targetWriteBytesPerSecond": 42, # Target bytes written per second.
          "targetReadBytesPerSecond": 42, # Target bytes read per second.
          "targetWriteOpsPerSecond": 42, # Target ops written per second.
        },
        "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
        "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
        "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
        "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
          "targetConcurrentRequests": 42, # Target number of concurrent requests.
          "targetRequestCountPerSecond": 42, # Target requests per second.
        },
        "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
        "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
        "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
        "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
        "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
          "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
          "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
        },
      },
      "envVariables": { # Environment variables available to the application. Only returned in `GET` requests if `view=FULL` is set.
        "a_key": "A String",
      },
      "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
        "diskGb": 3.14, # Disk size (GB) needed.
        "cpu": 3.14, # Number of CPU cores needed.
        "memoryGb": 3.14, # Memory (GB) needed.
      },
      "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
        "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
      },
      "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
        "A String",
      ],
      "createdBy": "A String", # Email address of the user who created this version. @OutputOnly
      "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
        "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
          "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
            "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
            "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
            "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
          },
        },
        "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
          "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
        },
        "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
          "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
          "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
        },
      },
      "createTime": "A String", # Time that this version was created. @OutputOnly
      "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
        "instanceTag": "A String", # Tag to apply to the VM instance during creation.
        "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
          "A String",
        ],
        "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
      },
      "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
      "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
        { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
          "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
          "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
          "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
          "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
            "scriptPath": "A String", # Path to the script from the application root directory.
          },
          "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
            "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
            "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
            "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
            "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
            "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
            "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
            "httpHeaders": { # HTTP headers to use for all responses from these URLs.
              "a_key": "A String",
            },
          },
          "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
            "scriptPath": "A String", # Path to the script from the application root directory.
          },
          "login": "A String", # Level of login required to access this resource.
          "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
        },
      ],
      "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
      "runtime": "A String", # Desired runtime. Example: `python27`.
    }
list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None) 
Lists the versions of a service.

Args:
  appsId: string, Part of `parent`. Name of the parent Service resource. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
  pageSize: integer, Maximum results to return per page.
  x__xgafv: string, V1 error format.
  pageToken: string, Continuation token for fetching the next page of results.
  view: string, Controls the set of fields returned in the `List` response.

Returns:
  An object of the form:

    { # Response message for `Versions.ListVersions`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "versions": [ # The versions belonging to the requested service.
      { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
          "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
            "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
            "maxInstances": 42, # Maximum number of instances to create for this version.
          },
          "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
            "a_key": "A String",
          },
          "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
          "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
          "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
            { # Custom static error page to be served when an error occurs.
              "errorCode": "A String", # Error condition this handler applies to.
              "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
              "staticFile": "A String", # Static file content to be served for this error.
            },
          ],
          "id": "A String", # Relative name of the version within the service. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
          "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
            "url": "A String", # URL to serve the endpoint at.
            "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
            "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
            "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
            "script": "A String", # Path to the script from the application root directory.
          },
          "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
          "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
            "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
            "checkInterval": "A String", # Interval between health checks.
            "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
            "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
            "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
            "timeout": "A String", # Time before the health check is considered failed.
            "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
          },
          "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
          "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com" @OutputOnly
          "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application. Only returned in `GET` requests if `view=FULL` is set.
            { # Third-party Python runtime library that is required by the application.
              "version": "A String", # Version of the library to select, or "latest".
              "name": "A String", # Name of the library. Example: "django".
            },
          ],
          "env": "A String", # App Engine execution environment for this version. Defaults to `standard`.
          "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk. @OutputOnly
          "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
            "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
            "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
              "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
              "targetSentPacketsPerSecond": 42, # Target packets sent per second.
              "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
              "targetSentBytesPerSecond": 42, # Target bytes sent per second.
            },
            "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
              "targetReadOpsPerSecond": 42, # Target ops read per seconds.
              "targetWriteBytesPerSecond": 42, # Target bytes written per second.
              "targetReadBytesPerSecond": 42, # Target bytes read per second.
              "targetWriteOpsPerSecond": 42, # Target ops written per second.
            },
            "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
            "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
            "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
            "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
              "targetConcurrentRequests": 42, # Target number of concurrent requests.
              "targetRequestCountPerSecond": 42, # Target requests per second.
            },
            "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
            "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
            "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
            "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
            "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
              "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
              "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
            },
          },
          "envVariables": { # Environment variables available to the application. Only returned in `GET` requests if `view=FULL` is set.
            "a_key": "A String",
          },
          "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
            "diskGb": 3.14, # Disk size (GB) needed.
            "cpu": 3.14, # Number of CPU cores needed.
            "memoryGb": 3.14, # Memory (GB) needed.
          },
          "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
            "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
          },
          "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
            "A String",
          ],
          "createdBy": "A String", # Email address of the user who created this version. @OutputOnly
          "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
            "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
              "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
                "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
                "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
                "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
              },
            },
            "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
              "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
            },
            "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
              "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
              "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
            },
          },
          "createTime": "A String", # Time that this version was created. @OutputOnly
          "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
            "instanceTag": "A String", # Tag to apply to the VM instance during creation.
            "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
              "A String",
            ],
            "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
          },
          "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
          "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
          "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
            { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
              "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
              "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
              "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
              "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
                "scriptPath": "A String", # Path to the script from the application root directory.
              },
              "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
                "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
                "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
                "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
                "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
                "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
                "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
                "httpHeaders": { # HTTP headers to use for all responses from these URLs.
                  "a_key": "A String",
                },
              },
              "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
                "scriptPath": "A String", # Path to the script from the application root directory.
              },
              "login": "A String", # Level of login required to access this resource.
              "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
            },
          ],
          "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
          "runtime": "A String", # Desired runtime. Example: `python27`.
        },
    ],
  }
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(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None) 
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/services/default/versions/1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
    "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
      "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
      "maxInstances": 42, # Maximum number of instances to create for this version.
    },
    "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
      "a_key": "A String",
    },
    "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
    "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
    "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
      { # Custom static error page to be served when an error occurs.
        "errorCode": "A String", # Error condition this handler applies to.
        "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
        "staticFile": "A String", # Static file content to be served for this error.
      },
    ],
    "id": "A String", # Relative name of the version within the service. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
    "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
      "url": "A String", # URL to serve the endpoint at.
      "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
      "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
      "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
      "script": "A String", # Path to the script from the application root directory.
    },
    "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
    "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
      "checkInterval": "A String", # Interval between health checks.
      "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
      "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
      "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
      "timeout": "A String", # Time before the health check is considered failed.
      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
    },
    "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
    "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com" @OutputOnly
    "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application. Only returned in `GET` requests if `view=FULL` is set.
      { # Third-party Python runtime library that is required by the application.
        "version": "A String", # Version of the library to select, or "latest".
        "name": "A String", # Name of the library. Example: "django".
      },
    ],
    "env": "A String", # App Engine execution environment for this version. Defaults to `standard`.
    "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk. @OutputOnly
    "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
      "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
      "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
        "targetReceivedPacketsPerSecond": 42, # Target packets received per second.
        "targetSentPacketsPerSecond": 42, # Target packets sent per second.
        "targetReceivedBytesPerSecond": 42, # Target bytes received per second.
        "targetSentBytesPerSecond": 42, # Target bytes sent per second.
      },
      "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
        "targetReadOpsPerSecond": 42, # Target ops read per seconds.
        "targetWriteBytesPerSecond": 42, # Target bytes written per second.
        "targetReadBytesPerSecond": 42, # Target bytes read per second.
        "targetWriteOpsPerSecond": 42, # Target ops written per second.
      },
      "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
      "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
      "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
      "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
        "targetConcurrentRequests": 42, # Target number of concurrent requests.
        "targetRequestCountPerSecond": 42, # Target requests per second.
      },
      "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
      "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
      "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
      "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
        "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
        "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
      },
    },
    "envVariables": { # Environment variables available to the application. Only returned in `GET` requests if `view=FULL` is set.
      "a_key": "A String",
    },
    "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
      "diskGb": 3.14, # Disk size (GB) needed.
      "cpu": 3.14, # Number of CPU cores needed.
      "memoryGb": 3.14, # Memory (GB) needed.
    },
    "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
      "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
    },
    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
      "A String",
    ],
    "createdBy": "A String", # Email address of the user who created this version. @OutputOnly
    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
      "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
        "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
          "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
          "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
          "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
        },
      },
      "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
        "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
      },
      "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
        "filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
        "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
      },
    },
    "createTime": "A String", # Time that this version was created. @OutputOnly
    "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
      "instanceTag": "A String", # Tag to apply to the VM instance during creation.
      "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
        "A String",
      ],
      "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
    },
    "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
    "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
    "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
      { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
          "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
        },
        "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "login": "A String", # Level of login required to access this resource.
        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
      },
    ],
    "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
    "runtime": "A String", # Desired runtime. Example: `python27`.
  }

  updateMask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1.apps.services.versions.instances.html000066400000000000000000000456321300622755700317660ustar00rootroot00000000000000

Google App Engine Admin API . apps . services . versions . instances

Instance Methods

debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)

Stops a running instance.

get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)

Gets instance information.

list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)

Lists the instances of a version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None) 
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `Instances.DebugInstance`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None) 
Stops a running instance.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, servicesId, versionsId, instancesId, x__xgafv=None) 
Gets instance information.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
    "errors": 42, # Number of errors since this instance was started. @OutputOnly
    "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
    "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
    "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
    "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
    "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
    "vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "startTime": "A String", # Time that this instance was started. @OutputOnly
    "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
    "requests": 42, # Number of requests since this instance was started. @OutputOnly
    "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "availability": "A String", # Availability of the instance. @OutputOnly
    "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
  }
list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None) 
Lists the instances of a version.

Args:
  appsId: string, Part of `parent`. Name of the parent Version resource. Example: `apps/myapp/services/default/versions/v1`. (required)
  servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
  versionsId: string, Part of `parent`. See documentation of `appsId`. (required)
  pageSize: integer, Maximum results to return per page.
  x__xgafv: string, V1 error format.
  pageToken: string, Continuation token for fetching the next page of results.

Returns:
  An object of the form:

    { # Response message for `Instances.ListInstances`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "instances": [ # The instances belonging to the requested version.
      { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
        "errors": 42, # Number of errors since this instance was started. @OutputOnly
        "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
        "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
        "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
        "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
        "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
        "vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "startTime": "A String", # Time that this instance was started. @OutputOnly
        "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
        "requests": 42, # Number of requests since this instance was started. @OutputOnly
        "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "availability": "A String", # Availability of the instance. @OutputOnly
        "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1.experimental.apps.html000066400000000000000000000024741300622755700270000ustar00rootroot00000000000000

Google App Engine Admin API . experimental . apps

Instance Methods

operations()

Returns the operations Resource.

google-api-python-client-1.5.5/docs/dyn/appengine_v1.experimental.apps.operations.html000066400000000000000000000317761300622755700311710ustar00rootroot00000000000000

Google App Engine Admin API . experimental . apps . operations

Instance Methods

get(appsId, operationsId, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, operationsId, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  appsId: string, Part of `name`. The name of the operation resource. (required)
  operationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  appsId: string, Part of `name`. The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1.experimental.html000066400000000000000000000023541300622755700260330ustar00rootroot00000000000000

Google App Engine Admin API . experimental

Instance Methods

apps()

Returns the apps Resource.

google-api-python-client-1.5.5/docs/dyn/appengine_v1.html000066400000000000000000000043671300622755700233450ustar00rootroot00000000000000

Google App Engine Admin API

Instance Methods

apps()

Returns the apps Resource.

experimental()

Returns the experimental Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.apps.html000066400000000000000000000476531300622755700252340ustar00rootroot00000000000000

Google App Engine Admin API . apps

Instance Methods

locations()

Returns the locations Resource.

modules()

Returns the modules Resource.

operations()

Returns the operations Resource.

create(body, x__xgafv=None)

Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).

get(appsId, x__xgafv=None, ensureResourcesExist=None)

Gets information about an application.

patch(appsId, body, mask=None, x__xgafv=None)

Updates application parameters.

Method Details

create(body, x__xgafv=None) 
Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An Application resource contains the top-level configuration of an App Engine application.
    "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
    "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
    "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
    "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
    "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent. @OutputOnly
      { # Rules to match an HTTP request and dispatch that request to a module.
        "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
        "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
        "module": "A String", # Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: `default`.
      },
    ],
    "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
    "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
    "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
    "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, x__xgafv=None, ensureResourcesExist=None) 
Gets information about an application.

Args:
  appsId: string, Part of `name`. Name of the application to get. Example: `apps/myapp`. (required)
  x__xgafv: string, V1 error format.
  ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.

Returns:
  An object of the form:

    { # An Application resource contains the top-level configuration of an App Engine application.
      "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
      "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
      "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
      "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
      "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent. @OutputOnly
        { # Rules to match an HTTP request and dispatch that request to a module.
          "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
          "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
          "module": "A String", # Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: `default`.
        },
      ],
      "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
      "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
      "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
      "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
    }
patch(appsId, body, mask=None, x__xgafv=None) 
Updates application parameters.

Args:
  appsId: string, Part of `name`. Name of the application to update. For example: "apps/myapp". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Application resource contains the top-level configuration of an App Engine application.
    "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
    "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
    "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
    "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
    "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent. @OutputOnly
      { # Rules to match an HTTP request and dispatch that request to a module.
        "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
        "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
        "module": "A String", # Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: `default`.
      },
    ],
    "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
    "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
    "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
    "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
  }

  mask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.apps.locations.html000066400000000000000000000113061300622755700272100ustar00rootroot00000000000000

Google App Engine Admin API . apps . locations

Instance Methods

get(appsId, locationsId, x__xgafv=None)

Get information about a location.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, locationsId, x__xgafv=None) 
Get information about a location.

Args:
  appsId: string, Part of `name`. Resource name for the location. (required)
  locationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A resource that represents Google Cloud Platform location.
    "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
      "a_key": "A String",
    },
    "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
    "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
    "metadata": { # Service-specific metadata. For example the available capacity at the given location.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists information about the supported locations for this service.

Args:
  appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for LocationService.ListLocations.
    "nextPageToken": "A String", # The standard List next-page token.
    "locations": [ # A list of locations that matches the specified filter in the request.
      { # A resource that represents Google Cloud Platform location.
        "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
          "a_key": "A String",
        },
        "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
        "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
        "metadata": { # Service-specific metadata. For example the available capacity at the given location.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.apps.modules.html000066400000000000000000000474501300622755700266760ustar00rootroot00000000000000

Google App Engine Admin API . apps . modules

Instance Methods

versions()

Returns the versions Resource.

delete(appsId, modulesId, x__xgafv=None)

Deletes the specified module and all enclosed versions.

get(appsId, modulesId, x__xgafv=None)

Gets the current configuration of the specified module.

list(appsId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the modules in the application.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(appsId, modulesId, body, migrateTraffic=None, mask=None, x__xgafv=None)

Updates the configuration of the specified module.

Method Details

delete(appsId, modulesId, x__xgafv=None) 
Deletes the specified module and all enclosed versions.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, modulesId, x__xgafv=None) 
Gets the current configuration of the specified module.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
      "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
        "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
        "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
          "a_key": 3.14,
        },
      },
      "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
      "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
    }
list(appsId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all the modules in the application.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp`. (required)
  pageSize: integer, Maximum results to return per page.
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `Modules.ListModules`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "modules": [ # The modules belonging to the requested application.
      { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
          "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
            "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
            "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
              "a_key": 3.14,
            },
          },
          "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
          "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
        },
    ],
  }
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(appsId, modulesId, body, migrateTraffic=None, mask=None, x__xgafv=None) 
Updates the configuration of the specified module.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
    "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
      "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
      "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
        "a_key": 3.14,
      },
    },
    "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
    "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
  }

  migrateTraffic: boolean, Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
  mask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.apps.modules.versions.html000066400000000000000000002656221300622755700305500ustar00rootroot00000000000000

Google App Engine Admin API . apps . modules . versions

Instance Methods

instances()

Returns the instances Resource.

create(appsId, modulesId, body, x__xgafv=None)

Deploys code and resource files to a new version.

delete(appsId, modulesId, versionsId, x__xgafv=None)

Deletes an existing version.

get(appsId, modulesId, versionsId, x__xgafv=None, view=None)

Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

list(appsId, modulesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)

Lists the versions of a module.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(appsId, modulesId, versionsId, body, mask=None, x__xgafv=None)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Method Details

create(appsId, modulesId, body, x__xgafv=None) 
Deploys code and resource files to a new version.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Version resource is a specific set of source code and configuration files that are deployed into a module.
    "basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
      "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
      "maxInstances": 42, # Maximum number of instances to create for this version.
    },
    "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
      "a_key": "A String",
    },
    "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
    "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
    "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
      { # Custom static error page to be served when an error occurs.
        "errorCode": "A String", # Error condition this handler applies to.
        "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
        "staticFile": "A String", # Static file content to be served for this error.
      },
    ],
    "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
    "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
      "url": "A String", # URL to serve the endpoint at.
      "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
      "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
      "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
      "script": "A String", # Path to the script from the application root directory.
    },
    "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
    "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
      "checkInterval": "A String", # Interval between health checks.
      "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
      "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
      "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
      "timeout": "A String", # Time before the health check is considered failed.
      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
    },
    "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
    "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
      { # Third-party Python runtime library that is required by the application.
        "version": "A String", # Version of the library to select, or "latest".
        "name": "A String", # Name of the library. Example: "django".
      },
    ],
    "deployer": "A String", # Email address of the user who created this version. @OutputOnly
    "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
    "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
      "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
      "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
        "targetReceivedBytesPerSec": 42, # Target bytes received per second.
        "targetSentBytesPerSec": 42, # Target bytes sent per second.
        "targetReceivedPacketsPerSec": 42, # Target packets received per second.
        "targetSentPacketsPerSec": 42, # Target packets sent per second.
      },
      "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
        "targetWriteOpsPerSec": 42, # Target ops written per second.
        "targetReadBytesPerSec": 42, # Target bytes read per second.
        "targetReadOpsPerSec": 42, # Target ops read per second.
        "targetWriteBytesPerSec": 42, # Target bytes written per second.
      },
      "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
      "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
      "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
      "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
        "targetConcurrentRequests": 42, # Target number of concurrent requests.
        "targetRequestCountPerSec": 42, # Target requests per second.
      },
      "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
      "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
      "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
      "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
        "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
        "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
      },
    },
    "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
      "a_key": "A String",
    },
    "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
      "diskGb": 3.14, # Disk size (GB) needed.
      "cpu": 3.14, # Number of CPU cores needed.
      "memoryGb": 3.14, # Memory (GB) needed.
    },
    "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
      "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
    },
    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
      "A String",
    ],
    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
      "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
        "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
          "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
          "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
          "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
        },
      },
      "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
        { # Reference to a particular snapshot of the source tree used to build and deploy the application.
          "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
          "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
        },
      ],
      "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
        "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
      },
    },
    "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
      "instanceTag": "A String", # Tag to apply to the VM instance during creation.
      "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
        "A String",
      ],
      "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
    },
    "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
    "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
    "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
      { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
        "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
          "expiration": "A String", # Time a static file served by this handler should be cached.
          "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
        },
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          "expiration": "A String", # Time a static file served by this handler should be cached.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
          "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
        },
        "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "login": "A String", # Level of login required to access this resource.
        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
      },
    ],
    "creationTime": "A String", # Time that this version was created. @OutputOnly
    "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
    "runtime": "A String", # Desired runtime. Example: `python27`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(appsId, modulesId, versionsId, x__xgafv=None) 
Deletes an existing version.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, modulesId, versionsId, x__xgafv=None, view=None) 
Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.
  view: string, Controls the set of fields returned in the `Get` response.

Returns:
  An object of the form:

    { # A Version resource is a specific set of source code and configuration files that are deployed into a module.
      "basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
        "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
        "maxInstances": 42, # Maximum number of instances to create for this version.
      },
      "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
        "a_key": "A String",
      },
      "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
      "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
      "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
        { # Custom static error page to be served when an error occurs.
          "errorCode": "A String", # Error condition this handler applies to.
          "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
          "staticFile": "A String", # Static file content to be served for this error.
        },
      ],
      "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
      "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
        "url": "A String", # URL to serve the endpoint at.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
        "script": "A String", # Path to the script from the application root directory.
      },
      "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
      "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
        "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
        "checkInterval": "A String", # Interval between health checks.
        "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
        "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
        "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
        "timeout": "A String", # Time before the health check is considered failed.
        "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
      },
      "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
      "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
        { # Third-party Python runtime library that is required by the application.
          "version": "A String", # Version of the library to select, or "latest".
          "name": "A String", # Name of the library. Example: "django".
        },
      ],
      "deployer": "A String", # Email address of the user who created this version. @OutputOnly
      "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
      "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
        "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
        "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
          "targetReceivedBytesPerSec": 42, # Target bytes received per second.
          "targetSentBytesPerSec": 42, # Target bytes sent per second.
          "targetReceivedPacketsPerSec": 42, # Target packets received per second.
          "targetSentPacketsPerSec": 42, # Target packets sent per second.
        },
        "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
          "targetWriteOpsPerSec": 42, # Target ops written per second.
          "targetReadBytesPerSec": 42, # Target bytes read per second.
          "targetReadOpsPerSec": 42, # Target ops read per second.
          "targetWriteBytesPerSec": 42, # Target bytes written per second.
        },
        "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
        "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
        "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
        "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
          "targetConcurrentRequests": 42, # Target number of concurrent requests.
          "targetRequestCountPerSec": 42, # Target requests per second.
        },
        "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
        "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
        "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
        "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
        "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
          "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
          "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
        },
      },
      "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
        "a_key": "A String",
      },
      "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
        "diskGb": 3.14, # Disk size (GB) needed.
        "cpu": 3.14, # Number of CPU cores needed.
        "memoryGb": 3.14, # Memory (GB) needed.
      },
      "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
        "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
      },
      "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
        "A String",
      ],
      "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
        "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
          "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
            "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
            "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
            "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
          },
        },
        "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
          { # Reference to a particular snapshot of the source tree used to build and deploy the application.
            "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
            "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
          },
        ],
        "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
          "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
        },
      },
      "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
        "instanceTag": "A String", # Tag to apply to the VM instance during creation.
        "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
          "A String",
        ],
        "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
      },
      "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
      "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
        { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
          "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
            "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
            "httpHeaders": { # HTTP headers to use for all responses from these URLs.
              "a_key": "A String",
            },
            "expiration": "A String", # Time a static file served by this handler should be cached.
            "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
            "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
            "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          },
          "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
          "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
          "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
          "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
            "scriptPath": "A String", # Path to the script from the application root directory.
          },
          "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
            "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
            "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
            "expiration": "A String", # Time a static file served by this handler should be cached.
            "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
            "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
            "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
            "httpHeaders": { # HTTP headers to use for all responses from these URLs.
              "a_key": "A String",
            },
          },
          "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
            "scriptPath": "A String", # Path to the script from the application root directory.
          },
          "login": "A String", # Level of login required to access this resource.
          "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
        },
      ],
      "creationTime": "A String", # Time that this version was created. @OutputOnly
      "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
      "runtime": "A String", # Desired runtime. Example: `python27`.
    }
list(appsId, modulesId, pageSize=None, pageToken=None, x__xgafv=None, view=None) 
Lists the versions of a module.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  pageSize: integer, Maximum results to return per page.
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.
  view: string, Controls the set of fields returned in the `List` response.

Returns:
  An object of the form:

    { # Response message for `Versions.ListVersions`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "versions": [ # The versions belonging to the requested module.
      { # A Version resource is a specific set of source code and configuration files that are deployed into a module.
          "basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
            "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
            "maxInstances": 42, # Maximum number of instances to create for this version.
          },
          "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
            "a_key": "A String",
          },
          "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
          "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
          "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
            { # Custom static error page to be served when an error occurs.
              "errorCode": "A String", # Error condition this handler applies to.
              "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
              "staticFile": "A String", # Static file content to be served for this error.
            },
          ],
          "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
          "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
            "url": "A String", # URL to serve the endpoint at.
            "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
            "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
            "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
            "script": "A String", # Path to the script from the application root directory.
          },
          "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
          "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
            "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
            "checkInterval": "A String", # Interval between health checks.
            "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
            "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
            "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
            "timeout": "A String", # Time before the health check is considered failed.
            "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
          },
          "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
          "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
            { # Third-party Python runtime library that is required by the application.
              "version": "A String", # Version of the library to select, or "latest".
              "name": "A String", # Name of the library. Example: "django".
            },
          ],
          "deployer": "A String", # Email address of the user who created this version. @OutputOnly
          "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
          "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
            "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
            "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
              "targetReceivedBytesPerSec": 42, # Target bytes received per second.
              "targetSentBytesPerSec": 42, # Target bytes sent per second.
              "targetReceivedPacketsPerSec": 42, # Target packets received per second.
              "targetSentPacketsPerSec": 42, # Target packets sent per second.
            },
            "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
              "targetWriteOpsPerSec": 42, # Target ops written per second.
              "targetReadBytesPerSec": 42, # Target bytes read per second.
              "targetReadOpsPerSec": 42, # Target ops read per second.
              "targetWriteBytesPerSec": 42, # Target bytes written per second.
            },
            "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
            "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
            "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
            "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
              "targetConcurrentRequests": 42, # Target number of concurrent requests.
              "targetRequestCountPerSec": 42, # Target requests per second.
            },
            "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
            "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
            "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
            "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
            "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
              "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
              "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
            },
          },
          "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
            "a_key": "A String",
          },
          "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
            "diskGb": 3.14, # Disk size (GB) needed.
            "cpu": 3.14, # Number of CPU cores needed.
            "memoryGb": 3.14, # Memory (GB) needed.
          },
          "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
            "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
          },
          "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
            "A String",
          ],
          "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
            "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
              "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
                "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
                "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
                "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
              },
            },
            "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
              { # Reference to a particular snapshot of the source tree used to build and deploy the application.
                "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
                "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
              },
            ],
            "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
              "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
            },
          },
          "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
            "instanceTag": "A String", # Tag to apply to the VM instance during creation.
            "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
              "A String",
            ],
            "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
          },
          "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
          "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
          "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
            { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
              "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
                "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
                "httpHeaders": { # HTTP headers to use for all responses from these URLs.
                  "a_key": "A String",
                },
                "expiration": "A String", # Time a static file served by this handler should be cached.
                "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
                "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
                "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
              },
              "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
              "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
              "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
              "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
                "scriptPath": "A String", # Path to the script from the application root directory.
              },
              "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
                "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
                "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
                "expiration": "A String", # Time a static file served by this handler should be cached.
                "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
                "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
                "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
                "httpHeaders": { # HTTP headers to use for all responses from these URLs.
                  "a_key": "A String",
                },
              },
              "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
                "scriptPath": "A String", # Path to the script from the application root directory.
              },
              "login": "A String", # Level of login required to access this resource.
              "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
            },
          ],
          "creationTime": "A String", # Time that this version was created. @OutputOnly
          "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
          "runtime": "A String", # Desired runtime. Example: `python27`.
        },
    ],
  }
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(appsId, modulesId, versionsId, body, mask=None, x__xgafv=None) 
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default/versions/1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Version resource is a specific set of source code and configuration files that are deployed into a module.
    "basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
      "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
      "maxInstances": 42, # Maximum number of instances to create for this version.
    },
    "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
      "a_key": "A String",
    },
    "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
    "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
    "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
      { # Custom static error page to be served when an error occurs.
        "errorCode": "A String", # Error condition this handler applies to.
        "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
        "staticFile": "A String", # Static file content to be served for this error.
      },
    ],
    "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
    "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
      "url": "A String", # URL to serve the endpoint at.
      "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
      "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
      "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
      "script": "A String", # Path to the script from the application root directory.
    },
    "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
    "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
      "checkInterval": "A String", # Interval between health checks.
      "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
      "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
      "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
      "timeout": "A String", # Time before the health check is considered failed.
      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
    },
    "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
    "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
      { # Third-party Python runtime library that is required by the application.
        "version": "A String", # Version of the library to select, or "latest".
        "name": "A String", # Name of the library. Example: "django".
      },
    ],
    "deployer": "A String", # Email address of the user who created this version. @OutputOnly
    "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
    "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
      "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
      "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
        "targetReceivedBytesPerSec": 42, # Target bytes received per second.
        "targetSentBytesPerSec": 42, # Target bytes sent per second.
        "targetReceivedPacketsPerSec": 42, # Target packets received per second.
        "targetSentPacketsPerSec": 42, # Target packets sent per second.
      },
      "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
        "targetWriteOpsPerSec": 42, # Target ops written per second.
        "targetReadBytesPerSec": 42, # Target bytes read per second.
        "targetReadOpsPerSec": 42, # Target ops read per second.
        "targetWriteBytesPerSec": 42, # Target bytes written per second.
      },
      "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
      "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
      "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
      "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
        "targetConcurrentRequests": 42, # Target number of concurrent requests.
        "targetRequestCountPerSec": 42, # Target requests per second.
      },
      "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
      "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
      "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
      "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
        "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
        "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
      },
    },
    "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
      "a_key": "A String",
    },
    "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
      "diskGb": 3.14, # Disk size (GB) needed.
      "cpu": 3.14, # Number of CPU cores needed.
      "memoryGb": 3.14, # Memory (GB) needed.
    },
    "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
      "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
    },
    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
      "A String",
    ],
    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
      "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
        "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
          "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
          "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
          "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
        },
      },
      "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
        { # Reference to a particular snapshot of the source tree used to build and deploy the application.
          "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
          "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
        },
      ],
      "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
        "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
      },
    },
    "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
      "instanceTag": "A String", # Tag to apply to the VM instance during creation.
      "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
        "A String",
      ],
      "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
    },
    "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
    "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
    "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
      { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
        "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
          "expiration": "A String", # Time a static file served by this handler should be cached.
          "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
        },
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          "expiration": "A String", # Time a static file served by this handler should be cached.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
          "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
        },
        "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "login": "A String", # Level of login required to access this resource.
        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
      },
    ],
    "creationTime": "A String", # Time that this version was created. @OutputOnly
    "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
    "runtime": "A String", # Desired runtime. Example: `python27`.
  }

  mask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html000066400000000000000000000456241300622755700325340ustar00rootroot00000000000000

Google App Engine Admin API . apps . modules . versions . instances

Instance Methods

debug(appsId, modulesId, versionsId, instancesId, body, x__xgafv=None)

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)

Stops a running instance.

get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)

Gets instance information.

list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)

Lists the instances of a version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

debug(appsId, modulesId, versionsId, instancesId, body, x__xgafv=None) 
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `Instances.DebugInstance`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None) 
Stops a running instance.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, modulesId, versionsId, instancesId, x__xgafv=None) 
Gets instance information.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
    "errors": 42, # Number of errors since this instance was started. @OutputOnly
    "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. @OutputOnly
    "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
    "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
    "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
    "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
    "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
    "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
    "requests": 42, # Number of requests since this instance was started. @OutputOnly
    "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "availability": "A String", # Availability of the instance. @OutputOnly
    "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
  }
list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists the instances of a version.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
  modulesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  pageSize: integer, Maximum results to return per page.
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `Instances.ListInstances`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "instances": [ # The instances belonging to the requested version.
      { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
        "errors": 42, # Number of errors since this instance was started. @OutputOnly
        "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. @OutputOnly
        "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
        "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
        "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
        "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
        "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
        "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
        "requests": 42, # Number of requests since this instance was started. @OutputOnly
        "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "availability": "A String", # Availability of the instance. @OutputOnly
        "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.apps.operations.html000066400000000000000000000316671300622755700274140ustar00rootroot00000000000000

Google App Engine Admin API . apps . operations

Instance Methods

get(appsId, operationsId, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, operationsId, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  appsId: string, Part of `name`. The name of the operation resource. (required)
  operationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  appsId: string, Part of `name`. The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta4.html000066400000000000000000000041341300622755700242550ustar00rootroot00000000000000

Google App Engine Admin API

Instance Methods

apps()

Returns the apps Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.apps.html000066400000000000000000000500121300622755700252140ustar00rootroot00000000000000

Google App Engine Admin API . apps

Instance Methods

locations()

Returns the locations Resource.

operations()

Returns the operations Resource.

services()

Returns the services Resource.

create(body, x__xgafv=None)

Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).

get(appsId, x__xgafv=None, ensureResourcesExist=None)

Gets information about an application.

patch(appsId, body, mask=None, x__xgafv=None)

Updates application parameters.

Method Details

create(body, x__xgafv=None) 
Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An Application resource contains the top-level configuration of an App Engine application.
    "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
    "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
    "codeBucket": "A String", # A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
    "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content. @OutputOnly
    "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
      { # Rules to match an HTTP request and dispatch that request to a service.
        "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
        "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
        "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
      },
    ],
    "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
    "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
    "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
    "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, x__xgafv=None, ensureResourcesExist=None) 
Gets information about an application.

Args:
  appsId: string, Part of `name`. Name of the application to get. Example: `apps/myapp`. (required)
  x__xgafv: string, V1 error format.
  ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.

Returns:
  An object of the form:

    { # An Application resource contains the top-level configuration of an App Engine application.
      "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
      "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
      "codeBucket": "A String", # A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
      "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content. @OutputOnly
      "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
        { # Rules to match an HTTP request and dispatch that request to a service.
          "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
          "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
          "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
        },
      ],
      "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
      "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
      "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
      "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
    }
patch(appsId, body, mask=None, x__xgafv=None) 
Updates application parameters.

Args:
  appsId: string, Part of `name`. Name of the application to update. Example: `apps/myapp`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Application resource contains the top-level configuration of an App Engine application.
    "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
    "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
    "codeBucket": "A String", # A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
    "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content. @OutputOnly
    "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
      { # Rules to match an HTTP request and dispatch that request to a service.
        "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
        "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
        "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
      },
    ],
    "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
    "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
    "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
    "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
  }

  mask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.apps.locations.html000066400000000000000000000113061300622755700272110ustar00rootroot00000000000000

Google App Engine Admin API . apps . locations

Instance Methods

get(appsId, locationsId, x__xgafv=None)

Get information about a location.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, locationsId, x__xgafv=None) 
Get information about a location.

Args:
  appsId: string, Part of `name`. Resource name for the location. (required)
  locationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A resource that represents Google Cloud Platform location.
    "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
      "a_key": "A String",
    },
    "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
    "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
    "metadata": { # Service-specific metadata. For example the available capacity at the given location.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists information about the supported locations for this service.

Args:
  appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for LocationService.ListLocations.
    "nextPageToken": "A String", # The standard List next-page token.
    "locations": [ # A list of locations that matches the specified filter in the request.
      { # A resource that represents Google Cloud Platform location.
        "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
          "a_key": "A String",
        },
        "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
        "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
        "metadata": { # Service-specific metadata. For example the available capacity at the given location.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.apps.operations.html000066400000000000000000000316671300622755700274150ustar00rootroot00000000000000

Google App Engine Admin API . apps . operations

Instance Methods

get(appsId, operationsId, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(appsId, operationsId, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  appsId: string, Part of `name`. The name of the operation resource. (required)
  operationsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  appsId: string, Part of `name`. The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.apps.services.html000066400000000000000000000476061300622755700270550ustar00rootroot00000000000000

Google App Engine Admin API . apps . services

Instance Methods

versions()

Returns the versions Resource.

delete(appsId, servicesId, x__xgafv=None)

Deletes the specified service and all enclosed versions.

get(appsId, servicesId, x__xgafv=None)

Gets the current configuration of the specified service.

list(appsId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the services in the application.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(appsId, servicesId, body, migrateTraffic=None, mask=None, x__xgafv=None)

Updates the configuration of the specified service.

Method Details

delete(appsId, servicesId, x__xgafv=None) 
Deletes the specified service and all enclosed versions.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, servicesId, x__xgafv=None) 
Gets the current configuration of the specified service.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
      "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
        "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
        "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
          "a_key": 3.14,
        },
      },
      "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
      "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
    }
list(appsId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all the services in the application.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp`. (required)
  pageSize: integer, Maximum results to return per page.
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `Services.ListServices`.
    "services": [ # The services belonging to the requested application.
      { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
          "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
            "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
            "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
              "a_key": 3.14,
            },
          },
          "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
          "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
        },
    ],
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
  }
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(appsId, servicesId, body, migrateTraffic=None, mask=None, x__xgafv=None) 
Updates the configuration of the specified service.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
    "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
      "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
      "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
        "a_key": 3.14,
      },
    },
    "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
    "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
  }

  migrateTraffic: boolean, Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
  mask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.apps.services.versions.html000066400000000000000000002522411300622755700307150ustar00rootroot00000000000000

Google App Engine Admin API . apps . services . versions

Instance Methods

instances()

Returns the instances Resource.

create(appsId, servicesId, body, x__xgafv=None)

Deploys new code and resource files to a new version.

delete(appsId, servicesId, versionsId, x__xgafv=None)

Deletes an existing version.

get(appsId, servicesId, versionsId, x__xgafv=None, view=None)

Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)

Lists the versions of a service.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(appsId, servicesId, versionsId, body, mask=None, x__xgafv=None)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Method Details

create(appsId, servicesId, body, x__xgafv=None) 
Deploys new code and resource files to a new version.

Args:
  appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default". (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
    "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
      "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
      "maxInstances": 42, # Maximum number of instances to create for this version.
    },
    "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
      "a_key": "A String",
    },
    "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
    "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
    "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
      { # Custom static error page to be served when an error occurs.
        "errorCode": "A String", # Error condition this handler applies to.
        "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
        "staticFile": "A String", # Static file content to be served for this error.
      },
    ],
    "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
    "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
      "url": "A String", # URL to serve the endpoint at.
      "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
      "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
      "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
      "script": "A String", # Path to the script from the application root directory.
    },
    "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
    "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
      "checkInterval": "A String", # Interval between health checks.
      "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
      "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
      "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
      "timeout": "A String", # Time before the health check is considered failed.
      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
    },
    "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
    "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
      { # Third-party Python runtime library that is required by the application.
        "version": "A String", # Version of the library to select, or "latest".
        "name": "A String", # Name of the library. Example: "django".
      },
    ],
    "deployer": "A String", # Email address of the user who created this version. @OutputOnly
    "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
    "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
    "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
      "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
      "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
        "targetReceivedBytesPerSec": 42, # Target bytes received per second.
        "targetSentBytesPerSec": 42, # Target bytes sent per second.
        "targetReceivedPacketsPerSec": 42, # Target packets received per second.
        "targetSentPacketsPerSec": 42, # Target packets sent per second.
      },
      "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
        "targetWriteOpsPerSec": 42, # Target ops written per second.
        "targetReadBytesPerSec": 42, # Target bytes read per second.
        "targetReadOpsPerSec": 42, # Target ops read per second.
        "targetWriteBytesPerSec": 42, # Target bytes written per second.
      },
      "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
      "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
      "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
      "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
        "targetConcurrentRequests": 42, # Target number of concurrent requests.
        "targetRequestCountPerSec": 42, # Target requests per second.
      },
      "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
      "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
      "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
      "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
        "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
        "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
      },
    },
    "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
      "a_key": "A String",
    },
    "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
      "diskGb": 3.14, # Disk size (GB) needed.
      "cpu": 3.14, # Number of CPU cores needed.
      "memoryGb": 3.14, # Memory (GB) needed.
    },
    "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
      "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
    },
    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
      "A String",
    ],
    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
      "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
        "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
          "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
          "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
          "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
        },
      },
      "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
        { # Reference to a particular snapshot of the source tree used to build and deploy the application.
          "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
          "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
        },
      ],
      "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
        "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
      },
    },
    "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
      "instanceTag": "A String", # Tag to apply to the VM instance during creation.
      "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
        "A String",
      ],
      "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
    },
    "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
    "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
    "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
      { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          "expiration": "A String", # Time a static file served by this handler should be cached.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
          "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
        },
        "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "login": "A String", # Level of login required to access this resource.
        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
      },
    ],
    "creationTime": "A String", # Time that this version was created. @OutputOnly
    "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
    "runtime": "A String", # Desired runtime. Example: `python27`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(appsId, servicesId, versionsId, x__xgafv=None) 
Deletes an existing version.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, servicesId, versionsId, x__xgafv=None, view=None) 
Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.
  view: string, Controls the set of fields returned in the `Get` response.

Returns:
  An object of the form:

    { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
      "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
        "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
        "maxInstances": 42, # Maximum number of instances to create for this version.
      },
      "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
        "a_key": "A String",
      },
      "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
      "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
      "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
        { # Custom static error page to be served when an error occurs.
          "errorCode": "A String", # Error condition this handler applies to.
          "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
          "staticFile": "A String", # Static file content to be served for this error.
        },
      ],
      "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
      "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
        "url": "A String", # URL to serve the endpoint at.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
        "script": "A String", # Path to the script from the application root directory.
      },
      "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
      "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
        "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
        "checkInterval": "A String", # Interval between health checks.
        "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
        "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
        "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
        "timeout": "A String", # Time before the health check is considered failed.
        "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
      },
      "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
      "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
        { # Third-party Python runtime library that is required by the application.
          "version": "A String", # Version of the library to select, or "latest".
          "name": "A String", # Name of the library. Example: "django".
        },
      ],
      "deployer": "A String", # Email address of the user who created this version. @OutputOnly
      "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
      "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
      "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
        "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
        "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
          "targetReceivedBytesPerSec": 42, # Target bytes received per second.
          "targetSentBytesPerSec": 42, # Target bytes sent per second.
          "targetReceivedPacketsPerSec": 42, # Target packets received per second.
          "targetSentPacketsPerSec": 42, # Target packets sent per second.
        },
        "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
          "targetWriteOpsPerSec": 42, # Target ops written per second.
          "targetReadBytesPerSec": 42, # Target bytes read per second.
          "targetReadOpsPerSec": 42, # Target ops read per second.
          "targetWriteBytesPerSec": 42, # Target bytes written per second.
        },
        "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
        "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
        "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
        "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
          "targetConcurrentRequests": 42, # Target number of concurrent requests.
          "targetRequestCountPerSec": 42, # Target requests per second.
        },
        "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
        "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
        "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
        "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
        "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
          "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
          "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
        },
      },
      "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
        "a_key": "A String",
      },
      "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
        "diskGb": 3.14, # Disk size (GB) needed.
        "cpu": 3.14, # Number of CPU cores needed.
        "memoryGb": 3.14, # Memory (GB) needed.
      },
      "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
        "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
      },
      "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
        "A String",
      ],
      "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
        "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
          "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
            "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
            "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
            "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
          },
        },
        "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
          { # Reference to a particular snapshot of the source tree used to build and deploy the application.
            "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
            "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
          },
        ],
        "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
          "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
        },
      },
      "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
        "instanceTag": "A String", # Tag to apply to the VM instance during creation.
        "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
          "A String",
        ],
        "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
      },
      "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
      "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
        { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
          "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
          "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
          "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
          "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
            "scriptPath": "A String", # Path to the script from the application root directory.
          },
          "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
            "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
            "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
            "expiration": "A String", # Time a static file served by this handler should be cached.
            "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
            "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
            "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
            "httpHeaders": { # HTTP headers to use for all responses from these URLs.
              "a_key": "A String",
            },
          },
          "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
            "scriptPath": "A String", # Path to the script from the application root directory.
          },
          "login": "A String", # Level of login required to access this resource.
          "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
        },
      ],
      "creationTime": "A String", # Time that this version was created. @OutputOnly
      "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
      "runtime": "A String", # Desired runtime. Example: `python27`.
    }
list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None) 
Lists the versions of a service.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  pageSize: integer, Maximum results to return per page.
  x__xgafv: string, V1 error format.
  pageToken: string, Continuation token for fetching the next page of results.
  view: string, Controls the set of fields returned in the `List` response.

Returns:
  An object of the form:

    { # Response message for `Versions.ListVersions`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "versions": [ # The versions belonging to the requested service.
      { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
          "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
            "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
            "maxInstances": 42, # Maximum number of instances to create for this version.
          },
          "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
            "a_key": "A String",
          },
          "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
          "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
          "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
            { # Custom static error page to be served when an error occurs.
              "errorCode": "A String", # Error condition this handler applies to.
              "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
              "staticFile": "A String", # Static file content to be served for this error.
            },
          ],
          "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
          "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
            "url": "A String", # URL to serve the endpoint at.
            "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
            "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
            "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
            "script": "A String", # Path to the script from the application root directory.
          },
          "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
          "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
            "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
            "checkInterval": "A String", # Interval between health checks.
            "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
            "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
            "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
            "timeout": "A String", # Time before the health check is considered failed.
            "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
          },
          "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
          "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
            { # Third-party Python runtime library that is required by the application.
              "version": "A String", # Version of the library to select, or "latest".
              "name": "A String", # Name of the library. Example: "django".
            },
          ],
          "deployer": "A String", # Email address of the user who created this version. @OutputOnly
          "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
          "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
          "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
            "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
            "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
              "targetReceivedBytesPerSec": 42, # Target bytes received per second.
              "targetSentBytesPerSec": 42, # Target bytes sent per second.
              "targetReceivedPacketsPerSec": 42, # Target packets received per second.
              "targetSentPacketsPerSec": 42, # Target packets sent per second.
            },
            "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
              "targetWriteOpsPerSec": 42, # Target ops written per second.
              "targetReadBytesPerSec": 42, # Target bytes read per second.
              "targetReadOpsPerSec": 42, # Target ops read per second.
              "targetWriteBytesPerSec": 42, # Target bytes written per second.
            },
            "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
            "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
            "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
            "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
              "targetConcurrentRequests": 42, # Target number of concurrent requests.
              "targetRequestCountPerSec": 42, # Target requests per second.
            },
            "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
            "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
            "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
            "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
            "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
              "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
              "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
            },
          },
          "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
            "a_key": "A String",
          },
          "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
            "diskGb": 3.14, # Disk size (GB) needed.
            "cpu": 3.14, # Number of CPU cores needed.
            "memoryGb": 3.14, # Memory (GB) needed.
          },
          "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
            "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
          },
          "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
            "A String",
          ],
          "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
            "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
              "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
                "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
                "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
                "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
              },
            },
            "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
              { # Reference to a particular snapshot of the source tree used to build and deploy the application.
                "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
                "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
              },
            ],
            "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
              "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
            },
          },
          "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
            "instanceTag": "A String", # Tag to apply to the VM instance during creation.
            "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
              "A String",
            ],
            "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
          },
          "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
          "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
          "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
            { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
              "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
              "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
              "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
              "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
                "scriptPath": "A String", # Path to the script from the application root directory.
              },
              "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
                "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
                "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
                "expiration": "A String", # Time a static file served by this handler should be cached.
                "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
                "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
                "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
                "httpHeaders": { # HTTP headers to use for all responses from these URLs.
                  "a_key": "A String",
                },
              },
              "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
                "scriptPath": "A String", # Path to the script from the application root directory.
              },
              "login": "A String", # Level of login required to access this resource.
              "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
            },
          ],
          "creationTime": "A String", # Time that this version was created. @OutputOnly
          "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
          "runtime": "A String", # Desired runtime. Example: `python27`.
        },
    ],
  }
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(appsId, servicesId, versionsId, body, mask=None, x__xgafv=None) 
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.

Args:
  appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/services/default/versions/1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
    "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
      "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
      "maxInstances": 42, # Maximum number of instances to create for this version.
    },
    "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
      "a_key": "A String",
    },
    "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
    "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
    "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
      { # Custom static error page to be served when an error occurs.
        "errorCode": "A String", # Error condition this handler applies to.
        "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
        "staticFile": "A String", # Static file content to be served for this error.
      },
    ],
    "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
    "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
      "url": "A String", # URL to serve the endpoint at.
      "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
      "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
      "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
      "script": "A String", # Path to the script from the application root directory.
    },
    "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
    "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
      "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
      "checkInterval": "A String", # Interval between health checks.
      "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
      "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
      "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
      "timeout": "A String", # Time before the health check is considered failed.
      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
    },
    "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
    "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
      { # Third-party Python runtime library that is required by the application.
        "version": "A String", # Version of the library to select, or "latest".
        "name": "A String", # Name of the library. Example: "django".
      },
    ],
    "deployer": "A String", # Email address of the user who created this version. @OutputOnly
    "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
    "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
    "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
      "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
      "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
        "targetReceivedBytesPerSec": 42, # Target bytes received per second.
        "targetSentBytesPerSec": 42, # Target bytes sent per second.
        "targetReceivedPacketsPerSec": 42, # Target packets received per second.
        "targetSentPacketsPerSec": 42, # Target packets sent per second.
      },
      "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
        "targetWriteOpsPerSec": 42, # Target ops written per second.
        "targetReadBytesPerSec": 42, # Target bytes read per second.
        "targetReadOpsPerSec": 42, # Target ops read per second.
        "targetWriteBytesPerSec": 42, # Target bytes written per second.
      },
      "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
      "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
      "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
      "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
        "targetConcurrentRequests": 42, # Target number of concurrent requests.
        "targetRequestCountPerSec": 42, # Target requests per second.
      },
      "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
      "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
      "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
      "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
        "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
        "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
      },
    },
    "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
      "a_key": "A String",
    },
    "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
      "diskGb": 3.14, # Disk size (GB) needed.
      "cpu": 3.14, # Number of CPU cores needed.
      "memoryGb": 3.14, # Memory (GB) needed.
    },
    "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
      "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
    },
    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
      "A String",
    ],
    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
      "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
        "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
          "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
          "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
          "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
        },
      },
      "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
        { # Reference to a particular snapshot of the source tree used to build and deploy the application.
          "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
          "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
        },
      ],
      "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
        "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
      },
    },
    "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
      "instanceTag": "A String", # Tag to apply to the VM instance during creation.
      "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
        "A String",
      ],
      "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
    },
    "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
    "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
    "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
      { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
        "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
        "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
        "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
          "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
          "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
          "expiration": "A String", # Time a static file served by this handler should be cached.
          "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
          "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
          "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
            "a_key": "A String",
          },
        },
        "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
          "scriptPath": "A String", # Path to the script from the application root directory.
        },
        "login": "A String", # Level of login required to access this resource.
        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
      },
    ],
    "creationTime": "A String", # Time that this version was created. @OutputOnly
    "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
    "runtime": "A String", # Desired runtime. Example: `python27`.
  }

  mask: string, Standard field mask for the set of fields to be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html000066400000000000000000000456561300622755700327150ustar00rootroot00000000000000

Google App Engine Admin API . apps . services . versions . instances

Instance Methods

debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)

Stops a running instance.

get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)

Gets instance information.

list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)

Lists the instances of a version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None) 
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `Instances.DebugInstance`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None) 
Stops a running instance.

Args:
  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1/instances/instance-1". (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(appsId, servicesId, versionsId, instancesId, x__xgafv=None) 
Gets instance information.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  instancesId: string, Part of `name`. See documentation of `appsId`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
    "errors": 42, # Number of errors since this instance was started. @OutputOnly
    "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
    "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
    "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
    "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
    "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
    "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
    "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
    "requests": 42, # Number of requests since this instance was started. @OutputOnly
    "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "availability": "A String", # Availability of the instance. @OutputOnly
    "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
    "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
  }
list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None) 
Lists the instances of a version.

Args:
  appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
  pageSize: integer, Maximum results to return per page.
  x__xgafv: string, V1 error format.
  pageToken: string, Continuation token for fetching the next page of results.

Returns:
  An object of the form:

    { # Response message for `Instances.ListInstances`.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "instances": [ # The instances belonging to the requested version.
      { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
        "errors": 42, # Number of errors since this instance was started. @OutputOnly
        "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
        "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
        "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
        "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
        "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
        "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
        "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
        "requests": 42, # Number of requests since this instance was started. @OutputOnly
        "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "availability": "A String", # Availability of the instance. @OutputOnly
        "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
        "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appengine_v1beta5.html000066400000000000000000000041341300622755700242560ustar00rootroot00000000000000

Google App Engine Admin API

Instance Methods

apps()

Returns the apps Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/appsactivity_v1.activities.html000066400000000000000000000442141300622755700262550ustar00rootroot00000000000000

Google Apps Activity API . activities

Instance Methods

list(pageSize=None, source=None, groupingStrategy=None, userId=None, drive_ancestorId=None, pageToken=None, drive_fileId=None)

Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(pageSize=None, source=None, groupingStrategy=None, userId=None, drive_ancestorId=None, pageToken=None, drive_fileId=None) 
Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.

Args:
  pageSize: integer, The maximum number of events to return on a page. The response includes a continuation token if there are more events.
  source: string, The Google service from which to return activities. Possible values of source are: 
- drive.google.com
  groupingStrategy: string, Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
    Allowed values
      driveUi - 
      none - 
  userId: string, Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.
  drive_ancestorId: string, Identifies the Drive folder containing the items for which to return activities.
  pageToken: string, A token to retrieve a specific page of results.
  drive_fileId: string, Identifies the Drive item to return activities for.

Returns:
  An object of the form:

    { # The response from the list request. Contains a list of activities and a token to retrieve the next page of results.
    "nextPageToken": "A String", # Token for the next page of results.
    "activities": [ # List of activities.
      { # An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.
        "combinedEvent": { # Represents the changes associated with an action taken by a user. # The fields common to all of the singleEvents that make up the Activity.
          "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
            "newTitle": "A String", # The new title.
            "oldTitle": "A String", # The old title.
          },
          "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
            "mimeType": "A String", # The MIME type of the target.
            "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
            "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
          },
          "additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
            "A String",
          ],
          "move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.
            "removedParents": [ # The removed parent(s).
              { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
                "id": "A String", # The parent's ID.
                "isRoot": True or False, # Whether this is the root folder.
                "title": "A String", # The parent's title.
              },
            ],
            "addedParents": [ # The added parent(s).
              { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
                "id": "A String", # The parent's ID.
                "isRoot": True or False, # Whether this is the root folder.
                "title": "A String", # The parent's title.
              },
            ],
          },
          "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
            { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
              "removedPermissions": [ # Lists all Permission objects removed.
                { # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
                  "withLink": True or False, # Whether the permission requires a link to the file.
                  "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
                  "name": "A String", # The name of the user or group the permission applies to.
                  "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
                  "user": { # A representation of a user. # The user's information if the type is USER.
                    "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
                      "url": "A String", # The URL of the photo.
                    },
                    "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
                    "name": "A String", # The displayable name of the user.
                    "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
                  },
                  "type": "A String", # Indicates how widely permissions are granted.
                },
              ],
              "addedPermissions": [ # Lists all Permission objects added.
                { # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
                  "withLink": True or False, # Whether the permission requires a link to the file.
                  "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
                  "name": "A String", # The name of the user or group the permission applies to.
                  "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
                  "user": { # A representation of a user. # The user's information if the type is USER.
                    "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
                      "url": "A String", # The URL of the photo.
                    },
                    "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
                    "name": "A String", # The displayable name of the user.
                    "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
                  },
                  "type": "A String", # Indicates how widely permissions are granted.
                },
              ],
            },
          ],
          "user": { # A representation of a user. # Represents the user responsible for the event.
            "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
              "url": "A String", # The URL of the photo.
            },
            "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
            "name": "A String", # The displayable name of the user.
            "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
          },
          "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
          "primaryEventType": "A String", # The main type of event that occurred.
          "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
        },
        "singleEvents": [ # A list of all the Events that make up the Activity.
          { # Represents the changes associated with an action taken by a user.
            "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
              "newTitle": "A String", # The new title.
              "oldTitle": "A String", # The old title.
            },
            "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
              "mimeType": "A String", # The MIME type of the target.
              "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
              "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
            },
            "additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
              "A String",
            ],
            "move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.
              "removedParents": [ # The removed parent(s).
                { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
                  "id": "A String", # The parent's ID.
                  "isRoot": True or False, # Whether this is the root folder.
                  "title": "A String", # The parent's title.
                },
              ],
              "addedParents": [ # The added parent(s).
                { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
                  "id": "A String", # The parent's ID.
                  "isRoot": True or False, # Whether this is the root folder.
                  "title": "A String", # The parent's title.
                },
              ],
            },
            "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
              { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
                "removedPermissions": [ # Lists all Permission objects removed.
                  { # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
                    "withLink": True or False, # Whether the permission requires a link to the file.
                    "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
                    "name": "A String", # The name of the user or group the permission applies to.
                    "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
                    "user": { # A representation of a user. # The user's information if the type is USER.
                      "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
                        "url": "A String", # The URL of the photo.
                      },
                      "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
                      "name": "A String", # The displayable name of the user.
                      "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
                    },
                    "type": "A String", # Indicates how widely permissions are granted.
                  },
                ],
                "addedPermissions": [ # Lists all Permission objects added.
                  { # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
                    "withLink": True or False, # Whether the permission requires a link to the file.
                    "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
                    "name": "A String", # The name of the user or group the permission applies to.
                    "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
                    "user": { # A representation of a user. # The user's information if the type is USER.
                      "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
                        "url": "A String", # The URL of the photo.
                      },
                      "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
                      "name": "A String", # The displayable name of the user.
                      "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
                    },
                    "type": "A String", # Indicates how widely permissions are granted.
                  },
                ],
              },
            ],
            "user": { # A representation of a user. # Represents the user responsible for the event.
              "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
                "url": "A String", # The URL of the photo.
              },
              "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
              "name": "A String", # The displayable name of the user.
              "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
            },
            "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
            "primaryEventType": "A String", # The main type of event that occurred.
            "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
          },
        ],
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/appsactivity_v1.html000066400000000000000000000041471300622755700241130ustar00rootroot00000000000000

Google Apps Activity API

Instance Methods

activities()

Returns the activities Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/appstate_v1.html000066400000000000000000000041171300622755700232110ustar00rootroot00000000000000

Google App State API

Instance Methods

states()

Returns the states Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/appstate_v1.states.html000066400000000000000000000160621300622755700245150ustar00rootroot00000000000000

Google App State API . states

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. If the key does not exist on the server, an HTTP 404 will be returned.

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. If the key does not exist on the server, an HTTP 404 will be returned.

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.
  }
google-api-python-client-1.5.5/docs/dyn/bigquery_v2.datasets.html000066400000000000000000001231131300622755700250250ustar00rootroot00000000000000

BigQuery API . datasets

Instance Methods

delete(projectId, datasetId, deleteContents=None)

Deletes the dataset specified by the 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, filter=None, all=None, pageToken=None, maxResults=None)

Lists all datasets in the specified project to which you have been granted the READER dataset role.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId, datasetId, body)

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.

update(projectId, datasetId, body)

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

Method Details

delete(projectId, datasetId, deleteContents=None) 
Deletes the dataset specified by the 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 description of the dataset.
      "datasetReference": { # [Required] A reference that identifies the dataset.
        "projectId": "A String", # [Optional] The ID of the project containing this dataset.
        "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      },
      "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
        "a_key": "A String",
      },
      "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
      "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
        {
          "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".
          "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
          "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
          "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
          "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, WRITER, OWNER.
          "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
      ],
      "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
      "etag": "A String", # [Output-only] A hash of the resource.
      "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
      "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
      "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the 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 description of the dataset.
    "datasetReference": { # [Required] A reference that identifies the dataset.
      "projectId": "A String", # [Optional] The ID of the project containing this dataset.
      "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    },
    "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
      "a_key": "A String",
    },
    "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
    "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
      {
        "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".
        "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
        "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
        "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
        "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, WRITER, OWNER.
        "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
      },
    ],
    "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
    "etag": "A String", # [Output-only] A hash of the resource.
    "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
    "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
    "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
  }


Returns:
  An object of the form:

    {
      "kind": "bigquery#dataset", # [Output-only] The resource type.
      "description": "A String", # [Optional] A user-friendly description of the dataset.
      "datasetReference": { # [Required] A reference that identifies the dataset.
        "projectId": "A String", # [Optional] The ID of the project containing this dataset.
        "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      },
      "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
        "a_key": "A String",
      },
      "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
      "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
        {
          "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".
          "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
          "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
          "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
          "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, WRITER, OWNER.
          "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
      ],
      "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
      "etag": "A String", # [Output-only] A hash of the resource.
      "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
      "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
      "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
    }
list(projectId, filter=None, all=None, pageToken=None, maxResults=None) 
Lists all datasets in the specified project to which you have been granted the READER dataset role.

Args:
  projectId: string, Project ID of the datasets to be listed (required)
  filter: string, An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
  all: boolean, Whether to list all datasets, including hidden ones
  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".
        "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets.
          "a_key": "A String",
        },
        "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 project containing this dataset.
          "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
        },
      },
    ],
    "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. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. 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 description of the dataset.
    "datasetReference": { # [Required] A reference that identifies the dataset.
      "projectId": "A String", # [Optional] The ID of the project containing this dataset.
      "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    },
    "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
      "a_key": "A String",
    },
    "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
    "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
      {
        "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".
        "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
        "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
        "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
        "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, WRITER, OWNER.
        "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
      },
    ],
    "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
    "etag": "A String", # [Output-only] A hash of the resource.
    "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
    "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
    "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
  }


Returns:
  An object of the form:

    {
      "kind": "bigquery#dataset", # [Output-only] The resource type.
      "description": "A String", # [Optional] A user-friendly description of the dataset.
      "datasetReference": { # [Required] A reference that identifies the dataset.
        "projectId": "A String", # [Optional] The ID of the project containing this dataset.
        "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      },
      "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
        "a_key": "A String",
      },
      "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
      "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
        {
          "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".
          "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
          "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
          "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
          "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, WRITER, OWNER.
          "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
      ],
      "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
      "etag": "A String", # [Output-only] A hash of the resource.
      "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
      "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
      "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
    }
update(projectId, datasetId, body) 
Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

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 description of the dataset.
    "datasetReference": { # [Required] A reference that identifies the dataset.
      "projectId": "A String", # [Optional] The ID of the project containing this dataset.
      "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    },
    "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
      "a_key": "A String",
    },
    "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
    "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
      {
        "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".
        "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
        "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
        "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
        "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, WRITER, OWNER.
        "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
      },
    ],
    "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
    "etag": "A String", # [Output-only] A hash of the resource.
    "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
    "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
    "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
  }


Returns:
  An object of the form:

    {
      "kind": "bigquery#dataset", # [Output-only] The resource type.
      "description": "A String", # [Optional] A user-friendly description of the dataset.
      "datasetReference": { # [Required] A reference that identifies the dataset.
        "projectId": "A String", # [Optional] The ID of the project containing this dataset.
        "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      },
      "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
        "a_key": "A String",
      },
      "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
      "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
        {
          "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".
          "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
          "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
          "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
          "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, WRITER, OWNER.
          "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
      ],
      "defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
      "etag": "A String", # [Output-only] A hash of the resource.
      "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
      "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
      "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 the 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] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
    }
google-api-python-client-1.5.5/docs/dyn/bigquery_v2.html000066400000000000000000000052361300622755700232230ustar00rootroot00000000000000

BigQuery API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/bigquery_v2.jobs.html000066400000000000000000007025771300622755700241730ustar00rootroot00000000000000

BigQuery API . jobs

Instance Methods

cancel(projectId, jobId)

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

get(projectId, jobId)

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.

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. Requires the Can View project role.

list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

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

cancel(projectId, jobId) 
Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

Args:
  projectId: string, [Required] Project ID of the job to cancel (required)
  jobId: string, [Required] Job ID of the job to cancel (required)

Returns:
  An object of the form:

    {
    "job": { # The final state of the job.
        "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 load job.
            "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
          },
          "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
          "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. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
          "query": { # [Output-only] Statistics for a query job.
            "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
              {
                "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
                "recordsWritten": "A String", # Number of records written by the stage.
                "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
                "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
                "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
                "steps": [ # List of operations within the stage in dependency order (approximately chronological).
                  {
                    "kind": "A String", # Machine-readable operation type.
                    "substeps": [ # Human-readable stage descriptions.
                      "A String",
                    ],
                  },
                ],
                "recordsRead": "A String", # Number of records read into the stage.
                "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
                "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
                "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
                "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
                "id": "A String", # Unique ID for stage within plan.
                "name": "A String", # Human-readable name for stage.
              },
            ],
            "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
            "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
            "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
            "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
              {
                "parameterType": { # [Required] The type of this parameter.
                  "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                    {
                      "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                      "description": "A String", # [Optional] Human-oriented description of the field.
                      "name": "A String", # [Optional] The name of this field.
                    },
                  ],
                  "type": "A String", # [Required] The top level type of this field.
                  "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
                },
                "parameterValue": { # [Required] The value of this parameter.
                  "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                    "a_key": # Object with schema name: QueryParameterValue
                  },
                  "arrayValues": [ # [Optional] The array values, if this is an array type.
                    # Object with schema name: QueryParameterValue
                  ],
                  "value": "A String", # [Optional] The value of this value, if a simple scalar type.
                },
                "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
              },
            ],
            "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
            "billingTier": 42, # [Output-only] Billing tier for the job.
            "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
              {
                "projectId": "A String", # [Required] The ID of the project containing this table.
                "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
                "datasetId": "A String", # [Required] The ID of the dataset containing this table.
              },
            ],
            "schema": { # [Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
              "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                  "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                  "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                  "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                },
              ],
            },
          },
          "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
          "extract": { # [Output-only] Statistics for an extract job.
            "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
              "A String",
            ],
          },
        },
        "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
          "projectId": "A String", # [Required] The ID of the project containing this job.
          "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
        },
        "etag": "A String", # [Output-only] A hash of this resource.
        "user_email": "A String", # [Output-only] Email address of the user who ran the job.
        "configuration": { # [Required] Describes the job configuration.
          "load": { # [Pick one] Configures a load job.
            "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". For Avro, specify "AVRO". The default value is CSV.
            "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. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',').
            "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
            "destinationTable": { # [Required] The destination table to load the data into.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
            "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. 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. The default value is 0, which requires that all records are valid.
            "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
              "A String",
            ],
            "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. 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 in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
              "A String",
            ],
            "quote": """, # [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.
            "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
              "A String",
            ],
            "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
            "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
              "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                  "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                  "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                  "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                },
              ],
            },
          },
          "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.
          "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
            "a_key": "A String",
          },
          "query": { # [Pick one] Configures a query job.
            "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
            "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
            "useQueryCache": true, # [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. The default value is true.
            "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
              "projectId": "A String", # [Optional] The ID of the project containing this dataset.
              "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            },
            "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
            "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] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
            "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
              "A String",
            ],
            "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
            "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
            "allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
            "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
              {
                "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
                "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
              },
            ],
            "queryParameters": [ # Query parameters for standard SQL queries.
              {
                "parameterType": { # [Required] The type of this parameter.
                  "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                    {
                      "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                      "description": "A String", # [Optional] Human-oriented description of the field.
                      "name": "A String", # [Optional] The name of this field.
                    },
                  ],
                  "type": "A String", # [Required] The top level type of this field.
                  "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
                },
                "parameterValue": { # [Required] The value of this parameter.
                  "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                    "a_key": # Object with schema name: QueryParameterValue
                  },
                  "arrayValues": [ # [Optional] The array values, if this is an array type.
                    # Object with schema name: QueryParameterValue
                  ],
                  "value": "A String", # [Optional] The value of this value, if a simple scalar type.
                },
                "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
              },
            ],
            "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.
            "query": "A String", # [Required] BigQuery SQL query to execute.
            "preserveNulls": True or False, # [Deprecated] This property is deprecated.
            "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
            "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
              "a_key": {
                "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
                "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
                  "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 (',').
                  "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.
                  "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
                  "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
                  "quote": """, # [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.
                  "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
                },
                "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
                "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
                "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
                "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
                  "A String",
                ],
                "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
                  "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
                  "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
                  "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
                    {
                      "familyId": "A String", # Identifier of the column family.
                      "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
                      "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
                      "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                        {
                          "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                          "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                          "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                          "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                          "qualifierString": "A String",
                          "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                        },
                      ],
                      "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
                    },
                  ],
                },
                "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
                "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
                  "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
                },
                "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
                  "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                      "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                      "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                      "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                    },
                  ],
                },
              },
            },
            "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
          },
          "copy": { # [Pick one] Copies a table.
            "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.
            "sourceTables": [ # [Pick one] Source tables to copy.
              {
                "projectId": "A String", # [Required] The ID of the project containing this table.
                "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
                "datasetId": "A String", # [Required] The ID of the dataset containing this table.
              },
            ],
            "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
            "destinationTable": { # [Required] The destination table
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
            "sourceTable": { # [Pick one] Source table to copy.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          },
          "extract": { # [Pick one] Configures an extract job.
            "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
            "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
            "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
            "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
            "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
            "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
              "A String",
            ],
            "sourceTable": { # [Required] A reference to the table being exported.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          },
        },
        "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.
      },
    "kind": "bigquery#jobCancelResponse", # The resource type of the response.
  }
get(projectId, jobId) 
Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.

Args:
  projectId: string, [Required] Project ID of the requested job (required)
  jobId: string, [Required] 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 load job.
          "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
        },
        "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
        "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. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
        "query": { # [Output-only] Statistics for a query job.
          "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
            {
              "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
              "recordsWritten": "A String", # Number of records written by the stage.
              "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
              "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
              "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
              "steps": [ # List of operations within the stage in dependency order (approximately chronological).
                {
                  "kind": "A String", # Machine-readable operation type.
                  "substeps": [ # Human-readable stage descriptions.
                    "A String",
                  ],
                },
              ],
              "recordsRead": "A String", # Number of records read into the stage.
              "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
              "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
              "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
              "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
              "id": "A String", # Unique ID for stage within plan.
              "name": "A String", # Human-readable name for stage.
            },
          ],
          "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
          "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
          "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
          "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
            {
              "parameterType": { # [Required] The type of this parameter.
                "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                  {
                    "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                    "description": "A String", # [Optional] Human-oriented description of the field.
                    "name": "A String", # [Optional] The name of this field.
                  },
                ],
                "type": "A String", # [Required] The top level type of this field.
                "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
              },
              "parameterValue": { # [Required] The value of this parameter.
                "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                  "a_key": # Object with schema name: QueryParameterValue
                },
                "arrayValues": [ # [Optional] The array values, if this is an array type.
                  # Object with schema name: QueryParameterValue
                ],
                "value": "A String", # [Optional] The value of this value, if a simple scalar type.
              },
              "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
            },
          ],
          "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
          "billingTier": 42, # [Output-only] Billing tier for the job.
          "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
            {
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          ],
          "schema": { # [Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
            "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        },
        "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
        "extract": { # [Output-only] Statistics for an extract job.
          "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
            "A String",
          ],
        },
      },
      "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
        "projectId": "A String", # [Required] The ID of the project containing this job.
        "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
      },
      "etag": "A String", # [Output-only] A hash of this resource.
      "user_email": "A String", # [Output-only] Email address of the user who ran the job.
      "configuration": { # [Required] Describes the job configuration.
        "load": { # [Pick one] Configures a load job.
          "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". For Avro, specify "AVRO". The default value is CSV.
          "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. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',').
          "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
          "destinationTable": { # [Required] The destination table to load the data into.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. 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. The default value is 0, which requires that all records are valid.
          "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
            "A String",
          ],
          "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. 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 in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
            "A String",
          ],
          "quote": """, # [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.
          "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
            "A String",
          ],
          "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
          "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
            "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        },
        "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.
        "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
          "a_key": "A String",
        },
        "query": { # [Pick one] Configures a query job.
          "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
          "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
          "useQueryCache": true, # [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. The default value is true.
          "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
            "projectId": "A String", # [Optional] The ID of the project containing this dataset.
            "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          },
          "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
          "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] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
            "A String",
          ],
          "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
          "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
          "allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
          "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
            {
              "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
              "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
            },
          ],
          "queryParameters": [ # Query parameters for standard SQL queries.
            {
              "parameterType": { # [Required] The type of this parameter.
                "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                  {
                    "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                    "description": "A String", # [Optional] Human-oriented description of the field.
                    "name": "A String", # [Optional] The name of this field.
                  },
                ],
                "type": "A String", # [Required] The top level type of this field.
                "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
              },
              "parameterValue": { # [Required] The value of this parameter.
                "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                  "a_key": # Object with schema name: QueryParameterValue
                },
                "arrayValues": [ # [Optional] The array values, if this is an array type.
                  # Object with schema name: QueryParameterValue
                ],
                "value": "A String", # [Optional] The value of this value, if a simple scalar type.
              },
              "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
            },
          ],
          "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.
          "query": "A String", # [Required] BigQuery SQL query to execute.
          "preserveNulls": True or False, # [Deprecated] This property is deprecated.
          "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
          "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
            "a_key": {
              "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
              "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
                "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 (',').
                "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.
                "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
                "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
                "quote": """, # [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.
                "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
              },
              "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
              "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
              "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
              "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
                "A String",
              ],
              "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
                "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
                "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
                "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
                  {
                    "familyId": "A String", # Identifier of the column family.
                    "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
                    "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
                    "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                      {
                        "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                        "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                        "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                        "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                        "qualifierString": "A String",
                        "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                      },
                    ],
                    "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
                  },
                ],
              },
              "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
              "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
                "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
              },
              "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
                "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                    "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                    "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                    "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                  },
                ],
              },
            },
          },
          "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
        },
        "copy": { # [Pick one] Copies a table.
          "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.
          "sourceTables": [ # [Pick one] Source tables to copy.
            {
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          ],
          "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
          "destinationTable": { # [Required] The destination table
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "sourceTable": { # [Pick one] Source table to copy.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
        "extract": { # [Pick one] Configures an extract job.
          "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
          "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
          "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
          "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
          "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
          "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
            "A String",
          ],
          "sourceTable": { # [Required] A reference to the table being exported.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
      },
      "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, [Required] Project ID of the query job (required)
  jobId: string, [Required] Job ID of the query job (required)
  timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false
  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.
    "errors": [ # [Output-only] All errors and warnings 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.
      },
    ],
    "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] The ID of the project containing this job.
      "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
    },
    "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.
    "totalBytesProcessed": "A String", # The total number of bytes processed for this query.
    "cacheHit": True or False, # Whether the query result was fetched from the query cache.
    "etag": "A String", # A hash of this 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.
      {
        "f": [ # Represents a single row in the result set, consisting of one or more fields.
          {
            "v": "",
          },
        ],
      },
    ],
    "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
    "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
          "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
          "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
          "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
        },
      ],
    },
  }
insert(projectId, body=None, media_body=None) 
Starts a new asynchronous job. Requires the Can View project role.

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 load job.
        "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
      },
      "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
      "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. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
      "query": { # [Output-only] Statistics for a query job.
        "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
          {
            "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
            "recordsWritten": "A String", # Number of records written by the stage.
            "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
            "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
            "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
            "steps": [ # List of operations within the stage in dependency order (approximately chronological).
              {
                "kind": "A String", # Machine-readable operation type.
                "substeps": [ # Human-readable stage descriptions.
                  "A String",
                ],
              },
            ],
            "recordsRead": "A String", # Number of records read into the stage.
            "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
            "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
            "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
            "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
            "id": "A String", # Unique ID for stage within plan.
            "name": "A String", # Human-readable name for stage.
          },
        ],
        "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
        "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
        "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
        "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
          {
            "parameterType": { # [Required] The type of this parameter.
              "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                {
                  "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                  "description": "A String", # [Optional] Human-oriented description of the field.
                  "name": "A String", # [Optional] The name of this field.
                },
              ],
              "type": "A String", # [Required] The top level type of this field.
              "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
            },
            "parameterValue": { # [Required] The value of this parameter.
              "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                "a_key": # Object with schema name: QueryParameterValue
              },
              "arrayValues": [ # [Optional] The array values, if this is an array type.
                # Object with schema name: QueryParameterValue
              ],
              "value": "A String", # [Optional] The value of this value, if a simple scalar type.
            },
            "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
          },
        ],
        "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
        "billingTier": 42, # [Output-only] Billing tier for the job.
        "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
          {
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        ],
        "schema": { # [Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
          "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      },
      "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
      "extract": { # [Output-only] Statistics for an extract job.
        "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
          "A String",
        ],
      },
    },
    "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
      "projectId": "A String", # [Required] The ID of the project containing this job.
      "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
    },
    "etag": "A String", # [Output-only] A hash of this resource.
    "user_email": "A String", # [Output-only] Email address of the user who ran the job.
    "configuration": { # [Required] Describes the job configuration.
      "load": { # [Pick one] Configures a load job.
        "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". For Avro, specify "AVRO". The default value is CSV.
        "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. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',').
        "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
        "destinationTable": { # [Required] The destination table to load the data into.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
        "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. 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. The default value is 0, which requires that all records are valid.
        "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
          "A String",
        ],
        "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. 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 in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
          "A String",
        ],
        "quote": """, # [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.
        "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
          "A String",
        ],
        "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
        "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
          "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      },
      "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.
      "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
        "a_key": "A String",
      },
      "query": { # [Pick one] Configures a query job.
        "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
        "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
        "useQueryCache": true, # [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. The default value is true.
        "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
          "projectId": "A String", # [Optional] The ID of the project containing this dataset.
          "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
        },
        "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
        "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] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
        "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
          "A String",
        ],
        "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
        "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
        "allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
        "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
          {
            "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
            "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
          },
        ],
        "queryParameters": [ # Query parameters for standard SQL queries.
          {
            "parameterType": { # [Required] The type of this parameter.
              "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                {
                  "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                  "description": "A String", # [Optional] Human-oriented description of the field.
                  "name": "A String", # [Optional] The name of this field.
                },
              ],
              "type": "A String", # [Required] The top level type of this field.
              "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
            },
            "parameterValue": { # [Required] The value of this parameter.
              "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                "a_key": # Object with schema name: QueryParameterValue
              },
              "arrayValues": [ # [Optional] The array values, if this is an array type.
                # Object with schema name: QueryParameterValue
              ],
              "value": "A String", # [Optional] The value of this value, if a simple scalar type.
            },
            "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
          },
        ],
        "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.
        "query": "A String", # [Required] BigQuery SQL query to execute.
        "preserveNulls": True or False, # [Deprecated] This property is deprecated.
        "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
        "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
          "a_key": {
            "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
            "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
              "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 (',').
              "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.
              "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
              "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
              "quote": """, # [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.
              "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
            },
            "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
            "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
            "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
            "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
              "A String",
            ],
            "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
              "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
              "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
              "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
                {
                  "familyId": "A String", # Identifier of the column family.
                  "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
                  "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
                  "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                    {
                      "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                      "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                      "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                      "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                      "qualifierString": "A String",
                      "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                    },
                  ],
                  "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
                },
              ],
            },
            "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
            "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
              "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
            },
            "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
              "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                  "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                  "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                  "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                },
              ],
            },
          },
        },
        "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
      },
      "copy": { # [Pick one] Copies a table.
        "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.
        "sourceTables": [ # [Pick one] Source tables to copy.
          {
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        ],
        "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
        "destinationTable": { # [Required] The destination table
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
        "sourceTable": { # [Pick one] Source table to copy.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
      },
      "extract": { # [Pick one] Configures an extract job.
        "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
        "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
        "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
        "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
        "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
        "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
          "A String",
        ],
        "sourceTable": { # [Required] A reference to the table being exported.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this table.
        },
      },
    },
    "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 load job.
          "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
        },
        "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
        "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. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
        "query": { # [Output-only] Statistics for a query job.
          "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
            {
              "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
              "recordsWritten": "A String", # Number of records written by the stage.
              "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
              "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
              "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
              "steps": [ # List of operations within the stage in dependency order (approximately chronological).
                {
                  "kind": "A String", # Machine-readable operation type.
                  "substeps": [ # Human-readable stage descriptions.
                    "A String",
                  ],
                },
              ],
              "recordsRead": "A String", # Number of records read into the stage.
              "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
              "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
              "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
              "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
              "id": "A String", # Unique ID for stage within plan.
              "name": "A String", # Human-readable name for stage.
            },
          ],
          "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
          "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
          "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
          "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
            {
              "parameterType": { # [Required] The type of this parameter.
                "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                  {
                    "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                    "description": "A String", # [Optional] Human-oriented description of the field.
                    "name": "A String", # [Optional] The name of this field.
                  },
                ],
                "type": "A String", # [Required] The top level type of this field.
                "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
              },
              "parameterValue": { # [Required] The value of this parameter.
                "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                  "a_key": # Object with schema name: QueryParameterValue
                },
                "arrayValues": [ # [Optional] The array values, if this is an array type.
                  # Object with schema name: QueryParameterValue
                ],
                "value": "A String", # [Optional] The value of this value, if a simple scalar type.
              },
              "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
            },
          ],
          "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
          "billingTier": 42, # [Output-only] Billing tier for the job.
          "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
            {
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          ],
          "schema": { # [Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
            "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        },
        "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
        "extract": { # [Output-only] Statistics for an extract job.
          "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
            "A String",
          ],
        },
      },
      "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
        "projectId": "A String", # [Required] The ID of the project containing this job.
        "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
      },
      "etag": "A String", # [Output-only] A hash of this resource.
      "user_email": "A String", # [Output-only] Email address of the user who ran the job.
      "configuration": { # [Required] Describes the job configuration.
        "load": { # [Pick one] Configures a load job.
          "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". For Avro, specify "AVRO". The default value is CSV.
          "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. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',').
          "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
          "destinationTable": { # [Required] The destination table to load the data into.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. 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. The default value is 0, which requires that all records are valid.
          "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
            "A String",
          ],
          "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. 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 in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
            "A String",
          ],
          "quote": """, # [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.
          "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
            "A String",
          ],
          "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
          "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
            "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
              },
            ],
          },
        },
        "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.
        "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
          "a_key": "A String",
        },
        "query": { # [Pick one] Configures a query job.
          "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
          "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
          "useQueryCache": true, # [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. The default value is true.
          "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
            "projectId": "A String", # [Optional] The ID of the project containing this dataset.
            "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          },
          "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
          "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] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
            "A String",
          ],
          "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
          "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
          "allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
          "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
            {
              "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
              "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
            },
          ],
          "queryParameters": [ # Query parameters for standard SQL queries.
            {
              "parameterType": { # [Required] The type of this parameter.
                "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                  {
                    "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                    "description": "A String", # [Optional] Human-oriented description of the field.
                    "name": "A String", # [Optional] The name of this field.
                  },
                ],
                "type": "A String", # [Required] The top level type of this field.
                "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
              },
              "parameterValue": { # [Required] The value of this parameter.
                "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                  "a_key": # Object with schema name: QueryParameterValue
                },
                "arrayValues": [ # [Optional] The array values, if this is an array type.
                  # Object with schema name: QueryParameterValue
                ],
                "value": "A String", # [Optional] The value of this value, if a simple scalar type.
              },
              "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
            },
          ],
          "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.
          "query": "A String", # [Required] BigQuery SQL query to execute.
          "preserveNulls": True or False, # [Deprecated] This property is deprecated.
          "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
          "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
            "a_key": {
              "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
              "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
                "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 (',').
                "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.
                "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
                "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
                "quote": """, # [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.
                "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
              },
              "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
              "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
              "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
              "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
                "A String",
              ],
              "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
                "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
                "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
                "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
                  {
                    "familyId": "A String", # Identifier of the column family.
                    "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
                    "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
                    "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                      {
                        "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                        "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                        "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                        "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                        "qualifierString": "A String",
                        "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                      },
                    ],
                    "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
                  },
                ],
              },
              "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
              "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
                "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
              },
              "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
                "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                    "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                    "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                    "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                  },
                ],
              },
            },
          },
          "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
        },
        "copy": { # [Pick one] Copies a table.
          "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.
          "sourceTables": [ # [Pick one] Source tables to copy.
            {
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          ],
          "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
          "destinationTable": { # [Required] The destination table
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
          "sourceTable": { # [Pick one] Source table to copy.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
        "extract": { # [Pick one] Configures an extract job.
          "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
          "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
          "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
          "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
          "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
          "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
            "A String",
          ],
          "sourceTable": { # [Required] A reference to the table being exported.
            "projectId": "A String", # [Required] The ID of the project containing this table.
            "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            "datasetId": "A String", # [Required] The ID of the dataset containing this table.
          },
        },
      },
      "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 jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

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.
    "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 load job.
            "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
          },
          "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
          "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. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
          "query": { # [Output-only] Statistics for a query job.
            "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
              {
                "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
                "recordsWritten": "A String", # Number of records written by the stage.
                "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
                "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.
                "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.
                "steps": [ # List of operations within the stage in dependency order (approximately chronological).
                  {
                    "kind": "A String", # Machine-readable operation type.
                    "substeps": [ # Human-readable stage descriptions.
                      "A String",
                    ],
                  },
                ],
                "recordsRead": "A String", # Number of records read into the stage.
                "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
                "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.
                "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.
                "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
                "id": "A String", # Unique ID for stage within plan.
                "name": "A String", # Human-readable name for stage.
              },
            ],
            "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
            "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
            "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
            "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
              {
                "parameterType": { # [Required] The type of this parameter.
                  "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                    {
                      "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                      "description": "A String", # [Optional] Human-oriented description of the field.
                      "name": "A String", # [Optional] The name of this field.
                    },
                  ],
                  "type": "A String", # [Required] The top level type of this field.
                  "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
                },
                "parameterValue": { # [Required] The value of this parameter.
                  "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                    "a_key": # Object with schema name: QueryParameterValue
                  },
                  "arrayValues": [ # [Optional] The array values, if this is an array type.
                    # Object with schema name: QueryParameterValue
                  ],
                  "value": "A String", # [Optional] The value of this value, if a simple scalar type.
                },
                "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
              },
            ],
            "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
            "billingTier": 42, # [Output-only] Billing tier for the job.
            "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
              {
                "projectId": "A String", # [Required] The ID of the project containing this table.
                "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
                "datasetId": "A String", # [Required] The ID of the dataset containing this table.
              },
            ],
            "schema": { # [Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
              "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                  "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                  "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                  "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                },
              ],
            },
          },
          "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
          "extract": { # [Output-only] Statistics for an extract job.
            "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
              "A String",
            ],
          },
        },
        "jobReference": { # Job reference uniquely identifying the job.
          "projectId": "A String", # [Required] The ID of the project containing this job.
          "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
        },
        "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.
        "user_email": "A String", # [Full-projection-only] Email address of the user who ran the job.
        "configuration": { # [Full-projection-only] Specifies the job configuration.
          "load": { # [Pick one] Configures a load job.
            "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". For Avro, specify "AVRO". The default value is CSV.
            "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. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',').
            "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
            "destinationTable": { # [Required] The destination table to load the data into.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
            "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. 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. The default value is 0, which requires that all records are valid.
            "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
              "A String",
            ],
            "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. 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 in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
              "A String",
            ],
            "quote": """, # [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.
            "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
              "A String",
            ],
            "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
            "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
              "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                  "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                  "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                  "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                },
              ],
            },
          },
          "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.
          "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
            "a_key": "A String",
          },
          "query": { # [Pick one] Configures a query job.
            "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
            "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
            "useQueryCache": true, # [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. The default value is true.
            "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query.
              "projectId": "A String", # [Optional] The ID of the project containing this dataset.
              "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
            },
            "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
            "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] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
            "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
              "A String",
            ],
            "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
            "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
            "allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
            "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
              {
                "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
                "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
              },
            ],
            "queryParameters": [ # Query parameters for standard SQL queries.
              {
                "parameterType": { # [Required] The type of this parameter.
                  "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
                    {
                      "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
                      "description": "A String", # [Optional] Human-oriented description of the field.
                      "name": "A String", # [Optional] The name of this field.
                    },
                  ],
                  "type": "A String", # [Required] The top level type of this field.
                  "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
                },
                "parameterValue": { # [Required] The value of this parameter.
                  "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
                    "a_key": # Object with schema name: QueryParameterValue
                  },
                  "arrayValues": [ # [Optional] The array values, if this is an array type.
                    # Object with schema name: QueryParameterValue
                  ],
                  "value": "A String", # [Optional] The value of this value, if a simple scalar type.
                },
                "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
              },
            ],
            "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.
            "query": "A String", # [Required] BigQuery SQL query to execute.
            "preserveNulls": True or False, # [Deprecated] This property is deprecated.
            "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
            "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
              "a_key": {
                "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
                "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
                  "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 (',').
                  "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.
                  "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
                  "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
                  "quote": """, # [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.
                  "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
                },
                "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
                "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
                "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
                "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
                  "A String",
                ],
                "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
                  "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
                  "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
                  "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
                    {
                      "familyId": "A String", # Identifier of the column family.
                      "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
                      "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
                      "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                        {
                          "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                          "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                          "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                          "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                          "qualifierString": "A String",
                          "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                        },
                      ],
                      "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
                    },
                  ],
                },
                "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
                "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
                  "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
                },
                "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
                  "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
                      "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
                      "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
                      "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
                    },
                  ],
                },
              },
            },
            "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
          },
          "copy": { # [Pick one] Copies a table.
            "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.
            "sourceTables": [ # [Pick one] Source tables to copy.
              {
                "projectId": "A String", # [Required] The ID of the project containing this table.
                "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
                "datasetId": "A String", # [Required] The ID of the dataset containing this table.
              },
            ],
            "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
            "destinationTable": { # [Required] The destination table
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
            "sourceTable": { # [Pick one] Source table to copy.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          },
          "extract": { # [Pick one] Configures an extract job.
            "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
            "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
            "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
            "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
            "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
            "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
              "A String",
            ],
            "sourceTable": { # [Required] A reference to the table being exported.
              "projectId": "A String", # [Required] The ID of the project containing this table.
              "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
              "datasetId": "A String", # [Required] The ID of the dataset containing this table.
            },
          },
        },
        "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 the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
    "kind": "bigquery#queryRequest", # The resource type of the request.
    "dryRun": True or False, # [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
    "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
    "useQueryCache": true, # [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. The default value is true.
    "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 qualified in the format 'datasetId.tableId'.
      "projectId": "A String", # [Optional] The ID of the project containing this dataset.
      "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    },
    "useLegacySql": true, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
    "maxResults": 42, # [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.
    "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
      {
        "parameterType": { # [Required] The type of this parameter.
          "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
            {
              "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
              "description": "A String", # [Optional] Human-oriented description of the field.
              "name": "A String", # [Optional] The name of this field.
            },
          ],
          "type": "A String", # [Required] The top level type of this field.
          "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
        },
        "parameterValue": { # [Required] The value of this parameter.
          "structValues": { # [Optional] The struct field values, in order of the struct type's declaration.
            "a_key": # Object with schema name: QueryParameterValue
          },
          "arrayValues": [ # [Optional] The array values, if this is an array type.
            # Object with schema name: QueryParameterValue
          ],
          "value": "A String", # [Optional] The value of this value, if a simple scalar type.
        },
        "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
      },
    ],
    "query": "A String", # [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".
    "preserveNulls": True or False, # [Deprecated] This property is deprecated.
  }


Returns:
  An object of the form:

    {
    "kind": "bigquery#queryResponse", # The resource type.
    "errors": [ # [Output-only] All errors and warnings 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.
      },
    ],
    "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] The ID of the project containing this job.
      "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
    },
    "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.
    "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.
      {
        "f": [ # Represents a single row in the result set, consisting of one or more fields.
          {
            "v": "",
          },
        ],
      },
    ],
    "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
    "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
          "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
          "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
          "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/bigquery_v2.projects.html000066400000000000000000000061531300622755700250520ustar00rootroot00000000000000

BigQuery API . projects

Instance Methods

list(pageToken=None, maxResults=None)

Lists all projects to which you have been granted any project role.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(pageToken=None, maxResults=None) 
Lists all projects to which you have been granted any project role.

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.
google-api-python-client-1.5.5/docs/dyn/bigquery_v2.tabledata.html000066400000000000000000000130511300622755700251350ustar00rootroot00000000000000

BigQuery API . tabledata

Instance Methods

insertAll(projectId, datasetId, tableId, body)

Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.

list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)

Retrieves table data from a specified set of rows. Requires the READER dataset role.

Method Details

insertAll(projectId, datasetId, tableId, body) 
Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.

Args:
  projectId: string, Project ID of the destination table. (required)
  datasetId: string, Dataset ID of the destination table. (required)
  tableId: string, Table ID of the destination table. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
    "kind": "bigquery#tableDataInsertAllRequest", # The resource type of the response.
    "rows": [ # The rows to insert.
      {
        "insertId": "A String", # [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.
        "json": { # Represents a single JSON object. # [Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema.
          "a_key": "",
        },
      },
    ],
    "skipInvalidRows": True or False, # [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
    "templateSuffix": "A String", # [Experimental] If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
  }


Returns:
  An object of the form:

    {
    "kind": "bigquery#tableDataInsertAllResponse", # The resource type of the response.
    "insertErrors": [ # An array of errors for rows that were not inserted.
      {
        "index": 42, # The index of the row that error applies to.
        "errors": [ # Error information for the row indicated by the index property.
          {
            "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(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None) 
Retrieves table data from a specified set of rows. Requires the READER dataset role.

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 startIndex 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.
      {
        "f": [ # Represents a single row in the result set, consisting of one or more fields.
          {
            "v": "",
          },
        ],
      },
    ],
    "totalRows": "A String", # The total number of rows in the complete table.
  }
google-api-python-client-1.5.5/docs/dyn/bigquery_v2.tables.html000066400000000000000000003736401300622755700245030ustar00rootroot00000000000000

BigQuery API . tables

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. Requires the READER dataset role.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId, datasetId, tableId, body)

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.

update(projectId, datasetId, tableId, body)

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.

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.
      "view": { # [Optional] The view definition.
        "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
        "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
          {
            "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
            "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
          },
        ],
      },
      "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
        "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
          "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 (',').
          "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.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
          "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
          "quote": """, # [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.
          "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
        },
        "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
        "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
        "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
          "A String",
        ],
        "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
          "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
          "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
          "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
            {
              "familyId": "A String", # Identifier of the column family.
              "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
              "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
              "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                {
                  "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                  "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                  "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                  "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                  "qualifierString": "A String",
                  "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                },
              ],
              "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
            },
          ],
        },
        "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
        "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
        },
        "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
          "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      },
      "tableReference": { # [Required] Reference describing the ID of this table.
        "projectId": "A String", # [Required] The ID of the project containing this table.
        "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
        "datasetId": "A String", # [Required] The ID of the dataset containing this table.
      },
      "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
      "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
      "etag": "A String", # [Output-only] A hash of this resource.
      "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
      "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
        "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
        "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
        "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
      },
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
      "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
        "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
        "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
      },
      "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.
      "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
      "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
      "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.
      "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
    }
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.
    "view": { # [Optional] The view definition.
      "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
      "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
      "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
        {
          "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
          "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
        },
      ],
    },
    "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
      "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
      "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
        "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 (',').
        "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.
        "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
        "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
        "quote": """, # [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.
        "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
      },
      "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
      "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
      "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
      "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
        "A String",
      ],
      "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
        "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
        "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
        "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
          {
            "familyId": "A String", # Identifier of the column family.
            "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
            "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
            "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
              {
                "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                "qualifierString": "A String",
                "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
              },
            ],
            "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
          },
        ],
      },
      "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
      "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
        "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
      },
      "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
        "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
    },
    "tableReference": { # [Required] Reference describing the ID of this table.
      "projectId": "A String", # [Required] The ID of the project containing this table.
      "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      "datasetId": "A String", # [Required] The ID of the dataset containing this table.
    },
    "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
    "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
    "etag": "A String", # [Output-only] A hash of this resource.
    "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
    "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
      "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
      "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
      "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
    },
    "friendlyName": "A String", # [Optional] A descriptive name for this table.
    "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
      "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
      "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
    },
    "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.
    "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
          "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
          "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
          "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
        },
      ],
    },
    "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
    "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.
    "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
  }


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.
      "view": { # [Optional] The view definition.
        "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
        "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
          {
            "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
            "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
          },
        ],
      },
      "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
        "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
          "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 (',').
          "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.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
          "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
          "quote": """, # [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.
          "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
        },
        "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
        "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
        "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
          "A String",
        ],
        "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
          "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
          "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
          "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
            {
              "familyId": "A String", # Identifier of the column family.
              "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
              "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
              "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                {
                  "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                  "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                  "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                  "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                  "qualifierString": "A String",
                  "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                },
              ],
              "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
            },
          ],
        },
        "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
        "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
        },
        "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
          "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      },
      "tableReference": { # [Required] Reference describing the ID of this table.
        "projectId": "A String", # [Required] The ID of the project containing this table.
        "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
        "datasetId": "A String", # [Required] The ID of the dataset containing this table.
      },
      "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
      "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
      "etag": "A String", # [Output-only] A hash of this resource.
      "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
      "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
        "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
        "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
        "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
      },
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
      "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
        "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
        "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
      },
      "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.
      "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
      "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
      "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.
      "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
    }
list(projectId, datasetId, pageToken=None, maxResults=None) 
Lists all tables in the specified dataset. Requires the READER dataset role.

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.
        "type": "A String", # The type of table. Possible values are: TABLE, VIEW.
        "id": "A String", # An opaque ID of the table
        "tableReference": { # A reference uniquely identifying the table.
          "projectId": "A String", # [Required] The ID of the project containing this table.
          "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
          "datasetId": "A String", # [Required] The ID of the dataset containing this 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. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. 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.
    "view": { # [Optional] The view definition.
      "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
      "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
      "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
        {
          "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
          "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
        },
      ],
    },
    "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
      "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
      "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
        "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 (',').
        "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.
        "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
        "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
        "quote": """, # [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.
        "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
      },
      "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
      "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
      "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
      "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
        "A String",
      ],
      "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
        "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
        "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
        "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
          {
            "familyId": "A String", # Identifier of the column family.
            "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
            "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
            "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
              {
                "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                "qualifierString": "A String",
                "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
              },
            ],
            "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
          },
        ],
      },
      "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
      "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
        "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
      },
      "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
        "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
    },
    "tableReference": { # [Required] Reference describing the ID of this table.
      "projectId": "A String", # [Required] The ID of the project containing this table.
      "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      "datasetId": "A String", # [Required] The ID of the dataset containing this table.
    },
    "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
    "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
    "etag": "A String", # [Output-only] A hash of this resource.
    "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
    "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
      "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
      "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
      "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
    },
    "friendlyName": "A String", # [Optional] A descriptive name for this table.
    "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
      "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
      "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
    },
    "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.
    "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
          "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
          "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
          "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
        },
      ],
    },
    "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
    "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.
    "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
  }


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.
      "view": { # [Optional] The view definition.
        "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
        "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
          {
            "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
            "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
          },
        ],
      },
      "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
        "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
          "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 (',').
          "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.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
          "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
          "quote": """, # [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.
          "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
        },
        "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
        "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
        "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
          "A String",
        ],
        "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
          "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
          "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
          "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
            {
              "familyId": "A String", # Identifier of the column family.
              "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
              "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
              "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                {
                  "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                  "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                  "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                  "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                  "qualifierString": "A String",
                  "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                },
              ],
              "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
            },
          ],
        },
        "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
        "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
        },
        "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
          "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      },
      "tableReference": { # [Required] Reference describing the ID of this table.
        "projectId": "A String", # [Required] The ID of the project containing this table.
        "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
        "datasetId": "A String", # [Required] The ID of the dataset containing this table.
      },
      "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
      "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
      "etag": "A String", # [Output-only] A hash of this resource.
      "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
      "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
        "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
        "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
        "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
      },
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
      "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
        "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
        "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
      },
      "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.
      "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
      "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
      "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.
      "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
    }
update(projectId, datasetId, tableId, body) 
Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.

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.
    "view": { # [Optional] The view definition.
      "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
      "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
      "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
        {
          "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
          "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
        },
      ],
    },
    "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
      "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
      "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
        "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 (',').
        "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.
        "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
        "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
        "quote": """, # [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.
        "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
      },
      "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
      "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
      "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
      "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
        "A String",
      ],
      "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
        "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
        "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
        "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
          {
            "familyId": "A String", # Identifier of the column family.
            "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
            "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
            "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
              {
                "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                "qualifierString": "A String",
                "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
              },
            ],
            "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
          },
        ],
      },
      "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
      "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
        "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
      },
      "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
        "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
    },
    "tableReference": { # [Required] Reference describing the ID of this table.
      "projectId": "A String", # [Required] The ID of the project containing this table.
      "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
      "datasetId": "A String", # [Required] The ID of the dataset containing this table.
    },
    "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
    "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
    "etag": "A String", # [Output-only] A hash of this resource.
    "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
    "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
      "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
      "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
      "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
    },
    "friendlyName": "A String", # [Optional] A descriptive name for this table.
    "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
      "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
      "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
    },
    "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.
    "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
          "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
          "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
          "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
        },
      ],
    },
    "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
    "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.
    "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
  }


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.
      "view": { # [Optional] The view definition.
        "query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
        "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
        "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
          {
            "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
            "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
          },
        ],
      },
      "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
        "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "csvOptions": { # Additional properties to set if sourceFormat is set to CSV.
          "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 (',').
          "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.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
          "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
          "quote": """, # [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.
          "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
        },
        "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
        "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
        "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
        "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
          "A String",
        ],
        "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
          "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
          "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
          "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
            {
              "familyId": "A String", # Identifier of the column family.
              "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
              "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
              "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
                {
                  "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
                  "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
                  "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
                  "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
                  "qualifierString": "A String",
                  "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
                },
              ],
              "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
            },
          ],
        },
        "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
        "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
          "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
        },
        "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
          "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
              "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
              "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
              "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
            },
          ],
        },
      },
      "tableReference": { # [Required] Reference describing the ID of this table.
        "projectId": "A String", # [Required] The ID of the project containing this table.
        "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
        "datasetId": "A String", # [Required] The ID of the dataset containing this table.
      },
      "numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
      "numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
      "etag": "A String", # [Output-only] A hash of this resource.
      "location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.
      "streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
        "estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
        "estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
        "oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
      },
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
      "timePartitioning": { # [Experimental] If specified, configures time-based partitioning for this table.
        "type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day based on data loading time.
        "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for a partition.
      },
      "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.
      "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, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP, DATE, TIME, DATETIME, or RECORD (where RECORD indicates that the field contains a nested schema).
            "description": "A String", # [Optional] The field description. The maximum length is 16K characters.
            "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
            "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
          },
        ],
      },
      "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
      "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.
      "numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".
    }
google-api-python-client-1.5.5/docs/dyn/blogger_v2.blogs.html000066400000000000000000000052631300622755700241220ustar00rootroot00000000000000

Blogger API . blogs

Instance Methods

get(blogId)

Gets one blog by id.

Method Details

get(blogId) 
Gets one blog by id.

Args:
  blogId: string, The ID of the blog to get. (required)

Returns:
  An object of the form:

    {
    "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
    "description": "A String", # The description of this blog. This is displayed underneath the title.
    "locale": { # The locale this Blog is set to.
      "country": "A String", # The country this blog's locale is set to.
      "variant": "A String", # The language variant this blog is authored in.
      "language": "A String", # The language this blog is authored in.
    },
    "posts": { # The container of posts in this blog.
      "totalItems": 42, # The count of posts in this blog.
      "selfLink": "A String", # The URL of the container for posts in this blog.
    },
    "updated": "A String", # RFC 3339 date-time when this blog was last updated.
    "id": "A String", # The identifier for this resource.
    "url": "A String", # The URL where this blog is published.
    "published": "A String", # RFC 3339 date-time when this blog was published.
    "pages": { # The container of pages in this blog.
      "totalItems": 42, # The count of pages in this blog.
      "selfLink": "A String", # The URL of the container for pages in this blog.
    },
    "selfLink": "A String", # The API REST URL to fetch this resource from.
    "name": "A String", # The name of this blog. This is displayed as the title.
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v2.comments.html000066400000000000000000000141271300622755700246400ustar00rootroot00000000000000

Blogger API . comments

Instance Methods

get(blogId, postId, commentId)

Gets one comment by id.

list(blogId, postId, startDate=None, fetchBodies=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, 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.
  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.
google-api-python-client-1.5.5/docs/dyn/blogger_v2.html000066400000000000000000000052021300622755700230060ustar00rootroot00000000000000

Blogger API

Instance Methods

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/blogger_v2.pages.html000066400000000000000000000105731300622755700241130ustar00rootroot00000000000000

Blogger API . pages

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
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v2.posts.html000066400000000000000000000137641300622755700241710ustar00rootroot00000000000000

Blogger API . posts

Instance Methods

get(blogId, postId)

Get a post by id.

list(blogId, startDate=None, pageToken=None, maxResults=None, fetchBodies=None)

Retrieves a list of posts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(blogId, postId) 
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)

Returns:
  An object of the form:

    {
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "author": { # The author of this Post.
      "url": "A String", # The URL of the Post creator's Profile page.
      "image": { # The Post author's avatar.
        "url": "A String", # The Post author's avatar URL.
      },
      "displayName": "A String", # The display name.
      "id": "A String", # The identifier of the Post creator.
    },
    "replies": { # The container of comments on this Post.
      "totalItems": "A String", # The count of comments on this post.
      "selfLink": "A String", # The URL of the comments on this post.
    },
    "labels": [ # The list of labels this Post was tagged with.
      "A String",
    ],
    "updated": "A String", # RFC 3339 date-time when this Post was last updated.
    "blog": { # Data about the blog containing this Post.
      "id": "A String", # The identifier of the Blog that contains this Post.
    },
    "url": "A String", # The URL where this Post is displayed.
    "published": "A String", # RFC 3339 date-time when this Post was published.
    "title": "A String", # The title of the Post.
    "id": "A String", # The identifier of this Post.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }
list(blogId, startDate=None, pageToken=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.
  pageToken: string, Continuation token if the request is paged.
  maxResults: integer, Maximum number of posts to fetch.
  fetchBodies: boolean, Whether the body content of posts is included.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    "items": [ # The list of Posts for this Blog.
      {
        "content": "A String", # The content of the Post. May contain HTML markup.
        "kind": "blogger#post", # The kind of this entity. Always blogger#post
        "author": { # The author of this Post.
          "url": "A String", # The URL of the Post creator's Profile page.
          "image": { # The Post author's avatar.
            "url": "A String", # The Post author's avatar URL.
          },
          "displayName": "A String", # The display name.
          "id": "A String", # The identifier of the Post creator.
        },
        "replies": { # The container of comments on this Post.
          "totalItems": "A String", # The count of comments on this post.
          "selfLink": "A String", # The URL of the comments on this post.
        },
        "labels": [ # The list of labels this Post was tagged with.
          "A String",
        ],
        "updated": "A String", # RFC 3339 date-time when this Post was last updated.
        "blog": { # Data about the blog containing this Post.
          "id": "A String", # The identifier of the Blog that contains this Post.
        },
        "url": "A String", # The URL where this Post is displayed.
        "published": "A String", # RFC 3339 date-time when this Post was published.
        "title": "A String", # The title of the Post.
        "id": "A String", # The identifier of this Post.
        "selfLink": "A String", # The API REST URL to fetch this resource from.
      },
    ],
    "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
  }
list_next(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.
google-api-python-client-1.5.5/docs/dyn/blogger_v2.users.blogs.html000066400000000000000000000062131300622755700252560ustar00rootroot00000000000000

Blogger API . users . blogs

Instance Methods

list(userId)

Retrieves a list of blogs, possibly filtered.

Method Details

list(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.
          "selfLink": "A String", # The URL of the container for posts in this blog.
        },
        "updated": "A String", # RFC 3339 date-time when this blog was last updated.
        "id": "A String", # The identifier for this resource.
        "url": "A String", # The URL where this blog is published.
        "published": "A String", # RFC 3339 date-time when this blog was published.
        "pages": { # The container of pages in this blog.
          "totalItems": 42, # The count of pages in this blog.
          "selfLink": "A String", # The URL of the container for pages in this blog.
        },
        "selfLink": "A String", # The API REST URL to fetch this resource from.
        "name": "A String", # The name of this blog. This is displayed as the title.
      },
    ],
    "kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v2.users.html000066400000000000000000000045571300622755700241620ustar00rootroot00000000000000

Blogger API . users

Instance Methods

blogs()

Returns the blogs Resource.

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.
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.blogUserInfos.html000066400000000000000000000201731300622755700255730ustar00rootroot00000000000000

Blogger API . blogUserInfos

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": { # The Blog resource.
      "status": "A String", # The status of the 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.
          {
            "status": "A String", # Status of the post. Only set for admin-level requests
            "content": "A String", # The content of the Post. May contain HTML markup.
            "kind": "blogger#post", # The kind of this entity. Always blogger#post
            "titleLink": "A String", # The title link URL, similar to atom's related link.
            "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.
                {
                  "status": "A String", # The status of the comment (only populated for admin users)
                  "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.
            },
            "readerComments": "A String", # Comment control and display setting for readers of 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.
            "etag": "A String", # Etag of the resource.
            "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.
            "images": [ # Display image for the Post.
              {
                "url": "A String",
              },
            ],
            "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", # The kind of this entity. Always blogger#blogUserInfo
    "blog_user_info": { # Information about a User for the Blog.
      "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
      "kind": "blogger#blogPerUserInfo", # The kind of this entity. Always blogger#blogPerUserInfo
      "userId": "A String", # ID of the User
      "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
      "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog
      "blogId": "A String", # ID of the Blog resource
    },
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.blogs.html000066400000000000000000000677151300622755700241350ustar00rootroot00000000000000

Blogger API . blogs

Instance Methods

get(blogId, maxPosts=None, view=None)

Gets one blog by ID.

getByUrl(url, view=None)

Retrieve a Blog by URL.

listByUser(userId, status=None, fetchUserInfo=None, role=None, view=None)

Retrieves a list of blogs, possibly filtered.

Method Details

get(blogId, maxPosts=None, view=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.
  view: string, Access level with which to view the blog. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail.
      AUTHOR - Author level detail.
      READER - Reader level detail.

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the 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.
        {
          "status": "A String", # Status of the post. Only set for admin-level requests
          "content": "A String", # The content of the Post. May contain HTML markup.
          "kind": "blogger#post", # The kind of this entity. Always blogger#post
          "titleLink": "A String", # The title link URL, similar to atom's related link.
          "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.
              {
                "status": "A String", # The status of the comment (only populated for admin users)
                "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.
          },
          "readerComments": "A String", # Comment control and display setting for readers of 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.
          "etag": "A String", # Etag of the resource.
          "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.
          "images": [ # Display image for the Post.
            {
              "url": "A String",
            },
          ],
          "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, view=None) 
Retrieve a Blog by URL.

Args:
  url: string, The URL of the blog to retrieve. (required)
  view: string, Access level with which to view the blog. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail.
      AUTHOR - Author level detail.
      READER - Reader level detail.

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the 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.
        {
          "status": "A String", # Status of the post. Only set for admin-level requests
          "content": "A String", # The content of the Post. May contain HTML markup.
          "kind": "blogger#post", # The kind of this entity. Always blogger#post
          "titleLink": "A String", # The title link URL, similar to atom's related link.
          "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.
              {
                "status": "A String", # The status of the comment (only populated for admin users)
                "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.
          },
          "readerComments": "A String", # Comment control and display setting for readers of 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.
          "etag": "A String", # Etag of the resource.
          "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.
          "images": [ # Display image for the Post.
            {
              "url": "A String",
            },
          ],
          "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, status=None, fetchUserInfo=None, role=None, view=None) 
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)
  status: string, Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. (repeated)
    Allowed values
      DELETED - Blog has been deleted by an administrator.
      LIVE - Blog is currently live.
  fetchUserInfo: boolean, Whether the response is a list of blogs with per-user information instead of just blogs.
  role: string, User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. (repeated)
    Allowed values
      ADMIN - Admin role - Blogs where the user has Admin level access.
      AUTHOR - Author role - Blogs where the user has Author level access.
      READER - Reader role - Blogs where the user has Reader level access (to a private blog).
  view: string, Access level with which to view the blogs. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail.
      AUTHOR - Author level detail.
      READER - Reader level detail.

Returns:
  An object of the form:

    {
    "items": [ # The list of Blogs this user has Authorship or Admin rights over.
      {
        "status": "A String", # The status of the 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.
            {
              "status": "A String", # Status of the post. Only set for admin-level requests
              "content": "A String", # The content of the Post. May contain HTML markup.
              "kind": "blogger#post", # The kind of this entity. Always blogger#post
              "titleLink": "A String", # The title link URL, similar to atom's related link.
              "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.
                  {
                    "status": "A String", # The status of the comment (only populated for admin users)
                    "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.
              },
              "readerComments": "A String", # Comment control and display setting for readers of 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.
              "etag": "A String", # Etag of the resource.
              "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.
              "images": [ # Display image for the Post.
                {
                  "url": "A String",
                },
              ],
              "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
    "blogUserInfos": [ # Admin level list of blog per-user information
      {
        "blog": { # The Blog resource.
          "status": "A String", # The status of the 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.
              {
                "status": "A String", # Status of the post. Only set for admin-level requests
                "content": "A String", # The content of the Post. May contain HTML markup.
                "kind": "blogger#post", # The kind of this entity. Always blogger#post
                "titleLink": "A String", # The title link URL, similar to atom's related link.
                "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.
                    {
                      "status": "A String", # The status of the comment (only populated for admin users)
                      "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.
                },
                "readerComments": "A String", # Comment control and display setting for readers of 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.
                "etag": "A String", # Etag of the resource.
                "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.
                "images": [ # Display image for the Post.
                  {
                    "url": "A String",
                  },
                ],
                "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", # The kind of this entity. Always blogger#blogUserInfo
        "blog_user_info": { # Information about a User for the Blog.
          "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
          "kind": "blogger#blogPerUserInfo", # The kind of this entity. Always blogger#blogPerUserInfo
          "userId": "A String", # ID of the User
          "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
          "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog
          "blogId": "A String", # ID of the Blog resource
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.comments.html000066400000000000000000000423271300622755700246440ustar00rootroot00000000000000

Blogger API . comments

Instance Methods

approve(blogId, postId, commentId)

Marks a comment as not spam.

delete(blogId, postId, commentId)

Delete a comment by ID.

get(blogId, postId, commentId, view=None)

Gets one comment by ID.

list(blogId, postId, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)

Retrieves the comments for a post, possibly filtered.

listByBlog(blogId, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)

Retrieves the comments for a blog, across all posts, possibly filtered.

listByBlog_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

markAsSpam(blogId, postId, commentId)

Marks a comment as spam.

removeContent(blogId, postId, commentId)

Removes the content of a comment.

Method Details

approve(blogId, postId, commentId) 
Marks a comment as not spam.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to mark as not spam. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "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.
  }
delete(blogId, postId, commentId) 
Delete a comment by ID.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to delete. (required)
get(blogId, postId, commentId, view=None) 
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)
  view: string, Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Admin level detail

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "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, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None) 
Retrieves the comments for a post, 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)
  status: string, A parameter (repeated)
    Allowed values
      emptied - Comments that have had their content removed
      live - Comments that are publicly visible
      pending - Comments that are awaiting administrator approval
      spam - Comments marked as spam by the administrator
  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.
  view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

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.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "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
    "etag": "A String", # Etag of the response.
    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
  }
listByBlog(blogId, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None) 
Retrieves the comments for a blog, across all posts, possibly filtered.

Args:
  blogId: string, ID of the blog to fetch comments from. (required)
  status: string, A parameter (repeated)
    Allowed values
      emptied - Comments that have had their content removed
      live - Comments that are publicly visible
      pending - Comments that are awaiting administrator approval
      spam - Comments marked as spam by the administrator
  startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
  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.
  fetchBodies: boolean, Whether the body content of the comments 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 Comments for a Post.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "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
    "etag": "A String", # Etag of the response.
    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
  }
listByBlog_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.
markAsSpam(blogId, postId, commentId) 
Marks a comment as spam.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to mark as spam. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "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.
  }
removeContent(blogId, postId, commentId) 
Removes the content of a comment.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to delete content from. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.html000066400000000000000000000061501300622755700230120ustar00rootroot00000000000000

Blogger API

Instance Methods

blogUserInfos()

Returns the blogUserInfos Resource.

blogs()

Returns the blogs Resource.

comments()

Returns the comments Resource.

pageViews()

Returns the pageViews Resource.

pages()

Returns the pages Resource.

postUserInfos()

Returns the postUserInfos Resource.

posts()

Returns the posts Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/blogger_v3.pageViews.html000066400000000000000000000040371300622755700247450ustar00rootroot00000000000000

Blogger API . pageViews

Instance Methods

get(blogId, range=None)

Retrieve pageview stats for a Blog.

Method Details

get(blogId, range=None) 
Retrieve pageview stats for a Blog.

Args:
  blogId: string, The ID of the blog to get. (required)
  range: string, A parameter (repeated)
    Allowed values
      30DAYS - Page view counts from the last thirty days.
      7DAYS - Page view counts from the last seven days.
      all - Total page view counts from all time.

Returns:
  An object of the form:

    {
    "counts": [ # The container of posts in this blog.
      {
        "count": "A String", # Count of page views for the given time range
        "timeRange": "A String", # Time range the given count applies to
      },
    ],
    "blogId": "A String", # Blog Id
    "kind": "blogger#page_views", # The kind of this entry. Always blogger#page_views
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.pages.html000066400000000000000000000472301300622755700241140ustar00rootroot00000000000000

Blogger API . pages

Instance Methods

delete(blogId, pageId)

Delete a page by ID.

get(blogId, pageId, view=None)

Gets one blog page by ID.

insert(blogId, body, isDraft=None)

Add a page.

list(blogId, status=None, pageToken=None, maxResults=None, fetchBodies=None, view=None)

Retrieves the pages for a blog, optionally including non-LIVE statuses.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(blogId, pageId, body, revert=None, publish=None)

Update a page. This method supports patch semantics.

publish(blogId, pageId)

Publishes a draft page.

revert(blogId, pageId)

Revert a published or scheduled page to draft state.

update(blogId, pageId, body, revert=None, publish=None)

Update a page.

Method Details

delete(blogId, pageId) 
Delete a page by ID.

Args:
  blogId: string, The ID of the Blog. (required)
  pageId: string, The ID of the Page. (required)
get(blogId, pageId, view=None) 
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)
  view: string, A parameter
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "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.
      },
      "etag": "A String", # Etag of the resource.
      "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.
    }
insert(blogId, body, isDraft=None) 
Add a page.

Args:
  blogId: string, ID of the blog to add the page to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
    "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.
    },
    "etag": "A String", # Etag of the resource.
    "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.
  }

  isDraft: boolean, Whether to create the page as a draft (default: false).

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "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.
      },
      "etag": "A String", # Etag of the resource.
      "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, status=None, pageToken=None, maxResults=None, fetchBodies=None, view=None) 
Retrieves the pages for a blog, optionally including non-LIVE statuses.

Args:
  blogId: string, ID of the blog to fetch Pages from. (required)
  status: string, A parameter (repeated)
    Allowed values
      draft - Draft (unpublished) Pages
      live - Pages that are publicly visible
  pageToken: string, Continuation token if the request is paged.
  maxResults: integer, Maximum number of Pages to fetch.
  fetchBodies: boolean, Whether to retrieve the Page bodies.
  view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    "items": [ # The list of Pages for a Blog.
      {
          "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
          "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.
          },
          "etag": "A String", # Etag of the resource.
          "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
    "etag": "A String", # Etag of the 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.
patch(blogId, pageId, body, revert=None, publish=None) 
Update a page. This method supports patch semantics.

Args:
  blogId: string, The ID of the Blog. (required)
  pageId: string, The ID of the Page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
    "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.
    },
    "etag": "A String", # Etag of the resource.
    "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.
  }

  revert: boolean, Whether a revert action should be performed when the page is updated (default: false).
  publish: boolean, Whether a publish action should be performed when the page is updated (default: false).

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "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.
      },
      "etag": "A String", # Etag of the resource.
      "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.
    }
publish(blogId, pageId) 
Publishes a draft page.

Args:
  blogId: string, The ID of the blog. (required)
  pageId: string, The ID of the page. (required)

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "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.
      },
      "etag": "A String", # Etag of the resource.
      "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.
    }
revert(blogId, pageId) 
Revert a published or scheduled page to draft state.

Args:
  blogId: string, The ID of the blog. (required)
  pageId: string, The ID of the page. (required)

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "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.
      },
      "etag": "A String", # Etag of the resource.
      "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.
    }
update(blogId, pageId, body, revert=None, publish=None) 
Update a page.

Args:
  blogId: string, The ID of the Blog. (required)
  pageId: string, The ID of the Page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
    "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.
    },
    "etag": "A String", # Etag of the resource.
    "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.
  }

  revert: boolean, Whether a revert action should be performed when the page is updated (default: false).
  publish: boolean, Whether a publish action should be performed when the page is updated (default: false).

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "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.
      },
      "etag": "A String", # Etag of the resource.
      "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.
    }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.postUserInfos.html000066400000000000000000000341131300622755700256340ustar00rootroot00000000000000

Blogger API . postUserInfos

Instance Methods

get(userId, blogId, postId, maxComments=None)

Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.

list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)

Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(userId, blogId, postId, maxComments=None) 
Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.

Args:
  userId: string, ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
  blogId: string, The ID of the blog. (required)
  postId: string, The ID of the post to get. (required)
  maxComments: integer, Maximum number of comments to pull back on a post.

Returns:
  An object of the form:

    {
    "kind": "blogger#postUserInfo", # The kind of this entity. Always blogger#postUserInfo
    "post": { # The Post resource.
      "status": "A String", # Status of the post. Only set for admin-level requests
      "content": "A String", # The content of the Post. May contain HTML markup.
      "kind": "blogger#post", # The kind of this entity. Always blogger#post
      "titleLink": "A String", # The title link URL, similar to atom's related link.
      "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.
          {
            "status": "A String", # The status of the comment (only populated for admin users)
            "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.
      },
      "readerComments": "A String", # Comment control and display setting for readers of 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.
      "etag": "A String", # Etag of the resource.
      "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.
      "images": [ # Display image for the Post.
        {
          "url": "A String",
        },
      ],
      "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.
    },
    "post_user_info": { # Information about a User for the Post.
      "kind": "blogger#postPerUserInfo", # The kind of this entity. Always blogger#postPerUserInfo
      "postId": "A String", # ID of the Post resource.
      "userId": "A String", # ID of the User.
      "blogId": "A String", # ID of the Blog that the post resource belongs to.
      "hasEditAccess": True or False, # True if the user has Author level access to the post.
    },
  }
list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None) 
Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.

Args:
  userId: string, ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
  blogId: string, ID of the blog to fetch posts from. (required)
  orderBy: string, Sort order applied to search results. Default is published.
    Allowed values
      published - Order by the date the post was published
      updated - Order by the date the post was last updated
  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.
  labels: string, Comma-separated list of labels to search for.
  pageToken: string, Continuation token if the request is paged.
  status: string, A parameter (repeated)
    Allowed values
      draft - Draft posts
      live - Published posts
      scheduled - Posts that are scheduled to publish in future.
  maxResults: integer, Maximum number of posts to fetch.
  fetchBodies: boolean, Whether the body content of posts is included. Default is false.
  view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    "items": [ # The list of Posts with User information for the post, for this Blog.
      {
        "kind": "blogger#postUserInfo", # The kind of this entity. Always blogger#postUserInfo
        "post": { # The Post resource.
          "status": "A String", # Status of the post. Only set for admin-level requests
          "content": "A String", # The content of the Post. May contain HTML markup.
          "kind": "blogger#post", # The kind of this entity. Always blogger#post
          "titleLink": "A String", # The title link URL, similar to atom's related link.
          "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.
              {
                "status": "A String", # The status of the comment (only populated for admin users)
                "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.
          },
          "readerComments": "A String", # Comment control and display setting for readers of 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.
          "etag": "A String", # Etag of the resource.
          "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.
          "images": [ # Display image for the Post.
            {
              "url": "A String",
            },
          ],
          "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.
        },
        "post_user_info": { # Information about a User for the Post.
          "kind": "blogger#postPerUserInfo", # The kind of this entity. Always blogger#postPerUserInfo
          "postId": "A String", # ID of the Post resource.
          "userId": "A String", # ID of the User.
          "blogId": "A String", # ID of the Blog that the post resource belongs to.
          "hasEditAccess": True or False, # True if the user has Author level access to the post.
        },
      },
    ],
    "kind": "blogger#postUserInfosList", # The kind of this entity. Always blogger#postList
  }
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.
google-api-python-client-1.5.5/docs/dyn/blogger_v3.posts.html000066400000000000000000001564741300622755700242000ustar00rootroot00000000000000

Blogger API . posts

Instance Methods

delete(blogId, postId)

Delete a post by ID.

get(blogId, postId, maxComments=None, fetchImages=None, fetchBody=None, view=None)

Get a post by ID.

getByPath(blogId, path, maxComments=None, view=None)

Retrieve a Post by Path.

insert(blogId, body, isDraft=None, fetchImages=None, fetchBody=None)

Add a post.

list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, fetchImages=None, view=None)

Retrieves a list of posts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)

Update a post. This method supports patch semantics.

publish(blogId, postId, publishDate=None)

Publishes a draft post, optionally at the specific time of the given publishDate parameter.

revert(blogId, postId)

Revert a published or scheduled post to draft state.

search(blogId, q, orderBy=None, fetchBodies=None)

Search for a post.

update(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None)

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, fetchImages=None, fetchBody=None, view=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.
  fetchImages: boolean, Whether image URL metadata for each post is included (default: false).
  fetchBody: boolean, Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
  view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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, view=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.
  view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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, isDraft=None, fetchImages=None, fetchBody=None) 
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:

{
  "status": "A String", # Status of the post. Only set for admin-level requests
  "content": "A String", # The content of the Post. May contain HTML markup.
  "kind": "blogger#post", # The kind of this entity. Always blogger#post
  "titleLink": "A String", # The title link URL, similar to atom's related link.
  "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.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "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.
  },
  "readerComments": "A String", # Comment control and display setting for readers of 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.
  "etag": "A String", # Etag of the resource.
  "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.
  "images": [ # Display image for the Post.
    {
      "url": "A String",
    },
  ],
  "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.
}

  isDraft: boolean, Whether to create the post as a draft (default: false).
  fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
  fetchBody: boolean, Whether the body content of the post is included with the result (default: true).

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, fetchImages=None, view=None) 
Retrieves a list of posts, possibly filtered.

Args:
  blogId: string, ID of the blog to fetch posts from. (required)
  orderBy: string, Sort search results
    Allowed values
      published - Order by the date the post was published
      updated - Order by the date the post was last updated
  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.
  labels: string, Comma-separated list of labels to search for.
  pageToken: string, Continuation token if the request is paged.
  status: string, Statuses to include in the results. (repeated)
    Allowed values
      draft - Draft (non-published) posts.
      live - Published posts
      scheduled - Posts that are scheduled to publish in the future.
  maxResults: integer, Maximum number of posts to fetch.
  fetchBodies: boolean, Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.
  fetchImages: boolean, Whether image URL metadata for each post is included.
  view: string, Access level with which to view the returned result. Note that some fields require escalated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

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.
      {
        "status": "A String", # Status of the post. Only set for admin-level requests
        "content": "A String", # The content of the Post. May contain HTML markup.
        "kind": "blogger#post", # The kind of this entity. Always blogger#post
        "titleLink": "A String", # The title link URL, similar to atom's related link.
        "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.
            {
              "status": "A String", # The status of the comment (only populated for admin users)
              "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.
        },
        "readerComments": "A String", # Comment control and display setting for readers of 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.
        "etag": "A String", # Etag of the resource.
        "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.
        "images": [ # Display image for the Post.
          {
            "url": "A String",
          },
        ],
        "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
    "etag": "A String", # Etag of the 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.
patch(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None) 
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:

{
  "status": "A String", # Status of the post. Only set for admin-level requests
  "content": "A String", # The content of the Post. May contain HTML markup.
  "kind": "blogger#post", # The kind of this entity. Always blogger#post
  "titleLink": "A String", # The title link URL, similar to atom's related link.
  "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.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "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.
  },
  "readerComments": "A String", # Comment control and display setting for readers of 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.
  "etag": "A String", # Etag of the resource.
  "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.
  "images": [ # Display image for the Post.
    {
      "url": "A String",
    },
  ],
  "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.
}

  maxComments: integer, Maximum number of comments to retrieve with the returned post.
  revert: boolean, Whether a revert action should be performed when the post is updated (default: false).
  publish: boolean, Whether a publish action should be performed when the post is updated (default: false).
  fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
  fetchBody: boolean, Whether the body content of the post is included with the result (default: true).

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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.
  }
publish(blogId, postId, publishDate=None) 
Publishes a draft post, optionally at the specific time of the given publishDate parameter.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  publishDate: string, Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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.
  }
revert(blogId, postId) 
Revert a published or scheduled post to draft state.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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, orderBy=None, fetchBodies=None) 
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)
  orderBy: string, Sort search results
    Allowed values
      published - Order by the date the post was published
      updated - Order by the date the post was last updated
  fetchBodies: boolean, Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.

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.
      {
        "status": "A String", # Status of the post. Only set for admin-level requests
        "content": "A String", # The content of the Post. May contain HTML markup.
        "kind": "blogger#post", # The kind of this entity. Always blogger#post
        "titleLink": "A String", # The title link URL, similar to atom's related link.
        "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.
            {
              "status": "A String", # The status of the comment (only populated for admin users)
              "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.
        },
        "readerComments": "A String", # Comment control and display setting for readers of 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.
        "etag": "A String", # Etag of the resource.
        "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.
        "images": [ # Display image for the Post.
          {
            "url": "A String",
          },
        ],
        "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
    "etag": "A String", # Etag of the response.
  }
update(blogId, postId, body, maxComments=None, revert=None, publish=None, fetchImages=None, fetchBody=None) 
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:

{
  "status": "A String", # Status of the post. Only set for admin-level requests
  "content": "A String", # The content of the Post. May contain HTML markup.
  "kind": "blogger#post", # The kind of this entity. Always blogger#post
  "titleLink": "A String", # The title link URL, similar to atom's related link.
  "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.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "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.
  },
  "readerComments": "A String", # Comment control and display setting for readers of 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.
  "etag": "A String", # Etag of the resource.
  "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.
  "images": [ # Display image for the Post.
    {
      "url": "A String",
    },
  ],
  "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.
}

  maxComments: integer, Maximum number of comments to retrieve with the returned post.
  revert: boolean, Whether a revert action should be performed when the post is updated (default: false).
  publish: boolean, Whether a publish action should be performed when the post is updated (default: false).
  fetchImages: boolean, Whether image URL metadata for each post is included in the returned result (default: false).
  fetchBody: boolean, Whether the body content of the post is included with the result (default: true).

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the post. Only set for admin-level requests
    "content": "A String", # The content of the Post. May contain HTML markup.
    "kind": "blogger#post", # The kind of this entity. Always blogger#post
    "titleLink": "A String", # The title link URL, similar to atom's related link.
    "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.
        {
          "status": "A String", # The status of the comment (only populated for admin users)
          "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.
    },
    "readerComments": "A String", # Comment control and display setting for readers of 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.
    "etag": "A String", # Etag of the resource.
    "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.
    "images": [ # Display image for the Post.
      {
        "url": "A String",
      },
    ],
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/blogger_v3.users.html000066400000000000000000000043331300622755700241530ustar00rootroot00000000000000

Blogger API . users

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.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.bookshelves.html000066400000000000000000000102131300622755700250220ustar00rootroot00000000000000

Books API . bookshelves

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.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.bookshelves.volumes.html000066400000000000000000000500721300622755700265220ustar00rootroot00000000000000

Books API . bookshelves . volumes

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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.cloudloading.html000066400000000000000000000055051300622755700251520ustar00rootroot00000000000000

Books API . cloudloading

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",
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.dictionary.html000066400000000000000000000035621300622755700246540ustar00rootroot00000000000000

Books API . dictionary

Instance Methods

listOfflineMetadata(cpksver)

Returns a list of offline dictionary metadata available

Method Details

listOfflineMetadata(cpksver) 
Returns a list of offline dictionary metadata available

Args:
  cpksver: string, The device/version ID from which to request the data. (required)

Returns:
  An object of the form:

    {
    "items": [ # A list of offline dictionary metadata.
      {
        "encrypted_key": "A String",
        "version": "A String",
        "language": "A String",
        "download_url": "A String",
        "size": "A String",
      },
    ],
    "kind": "dictionary#metadata", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.html000066400000000000000000000073601300622755700225100ustar00rootroot00000000000000

Books API

Instance Methods

bookshelves()

Returns the bookshelves Resource.

cloudloading()

Returns the cloudloading Resource.

dictionary()

Returns the dictionary Resource.

layers()

Returns the layers Resource.

myconfig()

Returns the myconfig Resource.

mylibrary()

Returns the mylibrary Resource.

notification()

Returns the notification Resource.

onboarding()

Returns the onboarding Resource.

personalizedstream()

Returns the personalizedstream Resource.

promooffer()

Returns the promooffer Resource.

series()

Returns the series Resource.

volumes()

Returns the volumes Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/books_v1.layers.annotationData.html000066400000000000000000000147401300622755700267510ustar00rootroot00000000000000

Books API . layers . annotationData

Instance Methods

get(volumeId, layerId, annotationDataId, contentVersion, scale=None, allowWebDefinitions=None, w=None, source=None, h=None, locale=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, allowWebDefinitions=None, w=None, source=None, h=None, locale=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.
  allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions.
  w: integer, The requested pixel width for any images. If width is provided height must also be provided.
  source: string, String to identify the originator of this request.
  h: integer, The requested pixel height for any images. If height is provided width must also be provided.
  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 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.
google-api-python-client-1.5.5/docs/dyn/books_v1.layers.html000066400000000000000000000125751300622755700240120ustar00rootroot00000000000000

Books API . layers

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.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.layers.volumeAnnotations.html000066400000000000000000000234411300622755700275300ustar00rootroot00000000000000

Books API . layers . volumeAnnotations

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.
google-api-python-client-1.5.5/docs/dyn/books_v1.myconfig.html000066400000000000000000000703601300622755700243220ustar00rootroot00000000000000

Books API . myconfig

Instance Methods

getUserSettings()

Gets the current settings for the user.

releaseDownloadAccess(volumeIds, cpksver, source=None, locale=None)

Release downloaded content access restriction.

requestAccess(source, volumeId, nonce, cpksver, licenseTypes=None, locale=None)

Request concurrent and download access restrictions.

syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, includeNonComicsSeries=None, showPreorders=None, volumeIds=None)

Request downloaded content access for specified volumes on the My eBooks shelf.

updateUserSettings(body)

Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.

Method Details

getUserSettings() 
Gets the current settings for the user.

Args:

Returns:
  An object of the form:

    {
    "notification": {
      "moreFromSeries": {
        "opted_state": "A String",
      },
      "moreFromAuthors": {
        "opted_state": "A String",
      },
    },
    "kind": "books#usersettings", # Resource type.
    "notesExport": { # User settings in sub-objects, each for different purposes.
      "isEnabled": True or False,
      "folderName": "A String",
    },
  }
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, licenseTypes=None, 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)
  licenseTypes: string, The type of access license to request. If not specified, the default is BOTH.
    Allowed values
      BOTH - Both concurrent and download licenses.
      CONCURRENT - Concurrent access license.
      DOWNLOAD - Offline download access license.
  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, includeNonComicsSeries=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.
  includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.
  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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
updateUserSettings(body) 
Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
  "notification": {
    "moreFromSeries": {
      "opted_state": "A String",
    },
    "moreFromAuthors": {
      "opted_state": "A String",
    },
  },
  "kind": "books#usersettings", # Resource type.
  "notesExport": { # User settings in sub-objects, each for different purposes.
    "isEnabled": True or False,
    "folderName": "A String",
  },
}


Returns:
  An object of the form:

    {
    "notification": {
      "moreFromSeries": {
        "opted_state": "A String",
      },
      "moreFromAuthors": {
        "opted_state": "A String",
      },
    },
    "kind": "books#usersettings", # Resource type.
    "notesExport": { # User settings in sub-objects, each for different purposes.
      "isEnabled": True or False,
      "folderName": "A String",
    },
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.mylibrary.annotations.html000066400000000000000000000765661300622755700270730ustar00rootroot00000000000000

Books API . mylibrary . annotations

Instance Methods

delete(annotationId, source=None)

Deletes an annotation.

insert(body, source=None, country=None, showOnlySummaryInResponse=None)

Inserts a new annotation.

list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=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.
insert(body, source=None, country=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.
  country: string, ISO-3166-1 code to override the IP-based location.
  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(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None) 
Retrieves a list of annotations, possibly filtered.

Args:
  layerId: string, The layer ID to limit annotation by.
  pageToken: string, The value of the nextToken from the previous page.
  layerIds: string, The layer ID(s) to limit annotation by. (repeated)
  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.
  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  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.
    }
google-api-python-client-1.5.5/docs/dyn/books_v1.mylibrary.bookshelves.html000066400000000000000000000154261300622755700270460ustar00rootroot00000000000000

Books API . mylibrary . bookshelves

Instance Methods

volumes()

Returns the volumes Resource.

addVolume(shelf, volumeId, source=None, reason=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, reason=None)

Removes a volume from a bookshelf.

Method Details

addVolume(shelf, volumeId, source=None, reason=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.
  reason: string, The reason for which the book is added to the library.
    Allowed values
      IOS_PREX - Volumes added from the PREX flow on iOS.
      IOS_SEARCH - Volumes added from the Search flow on iOS.
      ONBOARDING - Volumes added from the Onboarding flow.
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, reason=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.
  reason: string, The reason for which the book is removed from the library.
    Allowed values
      ONBOARDING - Samples removed from the Onboarding flow.
google-api-python-client-1.5.5/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html000066400000000000000000000506621300622755700305400ustar00rootroot00000000000000

Books API . mylibrary . bookshelves . volumes

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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.mylibrary.html000066400000000000000000000030711300622755700245140ustar00rootroot00000000000000

Books API . mylibrary

Instance Methods

annotations()

Returns the annotations Resource.

bookshelves()

Returns the bookshelves Resource.

readingpositions()

Returns the readingpositions Resource.

google-api-python-client-1.5.5/docs/dyn/books_v1.mylibrary.readingpositions.html000066400000000000000000000073561300622755700301060ustar00rootroot00000000000000

Books API . mylibrary . readingpositions

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.
google-api-python-client-1.5.5/docs/dyn/books_v1.notification.html000066400000000000000000000043751300622755700252000ustar00rootroot00000000000000

Books API . notification

Instance Methods

get(notification_id, source=None, locale=None)

Returns notification details for a given notification id.

Method Details

get(notification_id, source=None, locale=None) 
Returns notification details for a given notification id.

Args:
  notification_id: string, String to identify the notification. (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 notification title and body.

Returns:
  An object of the form:

    {
    "body": "A String",
    "doc_type": "A String",
    "kind": "books#notification", # Resource type.
    "iconUrl": "A String",
    "dont_show_notification": True or False,
    "title": "A String",
    "show_notification_settings_action": True or False,
    "crmExperimentIds": [ # The list of crm experiment ids.
      "A String",
    ],
    "reason": "A String",
    "targetUrl": "A String",
    "notification_type": "A String",
    "pcampaign_id": "A String",
    "doc_id": "A String",
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.onboarding.html000066400000000000000000000530131300622755700246250ustar00rootroot00000000000000

Books API . onboarding

Instance Methods

listCategories(locale=None)

List categories for onboarding experience.

listCategoryVolumes(pageSize=None, pageToken=None, locale=None, maxAllowedMaturityRating=None, categoryId=None)

List available volumes under categories for onboarding experience.

listCategoryVolumes_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

listCategories(locale=None) 
List categories for onboarding experience.

Args:
  locale: string, ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

Returns:
  An object of the form:

    {
    "items": [ # A list of onboarding categories.
      {
        "badgeUrl": "A String",
        "categoryId": "A String",
        "name": "A String",
      },
    ],
    "kind": "onboarding#category", # Resource type.
  }
listCategoryVolumes(pageSize=None, pageToken=None, locale=None, maxAllowedMaturityRating=None, categoryId=None) 
List available volumes under categories for onboarding experience.

Args:
  pageSize: integer, Number of maximum results per page to be included in the response.
  pageToken: string, The value of the nextToken from the previous page.
  locale: string, ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
  maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
    Allowed values
      mature - Show books which are rated mature or lower.
      not-mature - Show books which are rated not mature.
  categoryId: string, List of category ids requested. (repeated)

Returns:
  An object of the form:

    {
    "nextPageToken": "A String",
    "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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "onboarding#volume", # Resource type.
  }
listCategoryVolumes_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.
google-api-python-client-1.5.5/docs/dyn/books_v1.personalizedstream.html000066400000000000000000000522031300622755700264160ustar00rootroot00000000000000

Books API . personalizedstream

Instance Methods

get(source=None, locale=None, maxAllowedMaturityRating=None)

Returns a stream of personalized book clusters

Method Details

get(source=None, locale=None, maxAllowedMaturityRating=None) 
Returns a stream of personalized book clusters

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.
  maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
    Allowed values
      mature - Show books which are rated mature or lower.
      not-mature - Show books which are rated not mature.

Returns:
  An object of the form:

    {
    "clusters": [
      {
        "totalVolumes": 42,
        "subTitle": "A String",
        "uid": "A String",
        "title": "A String",
        "banner_with_content_container": {
          "moreButtonText": "A String",
          "textColorArgb": "A String",
          "imageUrl": "A String",
          "fillColorArgb": "A String",
          "maskColorArgb": "A String",
          "moreButtonUrl": "A String",
        },
        "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.)
              "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
              "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.
              "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
              "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.)
              },
              "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
              "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,
                  },
                  "giftable": True or False, # Indicates whether the offer is giftable.
                  "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.
              "subtitle": "A String", # Volume subtitle. (In LITE projection.)
              "pageCount": 42, # Total number of pages as per publisher metadata.
              "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.
              "seriesInfo": {
                "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
                "kind": "books#volume_series_info", # Resource type.
                "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
                "volumeSeries": [
                  {
                    "orderNumber": 42, # The book order number in the series.
                    "seriesId": "A String", # The series id.
                    "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                      {
                        "issueOrderNumber": 42,
                        "issueDisplayNumber": "A String",
                      },
                    ],
                    "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
                  },
                ],
              },
              "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).
              },
              "previewLink": "A String", # URL to preview this volume on the Google Books site.
              "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
              "industryIdentifiers": [ # Industry standard identifiers for this volume.
                {
                  "identifier": "A String", # Industry specific volume identifier.
                  "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
                },
              ],
              "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
              "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
              "publishedDate": "A String", # Date of publication. (In LITE projection.)
              "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)
              },
              "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
                "A String",
              ],
              "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
                "A String",
              ],
              "panelizationSummary": { # A top-level summary of the panelization info in this volume.
                "containsEpubBubbles": True or False,
                "epubBubbleVersion": "A String",
                "imageBubbleVersion": "A String",
                "containsImageBubbles": True or False,
              },
              "publisher": "A String", # Publisher of this volume. (In LITE projection.)
              "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
              "maturityRating": "A String",
              "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
              "title": "A String", # Volume title. (In LITE projection.)
              "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
              "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
              "readingModes": "", # The reading modes available for this volume.
              "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
              "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
              "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
              "ratingsCount": 42, # The number of review ratings for this volume.
            },
            "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)
              "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
              "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
              "acquisitionType": 42, # How this volume was acquired.
              "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",
              },
              "rentalPeriod": { # Period during this book is/was a valid rental.
                "startUtcSec": "A String",
                "endUtcSec": "A String",
              },
              "familySharing": { # Information on the ability to share with the family.
                "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
                "familyRole": "A String", # The role of the user in the family.
                "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
              },
              "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.
              },
              "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
              "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
              "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.
              },
              "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
              "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
              "copy": { # Copy/Paste accounting information.
                "limitType": "A String",
                "remainingCharacterCount": 42,
                "updated": "A String",
                "allowedCharacterCount": 42,
              },
              "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
              "isUploaded": True or False, # Whether or not this volume was user uploaded.
              "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
            },
          },
        ],
      },
    ],
    "kind": "books#discovery#clusters", # Resorce type.
    "totalClusters": 42,
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.promooffer.html000066400000000000000000000071441300622755700246650ustar00rootroot00000000000000

Books API . promooffer

Instance Methods

accept(product=None, device=None, offerId=None, volumeId=None, androidId=None, model=None, serial=None, manufacturer=None)

dismiss(product=None, device=None, offerId=None, androidId=None, model=None, serial=None, manufacturer=None)

get(product=None, device=None, androidId=None, model=None, serial=None, manufacturer=None)

Returns a list of promo offers available to the user

Method Details

accept(product=None, device=None, offerId=None, volumeId=None, androidId=None, model=None, serial=None, manufacturer=None) 

Args:
  product: string, device product
  device: string, device device
  offerId: string, A parameter
  volumeId: string, Volume id to exercise the offer
  androidId: string, device android_id
  model: string, device model
  serial: string, device serial
  manufacturer: string, device manufacturer
dismiss(product=None, device=None, offerId=None, androidId=None, model=None, serial=None, manufacturer=None) 

Args:
  product: string, device product
  device: string, device device
  offerId: string, Offer to dimiss
  androidId: string, device android_id
  model: string, device model
  serial: string, device serial
  manufacturer: string, device manufacturer
get(product=None, device=None, androidId=None, model=None, serial=None, manufacturer=None) 
Returns a list of promo offers available to the user

Args:
  product: string, device product
  device: string, device device
  androidId: string, device android_id
  model: string, device model
  serial: string, device serial
  manufacturer: string, device manufacturer

Returns:
  An object of the form:

    {
    "items": [ # A list of offers.
      {
        "gservicesKey": "A String",
        "items": [
          {
            "description": "A String",
            "title": "A String",
            "author": "A String",
            "coverUrl": "A String",
            "volumeId": "A String",
            "canonicalVolumeLink": "A String",
          },
        ],
        "artUrl": "A String",
        "id": "A String",
      },
    ],
    "kind": "promooffer#offers", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.series.html000066400000000000000000000040031300622755700237700ustar00rootroot00000000000000

Books API . series

Instance Methods

membership()

Returns the membership Resource.

get(series_id)

Returns Series metadata for the given series ids.

Method Details

get(series_id) 
Returns Series metadata for the given series ids.

Args:
  series_id: string, String that identifies the series (required) (repeated)

Returns:
  An object of the form:

    {
    "series": [ # Series info list. The client always expects this element in the JSON output, hence declared here as OutputAlways.
      {
        "seriesId": "A String",
        "bannerImageUrl": "A String",
        "title": "A String",
        "imageUrl": "A String",
        "seriesType": "A String",
      },
    ],
    "kind": "books#series", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.series.membership.html000066400000000000000000000471561300622755700261420ustar00rootroot00000000000000

Books API . series . membership

Instance Methods

get(series_id, page_token=None, page_size=None)

Returns Series membership data given the series id.

Method Details

get(series_id, page_token=None, page_size=None) 
Returns Series membership data given the series id.

Args:
  series_id: string, String that identifies the series (required)
  page_token: string, The value of the nextToken from the previous page.
  page_size: integer, Number of maximum results per page to be included in the response.

Returns:
  An object of the form:

    {
    "member": [
      {
        "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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "nextPageToken": "A String",
    "kind": "books#series#membership", # Resorce type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.volumes.associated.html000066400000000000000000000505301300622755700263140ustar00rootroot00000000000000

Books API . volumes . associated

Instance Methods

list(volumeId, source=None, locale=None, maxAllowedMaturityRating=None, association=None)

Return a list of associated books.

Method Details

list(volumeId, source=None, locale=None, maxAllowedMaturityRating=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.
  maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
    Allowed values
      mature - Show books which are rated mature or lower.
      not-mature - Show books which are rated not mature.
  association: string, Association type.
    Allowed values
      end-of-sample - Recommendations for display end-of-sample.
      end-of-volume - Recommendations for display end-of-volume.
      related-for-play - Related volumes for Play Store.

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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.volumes.html000066400000000000000000001205361300622755700242020ustar00rootroot00000000000000

Books API . volumes

Instance Methods

associated()

Returns the associated Resource.

mybooks()

Returns the mybooks Resource.

recommended()

Returns the recommended Resource.

useruploaded()

Returns the useruploaded Resource.

get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None)

Gets volume information for a single volume.

list(q, orderBy=None, projection=None, printType=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, maxAllowedMaturityRating=None, filter=None)

Performs a book search.

Method Details

get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None) 
Gets volume information for a single volume.

Args:
  volumeId: string, ID of volume to retrieve. (required)
  user_library_consistent_read: boolean, A parameter
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      full - Includes all volume data.
      lite - Includes a subset of fields in volumeInfo and accessInfo.
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.
  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.)
      "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
      "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.
      "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
      "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.)
      },
      "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
      "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,
          },
          "giftable": True or False, # Indicates whether the offer is giftable.
          "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.
      "subtitle": "A String", # Volume subtitle. (In LITE projection.)
      "pageCount": 42, # Total number of pages as per publisher metadata.
      "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.
      "seriesInfo": {
        "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
        "kind": "books#volume_series_info", # Resource type.
        "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
        "volumeSeries": [
          {
            "orderNumber": 42, # The book order number in the series.
            "seriesId": "A String", # The series id.
            "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
              {
                "issueOrderNumber": 42,
                "issueDisplayNumber": "A String",
              },
            ],
            "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
          },
        ],
      },
      "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).
      },
      "previewLink": "A String", # URL to preview this volume on the Google Books site.
      "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
      "industryIdentifiers": [ # Industry standard identifiers for this volume.
        {
          "identifier": "A String", # Industry specific volume identifier.
          "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
        },
      ],
      "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
      "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
      "publishedDate": "A String", # Date of publication. (In LITE projection.)
      "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)
      },
      "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
        "A String",
      ],
      "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
        "A String",
      ],
      "panelizationSummary": { # A top-level summary of the panelization info in this volume.
        "containsEpubBubbles": True or False,
        "epubBubbleVersion": "A String",
        "imageBubbleVersion": "A String",
        "containsImageBubbles": True or False,
      },
      "publisher": "A String", # Publisher of this volume. (In LITE projection.)
      "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
      "maturityRating": "A String",
      "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
      "title": "A String", # Volume title. (In LITE projection.)
      "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
      "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
      "readingModes": "", # The reading modes available for this volume.
      "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
      "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
      "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
      "ratingsCount": 42, # The number of review ratings for this volume.
    },
    "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)
      "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
      "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
      "acquisitionType": 42, # How this volume was acquired.
      "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",
      },
      "rentalPeriod": { # Period during this book is/was a valid rental.
        "startUtcSec": "A String",
        "endUtcSec": "A String",
      },
      "familySharing": { # Information on the ability to share with the family.
        "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
        "familyRole": "A String", # The role of the user in the family.
        "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
      },
      "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.
      },
      "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
      "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
      "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.
      },
      "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
      "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
      "copy": { # Copy/Paste accounting information.
        "limitType": "A String",
        "remainingCharacterCount": 42,
        "updated": "A String",
        "allowedCharacterCount": 42,
      },
      "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
      "isUploaded": True or False, # Whether or not this volume was user uploaded.
      "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
    },
  }
list(q, orderBy=None, projection=None, printType=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, maxAllowedMaturityRating=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.
  printType: string, Restrict to books or magazines.
    Allowed values
      all - All volume content types.
      books - Just books.
      magazines - Just magazines.
  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.
  maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
    Allowed values
      mature - Show books which are rated mature or lower.
      not-mature - Show books which are rated not mature.
  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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.volumes.mybooks.html000066400000000000000000000514651300622755700256700ustar00rootroot00000000000000

Books API . volumes . mybooks

Instance Methods

list(source=None, locale=None, country=None, acquireMethod=None, maxResults=None, startIndex=None, processingState=None)

Return a list of books in My Library.

Method Details

list(source=None, locale=None, country=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.
  country: string, ISO-3166-1 code to override the IP-based location.
  acquireMethod: string, How the book was acquired (repeated)
    Allowed values
      FAMILY_SHARED - Books acquired via Family Sharing
      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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.volumes.recommended.html000066400000000000000000000516621300622755700264660ustar00rootroot00000000000000

Books API . volumes . recommended

Instance Methods

list(source=None, locale=None, maxAllowedMaturityRating=None)

Return a list of recommended books for the current user.

rate(rating, volumeId, source=None, locale=None)

Rate a recommended book for the current user.

Method Details

list(source=None, locale=None, maxAllowedMaturityRating=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.
  maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
    Allowed values
      mature - Show books which are rated mature or lower.
      not-mature - Show books which are rated not mature.

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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
rate(rating, volumeId, source=None, locale=None) 
Rate a recommended book for the current user.

Args:
  rating: string, Rating to be given to the volume. (required)
    Allowed values
      HAVE_IT - Rating indicating a dismissal due to ownership.
      NOT_INTERESTED - Rating indicating a negative dismissal of a volume.
  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.

Returns:
  An object of the form:

    {
    "consistency_token": "A String",
  }
google-api-python-client-1.5.5/docs/dyn/books_v1.volumes.useruploaded.html000066400000000000000000000506011300622755700266700ustar00rootroot00000000000000

Books API . volumes . useruploaded

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.)
          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
          "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.
          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
          "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.)
          },
          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
          "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,
              },
              "giftable": True or False, # Indicates whether the offer is giftable.
              "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.
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
          "pageCount": 42, # Total number of pages as per publisher metadata.
          "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.
          "seriesInfo": {
            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
            "kind": "books#volume_series_info", # Resource type.
            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
            "volumeSeries": [
              {
                "orderNumber": 42, # The book order number in the series.
                "seriesId": "A String", # The series id.
                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
                  {
                    "issueOrderNumber": 42,
                    "issueDisplayNumber": "A String",
                  },
                ],
                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
              },
            ],
          },
          "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).
          },
          "previewLink": "A String", # URL to preview this volume on the Google Books site.
          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
          "industryIdentifiers": [ # Industry standard identifiers for this volume.
            {
              "identifier": "A String", # Industry specific volume identifier.
              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
            },
          ],
          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
          "publishedDate": "A String", # Date of publication. (In LITE projection.)
          "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)
          },
          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
            "A String",
          ],
          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
            "A String",
          ],
          "panelizationSummary": { # A top-level summary of the panelization info in this volume.
            "containsEpubBubbles": True or False,
            "epubBubbleVersion": "A String",
            "imageBubbleVersion": "A String",
            "containsImageBubbles": True or False,
          },
          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
          "maturityRating": "A String",
          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
          "title": "A String", # Volume title. (In LITE projection.)
          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
          "readingModes": "", # The reading modes available for this volume.
          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "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)
          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "acquisitionType": 42, # How this volume was acquired.
          "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",
          },
          "rentalPeriod": { # Period during this book is/was a valid rental.
            "startUtcSec": "A String",
            "endUtcSec": "A String",
          },
          "familySharing": { # Information on the ability to share with the family.
            "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
            "familyRole": "A String", # The role of the user in the family.
            "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
          },
          "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.
          },
          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
          "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
          "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.
          },
          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
          "copy": { # Copy/Paste accounting information.
            "limitType": "A String",
            "remainingCharacterCount": 42,
            "updated": "A String",
            "allowedCharacterCount": 42,
          },
          "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
          "isUploaded": True or False, # Whether or not this volume was user uploaded.
          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
        },
      },
    ],
    "kind": "books#volumes", # Resource type.
  }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.acl.html000066400000000000000000000564111300622755700237050ustar00rootroot00000000000000

Calendar API . acl

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, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)

Returns the rules in the access control list for the calendar.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(calendarId, ruleId, body)

Updates an access control rule. This method supports patch semantics.

update(calendarId, ruleId, body)

Updates an access control rule.

watch(calendarId, body, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)

Watch for changes to ACL resources.

Method Details

delete(calendarId, ruleId) 
Deletes an access control rule.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  ruleId: string, ACL rule identifier. (required)
get(calendarId, ruleId) 
Returns an access control rule.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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, syncToken=None, pageToken=None, maxResults=None, showDeleted=None) 
Returns the rules in the access control list for the calendar.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  pageToken: string, Token specifying which result page to return. Optional.
  maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

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, in which case nextSyncToken is provided.
    "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.
    "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
  }
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, ruleId, body) 
Updates an access control rule. This method supports patch semantics.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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.
    }
watch(calendarId, body, syncToken=None, pageToken=None, maxResults=None, showDeleted=None) 
Watch for changes to ACL resources.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  pageToken: string, Token specifying which result page to return. Optional.
  maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

Returns:
  An object of the form:

    {
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.calendarList.html000066400000000000000000001426311300622755700255530ustar00rootroot00000000000000

Calendar API . calendarList

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(syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=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.

watch(body, syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None)

Watch for changes to CalendarList resources.

Method Details

delete(calendarId) 
Deletes an entry on the user's calendar list.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
get(calendarId) 
Returns an entry on the user's calendar list.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "popup" - Reminders are sent via a UI popup.
        },
      ],
      "description": "A String", # Description of the calendar. Optional. Read-only.
      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
      "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
        "notifications": [ # The list of notifications set for this calendar.
          {
            "type": "A String", # The type of notification. Possible values are:
                # - "eventCreation" - Notification sent when a new event is put on the calendar.
                # - "eventChange" - Notification sent when an event is changed.
                # - "eventCancellation" - Notification sent when an event is cancelled.
                # - "eventResponse" - Notification sent when an event is changed.
                # - "agenda" - An agenda with the events of the day (sent out in the morning).
            "method": "A String", # The method used to deliver the notification. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
          },
        ],
      },
      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
      "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
      "summary": "A String", # Title of the calendar. Read-only.
      "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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
        "method": "A String", # The method used by this reminder. Possible values are:
            # - "email" - Reminders are sent via email.
            # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
            # - "popup" - Reminders are sent via a UI popup.
      },
    ],
    "description": "A String", # Description of the calendar. Optional. Read-only.
    "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
    "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
    "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
    "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
      "notifications": [ # The list of notifications set for this calendar.
        {
          "type": "A String", # The type of notification. Possible values are:
              # - "eventCreation" - Notification sent when a new event is put on the calendar.
              # - "eventChange" - Notification sent when an event is changed.
              # - "eventCancellation" - Notification sent when an event is cancelled.
              # - "eventResponse" - Notification sent when an event is changed.
              # - "agenda" - An agenda with the events of the day (sent out in the morning).
          "method": "A String", # The method used to deliver the notification. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
        },
      ],
    },
    "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
    "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
    "summary": "A String", # Title of the calendar. Read-only.
    "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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "popup" - Reminders are sent via a UI popup.
        },
      ],
      "description": "A String", # Description of the calendar. Optional. Read-only.
      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
      "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
        "notifications": [ # The list of notifications set for this calendar.
          {
            "type": "A String", # The type of notification. Possible values are:
                # - "eventCreation" - Notification sent when a new event is put on the calendar.
                # - "eventChange" - Notification sent when an event is changed.
                # - "eventCancellation" - Notification sent when an event is cancelled.
                # - "eventResponse" - Notification sent when an event is changed.
                # - "agenda" - An agenda with the events of the day (sent out in the morning).
            "method": "A String", # The method used to deliver the notification. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
          },
        ],
      },
      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
      "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
      "summary": "A String", # Title of the calendar. Read-only.
      "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(syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None) 
Returns entries on the user's calendar list.

Args:
  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.
To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  minAccessRole: string, The minimum access role for the user in the returned entries. 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. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
  showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
  pageToken: string, Token specifying which result page to return. 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, in which case nextSyncToken is provided.
    "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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
              "method": "A String", # The method used by this reminder. Possible values are:
                  # - "email" - Reminders are sent via email.
                  # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                  # - "popup" - Reminders are sent via a UI popup.
            },
          ],
          "description": "A String", # Description of the calendar. Optional. Read-only.
          "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
          "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
          "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
          "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
            "notifications": [ # The list of notifications set for this calendar.
              {
                "type": "A String", # The type of notification. Possible values are:
                    # - "eventCreation" - Notification sent when a new event is put on the calendar.
                    # - "eventChange" - Notification sent when an event is changed.
                    # - "eventCancellation" - Notification sent when an event is cancelled.
                    # - "eventResponse" - Notification sent when an event is changed.
                    # - "agenda" - An agenda with the events of the day (sent out in the morning).
                "method": "A String", # The method used to deliver the notification. Possible values are:
                    # - "email" - Reminders are sent via email.
                    # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
              },
            ],
          },
          "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
          "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
          "summary": "A String", # Title of the calendar. Read-only.
          "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.
    "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
  }
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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
        "method": "A String", # The method used by this reminder. Possible values are:
            # - "email" - Reminders are sent via email.
            # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
            # - "popup" - Reminders are sent via a UI popup.
      },
    ],
    "description": "A String", # Description of the calendar. Optional. Read-only.
    "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
    "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
    "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
    "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
      "notifications": [ # The list of notifications set for this calendar.
        {
          "type": "A String", # The type of notification. Possible values are:
              # - "eventCreation" - Notification sent when a new event is put on the calendar.
              # - "eventChange" - Notification sent when an event is changed.
              # - "eventCancellation" - Notification sent when an event is cancelled.
              # - "eventResponse" - Notification sent when an event is changed.
              # - "agenda" - An agenda with the events of the day (sent out in the morning).
          "method": "A String", # The method used to deliver the notification. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
        },
      ],
    },
    "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
    "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
    "summary": "A String", # Title of the calendar. Read-only.
    "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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "popup" - Reminders are sent via a UI popup.
        },
      ],
      "description": "A String", # Description of the calendar. Optional. Read-only.
      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
      "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
        "notifications": [ # The list of notifications set for this calendar.
          {
            "type": "A String", # The type of notification. Possible values are:
                # - "eventCreation" - Notification sent when a new event is put on the calendar.
                # - "eventChange" - Notification sent when an event is changed.
                # - "eventCancellation" - Notification sent when an event is cancelled.
                # - "eventResponse" - Notification sent when an event is changed.
                # - "agenda" - An agenda with the events of the day (sent out in the morning).
            "method": "A String", # The method used to deliver the notification. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
          },
        ],
      },
      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
      "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
      "summary": "A String", # Title of the calendar. Read-only.
      "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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
        "method": "A String", # The method used by this reminder. Possible values are:
            # - "email" - Reminders are sent via email.
            # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
            # - "popup" - Reminders are sent via a UI popup.
      },
    ],
    "description": "A String", # Description of the calendar. Optional. Read-only.
    "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
    "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
    "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
    "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
      "notifications": [ # The list of notifications set for this calendar.
        {
          "type": "A String", # The type of notification. Possible values are:
              # - "eventCreation" - Notification sent when a new event is put on the calendar.
              # - "eventChange" - Notification sent when an event is changed.
              # - "eventCancellation" - Notification sent when an event is cancelled.
              # - "eventResponse" - Notification sent when an event is changed.
              # - "agenda" - An agenda with the events of the day (sent out in the morning).
          "method": "A String", # The method used to deliver the notification. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
        },
      ],
    },
    "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
    "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
    "summary": "A String", # Title of the calendar. Read-only.
    "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 hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "popup" - Reminders are sent via a UI popup.
        },
      ],
      "description": "A String", # Description of the calendar. Optional. Read-only.
      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
      "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). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
        "notifications": [ # The list of notifications set for this calendar.
          {
            "type": "A String", # The type of notification. Possible values are:
                # - "eventCreation" - Notification sent when a new event is put on the calendar.
                # - "eventChange" - Notification sent when an event is changed.
                # - "eventCancellation" - Notification sent when an event is cancelled.
                # - "eventResponse" - Notification sent when an event is changed.
                # - "agenda" - An agenda with the events of the day (sent out in the morning).
            "method": "A String", # The method used to deliver the notification. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.
          },
        ],
      },
      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
      "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 hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. 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": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
      "summary": "A String", # Title of the calendar. Read-only.
      "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.
    }
watch(body, syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None) 
Watch for changes to CalendarList resources.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.
To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  minAccessRole: string, The minimum access role for the user in the returned entries. 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. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
  showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
  showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
  pageToken: string, Token specifying which result page to return. Optional.

Returns:
  An object of the form:

    {
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.calendars.html000066400000000000000000000213331300622755700250750ustar00rootroot00000000000000

Calendar API . calendars

Instance Methods

clear(calendarId)

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

delete(calendarId)

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

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 events associated with the primary calendar of an account.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
delete(calendarId) 
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
get(calendarId) 
Returns metadata for a calendar.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
      "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
    }
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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
    "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  }


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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
      "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
    }
patch(calendarId, body) 
Updates metadata for a calendar. This method supports patch semantics.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
    "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  }


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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
      "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
    }
update(calendarId, body) 
Updates metadata for a calendar.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
    "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  }


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. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
      "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
    }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.channels.html000066400000000000000000000051501300622755700247330ustar00rootroot00000000000000

Calendar API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.colors.html000066400000000000000000000050351300622755700244430ustar00rootroot00000000000000

Calendar API . colors

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": { # A global palette of calendar colors, mapping from the color ID to its definition. A 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 RFC3339 timestamp). Read-only.
    "event": { # A global 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").
  }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.events.html000066400000000000000000006736031300622755700244620ustar00rootroot00000000000000

Calendar API . events

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, supportsAttachments=None)

Imports an event. This operation is used to add a private copy of an existing event to a calendar.

insert(calendarId, body, sendNotifications=None, supportsAttachments=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, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=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, supportsAttachments=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, supportsAttachments=None, maxAttendees=None)

Updates an event.

watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)

Watch for changes to Events resources.

Method Details

delete(calendarId, eventId, sendNotifications=None) 
Deletes an event.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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, supportsAttachments=None) 
Imports an event. This operation is used to add a private copy of an existing event to a calendar.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
        # In order to modify attachments the supportsAttachments request parameter should be set to true.
        # There can be at most 25 attachments per event,
      {
        "mimeType": "A String", # Internet media type (MIME type) of the attachment.
        "title": "A String", # Attachment title.
        "fileUrl": "A String", # URL link to the attachment.
            # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
        "iconLink": "A String", # URL link to the attachment's icon. Read-only.
        "fileId": "A String", # ID of the attached file. Read-only.
            # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
      },
    ],
    "creator": { # The creator of the event. Read-only.
      "self": 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. It corresponds to theid field in the People collection of the Google+ API
    },
    "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": 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. It must be a valid email address as per RFC5322.
      "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
    },
    "summary": "A String", # Title of the event.
    "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
        # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
        # - the length of the ID must be between 5 and 1024 characters
        # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
        # If you do not specify an ID, it will be automatically generated by the server.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
    "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
      {
        "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": 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. It corresponds to theid field in the People collection of the Google+ API
        "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
        "resource": 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": 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. It must be a valid email address as per RFC5322.
      },
    ],
    "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
      "A String",
    ],
    "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
      "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
      "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
      "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
      "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. The URL scheme must be HTTPS.
    },
    "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 RFC3339 timestamp). Read-only.
    "description": "A String", # Description of the event. Optional.
    "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
        {
          "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
    "transparency": "opaque", # 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": 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.
  }

  supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

Returns:
  An object of the form:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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, supportsAttachments=None, maxAttendees=None) 
Creates an event.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
        # In order to modify attachments the supportsAttachments request parameter should be set to true.
        # There can be at most 25 attachments per event,
      {
        "mimeType": "A String", # Internet media type (MIME type) of the attachment.
        "title": "A String", # Attachment title.
        "fileUrl": "A String", # URL link to the attachment.
            # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
        "iconLink": "A String", # URL link to the attachment's icon. Read-only.
        "fileId": "A String", # ID of the attached file. Read-only.
            # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
      },
    ],
    "creator": { # The creator of the event. Read-only.
      "self": 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. It corresponds to theid field in the People collection of the Google+ API
    },
    "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": 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. It must be a valid email address as per RFC5322.
      "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
    },
    "summary": "A String", # Title of the event.
    "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
        # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
        # - the length of the ID must be between 5 and 1024 characters
        # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
        # If you do not specify an ID, it will be automatically generated by the server.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
    "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
      {
        "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": 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. It corresponds to theid field in the People collection of the Google+ API
        "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
        "resource": 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": 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. It must be a valid email address as per RFC5322.
      },
    ],
    "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
      "A String",
    ],
    "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
      "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
      "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
      "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
      "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. The URL scheme must be HTTPS.
    },
    "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 RFC3339 timestamp). Read-only.
    "description": "A String", # Description of the event. Optional.
    "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
        {
          "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
    "transparency": "opaque", # 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": 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.
  supportsAttachments: boolean, Whether API client performing operation supports event attachments. 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:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. Must be an RFC3339 timestamp with mandatory time zone offset.
  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. By default the value is 250 events. The page size can never be larger than 2500 events. 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. Must be an RFC3339 timestamp with mandatory time zone offset.
  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, in which case nextSyncToken is provided.
    "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. Valid values are between 0 and 40320 (4 weeks in minutes).
        "method": "A String", # The method used by this reminder. Possible values are:
            # - "email" - Reminders are sent via email.
            # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
            # - "popup" - Reminders are sent via a UI popup.
      },
    ],
    "description": "A String", # Description of the calendar. Read-only.
    "items": [ # List of events on the calendar.
      {
          "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
              # In order to modify attachments the supportsAttachments request parameter should be set to true.
              # There can be at most 25 attachments per event,
            {
              "mimeType": "A String", # Internet media type (MIME type) of the attachment.
              "title": "A String", # Attachment title.
              "fileUrl": "A String", # URL link to the attachment.
                  # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
              "iconLink": "A String", # URL link to the attachment's icon. Read-only.
              "fileId": "A String", # ID of the attached file. Read-only.
                  # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
            },
          ],
          "creator": { # The creator of the event. Read-only.
            "self": 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. It corresponds to theid field in the People collection of the Google+ API
          },
          "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": 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. It must be a valid email address as per RFC5322.
            "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
          },
          "summary": "A String", # Title of the event.
          "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
              # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
              # - the length of the ID must be between 5 and 1024 characters
              # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
              # If you do not specify an ID, it will be automatically generated by the server.
              # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
          "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
          "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
            {
              "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": 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. It corresponds to theid field in the People collection of the Google+ API
              "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
              "resource": 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": 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. It must be a valid email address as per RFC5322.
            },
          ],
          "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
            "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
            "A String",
          ],
          "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
            "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
            "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
            "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
            "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. The URL scheme must be HTTPS.
          },
          "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 RFC3339 timestamp). Read-only.
          "description": "A String", # Description of the event. Optional.
          "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
              # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
          "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
            "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
          },
          "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
              {
                "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
                "method": "A String", # The method used by this reminder. Possible values are:
                    # - "email" - Reminders are sent via email.
                    # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                    # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
            "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
          },
          "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
          "transparency": "opaque", # 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": 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 RFC3339 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.
    "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
    "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, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None) 
Returns events on the specified calendar.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
  privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
  pageToken: string, Token specifying which result page to return. Optional.
  updatedMin: string, Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. 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.
  sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
  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.
  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are: 
- iCalUID 
- orderBy 
- privateExtendedProperty 
- q 
- sharedExtendedProperty 
- timeMin 
- timeMax 
- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.
  maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. 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. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
  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, in which case nextSyncToken is provided.
    "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. Valid values are between 0 and 40320 (4 weeks in minutes).
        "method": "A String", # The method used by this reminder. Possible values are:
            # - "email" - Reminders are sent via email.
            # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
            # - "popup" - Reminders are sent via a UI popup.
      },
    ],
    "description": "A String", # Description of the calendar. Read-only.
    "items": [ # List of events on the calendar.
      {
          "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
              # In order to modify attachments the supportsAttachments request parameter should be set to true.
              # There can be at most 25 attachments per event,
            {
              "mimeType": "A String", # Internet media type (MIME type) of the attachment.
              "title": "A String", # Attachment title.
              "fileUrl": "A String", # URL link to the attachment.
                  # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
              "iconLink": "A String", # URL link to the attachment's icon. Read-only.
              "fileId": "A String", # ID of the attached file. Read-only.
                  # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
            },
          ],
          "creator": { # The creator of the event. Read-only.
            "self": 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. It corresponds to theid field in the People collection of the Google+ API
          },
          "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": 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. It must be a valid email address as per RFC5322.
            "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
          },
          "summary": "A String", # Title of the event.
          "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
              # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
              # - the length of the ID must be between 5 and 1024 characters
              # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
              # If you do not specify an ID, it will be automatically generated by the server.
              # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
          "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
          "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
            {
              "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": 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. It corresponds to theid field in the People collection of the Google+ API
              "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
              "resource": 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": 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. It must be a valid email address as per RFC5322.
            },
          ],
          "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
            "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
            "A String",
          ],
          "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
            "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
            "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
            "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
            "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. The URL scheme must be HTTPS.
          },
          "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 RFC3339 timestamp). Read-only.
          "description": "A String", # Description of the event. Optional.
          "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
              # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
          "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
            "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
          },
          "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
              {
                "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
                "method": "A String", # The method used by this reminder. Possible values are:
                    # - "email" - Reminders are sent via email.
                    # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                    # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
            "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
          },
          "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
          "transparency": "opaque", # 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": 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 RFC3339 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.
    "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
    "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:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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, supportsAttachments=None, maxAttendees=None) 
Updates an event. This method supports patch semantics.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  eventId: string, Event identifier. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
        # In order to modify attachments the supportsAttachments request parameter should be set to true.
        # There can be at most 25 attachments per event,
      {
        "mimeType": "A String", # Internet media type (MIME type) of the attachment.
        "title": "A String", # Attachment title.
        "fileUrl": "A String", # URL link to the attachment.
            # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
        "iconLink": "A String", # URL link to the attachment's icon. Read-only.
        "fileId": "A String", # ID of the attached file. Read-only.
            # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
      },
    ],
    "creator": { # The creator of the event. Read-only.
      "self": 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. It corresponds to theid field in the People collection of the Google+ API
    },
    "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": 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. It must be a valid email address as per RFC5322.
      "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
    },
    "summary": "A String", # Title of the event.
    "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
        # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
        # - the length of the ID must be between 5 and 1024 characters
        # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
        # If you do not specify an ID, it will be automatically generated by the server.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
    "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
      {
        "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": 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. It corresponds to theid field in the People collection of the Google+ API
        "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
        "resource": 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": 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. It must be a valid email address as per RFC5322.
      },
    ],
    "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
      "A String",
    ],
    "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
      "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
      "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
      "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
      "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. The URL scheme must be HTTPS.
    },
    "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 RFC3339 timestamp). Read-only.
    "description": "A String", # Description of the event. Optional.
    "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
        {
          "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
    "transparency": "opaque", # 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": 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.
  supportsAttachments: boolean, Whether API client performing operation supports event attachments. 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:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (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:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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, supportsAttachments=None, maxAttendees=None) 
Updates an event.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  eventId: string, Event identifier. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
        # In order to modify attachments the supportsAttachments request parameter should be set to true.
        # There can be at most 25 attachments per event,
      {
        "mimeType": "A String", # Internet media type (MIME type) of the attachment.
        "title": "A String", # Attachment title.
        "fileUrl": "A String", # URL link to the attachment.
            # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
        "iconLink": "A String", # URL link to the attachment's icon. Read-only.
        "fileId": "A String", # ID of the attached file. Read-only.
            # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
      },
    ],
    "creator": { # The creator of the event. Read-only.
      "self": 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. It corresponds to theid field in the People collection of the Google+ API
    },
    "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": 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. It must be a valid email address as per RFC5322.
      "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
    },
    "summary": "A String", # Title of the event.
    "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
        # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
        # - the length of the ID must be between 5 and 1024 characters
        # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
        # If you do not specify an ID, it will be automatically generated by the server.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
    "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
      {
        "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": 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. It corresponds to theid field in the People collection of the Google+ API
        "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
        "resource": 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": 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. It must be a valid email address as per RFC5322.
      },
    ],
    "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
      "A String",
    ],
    "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
      "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
      "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
      "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
      "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. The URL scheme must be HTTPS.
    },
    "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 RFC3339 timestamp). Read-only.
    "description": "A String", # Description of the event. Optional.
    "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
        # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
        {
          "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
          "method": "A String", # The method used by this reminder. Possible values are:
              # - "email" - Reminders are sent via email.
              # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
              # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
      "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
    },
    "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
    "transparency": "opaque", # 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": 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.
  supportsAttachments: boolean, Whether API client performing operation supports event attachments. 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:

    {
      "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
          # In order to modify attachments the supportsAttachments request parameter should be set to true.
          # There can be at most 25 attachments per event,
        {
          "mimeType": "A String", # Internet media type (MIME type) of the attachment.
          "title": "A String", # Attachment title.
          "fileUrl": "A String", # URL link to the attachment.
              # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
          "iconLink": "A String", # URL link to the attachment's icon. Read-only.
          "fileId": "A String", # ID of the attached file. Read-only.
              # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
        },
      ],
      "creator": { # The creator of the event. Read-only.
        "self": 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. It corresponds to theid field in the People collection of the Google+ API
      },
      "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": 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. It must be a valid email address as per RFC5322.
        "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API
      },
      "summary": "A String", # Title of the event.
      "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
          # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
          # - the length of the ID must be between 5 and 1024 characters
          # - the ID must be unique per calendar  Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
          # If you do not specify an ID, it will be automatically generated by the server.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
      "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
        {
          "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": 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. It corresponds to theid field in the People collection of the Google+ API
          "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
          "resource": 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": 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. It must be a valid email address as per RFC5322.
        },
      ],
      "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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
        "A String",
      ],
      "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
        "url": "A String", # URL of the source pointing to a resource. The URL scheme 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 id of the recurring event to which this instance belongs. 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. The height must be an integer greater than 0. Optional.
        "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
        "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
        "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. The URL scheme must be HTTPS.
      },
      "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 RFC3339 timestamp). Read-only.
      "description": "A String", # Description of the event. Optional.
      "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
          # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
      "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": 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": "default", # 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": 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "attendeesOmitted": 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": 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 RFC3339 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": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). 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. The maximum number of override reminders is 5.
          {
            "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
            "method": "A String", # The method used by this reminder. Possible values are:
                # - "email" - Reminders are sent via email.
                # - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored.
                # - "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, # 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 time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
        "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
      },
      "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
      "transparency": "opaque", # 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": 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, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None) 
Watch for changes to Events resources.

Args:
  calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this 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. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
  privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
  pageToken: string, Token specifying which result page to return. Optional.
  updatedMin: string, Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. 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.
  sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
  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.
  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are: 
- iCalUID 
- orderBy 
- privateExtendedProperty 
- q 
- sharedExtendedProperty 
- timeMin 
- timeMax 
- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.
  maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. 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. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
  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", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.freebusy.html000066400000000000000000000111361300622755700247650ustar00rootroot00000000000000

Calendar API . freebusy

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": "UTC", # 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",
        ],
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/calendar_v3.html000066400000000000000000000061511300622755700231430ustar00rootroot00000000000000

Calendar API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/calendar_v3.settings.html000066400000000000000000000201671300622755700250050ustar00rootroot00000000000000

Calendar API . settings

Instance Methods

get(setting)

Returns a single user setting.

list(syncToken=None, pageToken=None, maxResults=None)

Returns all user settings for the authenticated user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

watch(body, syncToken=None, pageToken=None, maxResults=None)

Watch for changes to Settings resources.

Method Details

get(setting) 
Returns a single user setting.

Args:
  setting: string, The id 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", # The id of the user setting.
    "value": "A String", # Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
  }
list(syncToken=None, pageToken=None, maxResults=None) 
Returns all user settings for the authenticated user.

Args:
  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  pageToken: string, Token specifying which result page to return. Optional.
  maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. 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, in which case nextSyncToken is provided.
    "items": [ # List of user settings.
      {
        "kind": "calendar#setting", # Type of the resource ("calendar#setting").
        "etag": "A String", # ETag of the resource.
        "id": "A String", # The id of the user setting.
        "value": "A String", # Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
      },
    ],
    "kind": "calendar#settings", # Type of the collection ("calendar#settings").
    "etag": "A String", # Etag of the collection.
    "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
  }
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, syncToken=None, pageToken=None, maxResults=None) 
Watch for changes to Settings resources.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
  pageToken: string, Token specifying which result page to return. Optional.
  maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

Returns:
  An object of the form:

    {
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/civicinfo_v2.divisions.html000066400000000000000000000052271300622755700253530ustar00rootroot00000000000000

Google Civic Information API . divisions

Instance Methods

search(query=None)

Searches for political divisions by their natural name or OCD ID.

Method Details

search(query=None) 
Searches for political divisions by their natural name or OCD ID.

Args:
  query: string, The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html

Returns:
  An object of the form:

    { # The result of a division search query.
    "kind": "civicinfo#divisionSearchResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse".
    "results": [
      { # Represents a political geographic division that matches the requested query.
        "ocdId": "A String", # The unique Open Civic Data identifier for this division.
        "name": "A String", # The name of the division.
        "aliases": [ # Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.
          "A String",
        ],
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/civicinfo_v2.elections.html000066400000000000000000000572111300622755700253310ustar00rootroot00000000000000

Google Civic Information API . elections

Instance Methods

electionQuery()

List of available elections to query.

voterInfoQuery(address, electionId=None, returnAllAvailableData=None, 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", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
    "elections": [ # A list of available elections
      { # Information about the election that was queried.
        "ocdDivisionId": "A String", # The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
        "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(address, electionId=None, returnAllAvailableData=None, officialOnly=None) 
Looks up information relevant to a voter based on the voter's registered address.

Args:
  address: string, The registered address of the voter to look up. (required)
  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
  returnAllAvailableData: boolean, If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
  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.
    "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, an election day voting location, or a drop off location for a completed ballot.
        "startDate": "A String", # The first date that this early vote site or drop off location 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 or drop off location may be used. This field is not populated for polling locations.
        "name": "A String", # The name of the early vote site or drop off location. 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 or drop off location. 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.
      },
    ],
    "dropOffLocations": [ # Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.
      { # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
        "startDate": "A String", # The first date that this early vote site or drop off location 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 or drop off location may be used. This field is not populated for polling locations.
        "name": "A String", # The name of the early vote site or drop off location. 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 or drop off location. 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.
      },
    ],
    "otherElections": [ # If no election ID was specified in the query, and there was more than one election with data for the given voter, this will contain information about the other elections that could apply.
      { # Information about the election that was queried.
        "ocdDivisionId": "A String", # The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
        "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.
      },
    ],
    "mailOnly": True or False, # Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).
    "kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "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.
          "addressLines": [
            "A String",
          ],
          "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.
          },
          "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
        },
        "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.
      },
    ],
    "precinctId": "A String",
    "election": { # Information about the election that was queried. # The election that was queried.
      "ocdDivisionId": "A String", # The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
      "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.
      { # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
        "startDate": "A String", # The first date that this early vote site or drop off location 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 or drop off location may be used. This field is not populated for polling locations.
        "name": "A String", # The name of the early vote site or drop off location. 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 or drop off location. 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.
        "office": "A String", # The name of the office for this contest.
        "referendumBrief": "A String", # Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'.
        "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.
          },
        ],
        "primaryParty": "A String", # If this is a partisan election, the name of the party it is for.
        "electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
        "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'.
        "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.
        "referendumEffectOfAbstain": "A String", # Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'.
        "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.
          "kgForeignKey": "A String",
        },
        "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
        "referendumProStatement": "A String", # A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
        "candidates": [ # The candidate choices for this contest.
          { # Information about a candidate running for elected office.
            "name": "A String", # The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan"
            "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.
          },
        ],
        "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'. For Retention contests this will typically be 'Retention'.
        "referendumText": "A String", # The full text of the referendum. This field is only populated for contests of type 'Referendum'.
        "referendumConStatement": "A String", # A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
        "referendumPassageThreshold": "A String", # The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'.
        "numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
        "roles": [ # The roles which this office fulfills.
          "A String",
        ],
        "referendumBallotResponses": [ # The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'.
          "A String",
        ],
        "level": [ # The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
          "A String",
        ],
        "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/civicinfo_v2.html000066400000000000000000000046541300622755700233500ustar00rootroot00000000000000

Google Civic Information API

Instance Methods

divisions()

Returns the divisions Resource.

elections()

Returns the elections Resource.

representatives()

Returns the representatives Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/civicinfo_v2.representatives.html000066400000000000000000000351371300622755700265720ustar00rootroot00000000000000

Google Civic Information API . representatives

Instance Methods

representativeInfoByAddress(levels=None, roles=None, address=None, includeOffices=None)

Looks up political geography and representative information for a single address.

representativeInfoByDivision(ocdId, recursive=None, roles=None, levels=None)

Looks up representative information for a single geographic division.

Method Details

representativeInfoByAddress(levels=None, roles=None, address=None, includeOffices=None) 
Looks up political geography and representative information for a single address.

Args:
  levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
    Allowed values
      administrativeArea1 - 
      administrativeArea2 - 
      country - 
      international - 
      locality - 
      regional - 
      special - 
      subLocality1 - 
      subLocality2 - 
  roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
    Allowed values
      deputyHeadOfGovernment - 
      executiveCouncil - 
      governmentOfficer - 
      headOfGovernment - 
      headOfState - 
      highestCourtJudge - 
      judge - 
      legislatorLowerBody - 
      legislatorUpperBody - 
      schoolBoard - 
      specialPurposeOfficer - 
  address: string, The address to look up. May only be specified if the field ocdId is not given in the URL.
  includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.

Returns:
  An object of the form:

    { # The result of a representative info lookup query.
    "divisions": { # Political geographic divisions that contain the requested address.
      "a_key": { # Describes a political geography. # The unique Open Civic Data identifier for this division.
        "officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
          42,
        ],
        "alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.
            #
            # Because OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.
            #
            # For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
          "A String",
        ],
        "name": "A String", # The name of the division.
      },
    },
    "kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
    "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
      { # Information about a person holding an elected office.
        "name": "A String", # The official's name.
        "photoUrl": "A String", # A URL for a photo of the official.
        "phones": [ # The official's public contact phone numbers.
          "A String",
        ],
        "channels": [ # A list of known (social) media channels for this official.
          { # 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.
          },
        ],
        "urls": [ # The official's public website URLs.
          "A String",
        ],
        "address": [ # Addresses at which to contact the official.
          { # A simple representation of an 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.
          },
        ],
        "party": "A String", # The full name of the party the official belongs to.
        "emails": [ # The direct email addresses for the official.
          "A String",
        ],
      },
    ],
    "offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
      { # Information about an Office held by one or more Officials.
        "name": "A String", # The human-readable name of the office.
        "roles": [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
          "A String",
        ],
        "officialIndices": [ # List of indices in the officials array of people who presently hold this office.
          42,
        ],
        "sources": [ # A list of sources for this office. 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.
          },
        ],
        "levels": [ # The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
          "A String",
        ],
        "divisionId": "A String", # The OCD ID of the division with which this office is associated.
      },
    ],
    "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.
    },
  }
representativeInfoByDivision(ocdId, recursive=None, roles=None, levels=None) 
Looks up representative information for a single geographic division.

Args:
  ocdId: string, The Open Civic Data division identifier of the division to look up. (required)
  recursive: boolean, If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
  roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
    Allowed values
      deputyHeadOfGovernment - 
      executiveCouncil - 
      governmentOfficer - 
      headOfGovernment - 
      headOfState - 
      highestCourtJudge - 
      judge - 
      legislatorLowerBody - 
      legislatorUpperBody - 
      schoolBoard - 
      specialPurposeOfficer - 
  levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
    Allowed values
      administrativeArea1 - 
      administrativeArea2 - 
      country - 
      international - 
      locality - 
      regional - 
      special - 
      subLocality1 - 
      subLocality2 - 

Returns:
  An object of the form:

    {
    "divisions": { # Political geographic divisions that contain the requested address.
      "a_key": { # Describes a political geography. # The unique Open Civic Data identifier for this division.
        "officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
          42,
        ],
        "alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.
            #
            # Because OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.
            #
            # For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
          "A String",
        ],
        "name": "A String", # The name of the division.
      },
    },
    "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
      { # Information about a person holding an elected office.
        "name": "A String", # The official's name.
        "photoUrl": "A String", # A URL for a photo of the official.
        "phones": [ # The official's public contact phone numbers.
          "A String",
        ],
        "channels": [ # A list of known (social) media channels for this official.
          { # 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.
          },
        ],
        "urls": [ # The official's public website URLs.
          "A String",
        ],
        "address": [ # Addresses at which to contact the official.
          { # A simple representation of an 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.
          },
        ],
        "party": "A String", # The full name of the party the official belongs to.
        "emails": [ # The direct email addresses for the official.
          "A String",
        ],
      },
    ],
    "offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
      { # Information about an Office held by one or more Officials.
        "name": "A String", # The human-readable name of the office.
        "roles": [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
          "A String",
        ],
        "officialIndices": [ # List of indices in the officials array of people who presently hold this office.
          42,
        ],
        "sources": [ # A list of sources for this office. 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.
          },
        ],
        "levels": [ # The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
          "A String",
        ],
        "divisionId": "A String", # The OCD ID of the division with which this office is associated.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/classroom_v1.courses.aliases.html000066400000000000000000000220401300622755700264670ustar00rootroot00000000000000

Google Classroom API . courses . aliases

Instance Methods

create(courseId, body, x__xgafv=None)

Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.

delete(courseId, alias, x__xgafv=None)

Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.

list(courseId, pageSize=None, x__xgafv=None, pageToken=None)

Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, x__xgafv=None) 
Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.

Args:
  courseId: string, Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
    "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
      "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
    }
delete(courseId, alias, x__xgafv=None) 
Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.

Args:
  courseId: string, Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  alias: string, Alias to delete. This may not be the Classroom-assigned identifier. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
list(courseId, pageSize=None, x__xgafv=None, pageToken=None) 
Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

Args:
  courseId: string, The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  x__xgafv: string, V1 error format.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Returns:
  An object of the form:

    { # Response when listing course aliases.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "aliases": [ # The course aliases.
      { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
          "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.courses.courseWork.html000066400000000000000000001027361300622755700272240ustar00rootroot00000000000000

Google Classroom API . courses . courseWork

Instance Methods

studentSubmissions()

Returns the studentSubmissions Resource.

create(courseId, body, x__xgafv=None)

Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

get(courseId, id, x__xgafv=None)

Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

list(courseId, orderBy=None, courseWorkStates=None, pageSize=None, x__xgafv=None, pageToken=None)

Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, x__xgafv=None) 
Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Course work created by a teacher for students of the course.
    "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
    "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
    "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
    "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
    "courseId": "A String", # Identifier of the course. Read-only.
    "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`.
      "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
        "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
        "id": "A String", # Drive API resource ID.
        "title": "A String", # Title of the Drive folder. Read-only.
      },
    },
    "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
    "creationTime": "A String", # Timestamp when this course work was created. Read-only.
    "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
      "month": 42, # Month of year. Must be from 1 to 12.
      "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
      "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
    },
    "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
    "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
      { # Material attached to course work. When creating attachments, only the Link field may be specified.
        "link": { # URL item. # Link material.
          "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
          "title": "A String", # Title of the target of the URL. Read-only.
        },
        "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
          "driveFile": { # Representation of a Google Drive file. # Drive file details.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "shareMode": "A String", # Mechanism by which students access the Drive item.
        },
        "youtubeVideo": { # YouTube video item. # YouTube video material.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
          "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
          "id": "A String", # YouTube API resource ID.
          "title": "A String", # Title of the YouTube video. Read-only.
        },
        "form": { # Google Forms item. # Google Forms material.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
          "formUrl": "A String", # URL of the form.
          "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
          "title": "A String", # Title of the Form. Read-only.
        },
      },
    ],
    "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. This is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`.
      "choices": [ # Possible choices.
        "A String",
      ],
    },
    "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
    "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
    "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
    "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
      "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
      "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
      "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
      "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    },
    "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Course work created by a teacher for students of the course.
      "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
      "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
      "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
      "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
      "courseId": "A String", # Identifier of the course. Read-only.
      "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`.
        "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
          "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
          "id": "A String", # Drive API resource ID.
          "title": "A String", # Title of the Drive folder. Read-only.
        },
      },
      "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
      "creationTime": "A String", # Timestamp when this course work was created. Read-only.
      "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
        "month": 42, # Month of year. Must be from 1 to 12.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
        "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
      },
      "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
      "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
        { # Material attached to course work. When creating attachments, only the Link field may be specified.
          "link": { # URL item. # Link material.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
            "driveFile": { # Representation of a Google Drive file. # Drive file details.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "shareMode": "A String", # Mechanism by which students access the Drive item.
          },
          "youtubeVideo": { # YouTube video item. # YouTube video material.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms material.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
      "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. This is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`.
        "choices": [ # Possible choices.
          "A String",
        ],
      },
      "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
      "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
      "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
      "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
      },
      "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.
    }
get(courseId, id, x__xgafv=None) 
Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the course work. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Course work created by a teacher for students of the course.
      "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
      "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
      "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
      "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
      "courseId": "A String", # Identifier of the course. Read-only.
      "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`.
        "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
          "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
          "id": "A String", # Drive API resource ID.
          "title": "A String", # Title of the Drive folder. Read-only.
        },
      },
      "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
      "creationTime": "A String", # Timestamp when this course work was created. Read-only.
      "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
        "month": 42, # Month of year. Must be from 1 to 12.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
        "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
      },
      "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
      "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
        { # Material attached to course work. When creating attachments, only the Link field may be specified.
          "link": { # URL item. # Link material.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
            "driveFile": { # Representation of a Google Drive file. # Drive file details.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "shareMode": "A String", # Mechanism by which students access the Drive item.
          },
          "youtubeVideo": { # YouTube video item. # YouTube video material.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms material.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
      "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. This is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`.
        "choices": [ # Possible choices.
          "A String",
        ],
      },
      "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
      "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
      "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
      "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
      },
      "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.
    }
list(courseId, orderBy=None, courseWorkStates=None, pageSize=None, x__xgafv=None, pageToken=None) 
Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
  courseWorkStates: string, Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. (repeated)
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  x__xgafv: string, V1 error format.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Returns:
  An object of the form:

    { # Response when listing course work.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "courseWork": [ # Course work items that match the request.
      { # Course work created by a teacher for students of the course.
          "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
          "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
          "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
          "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
          "courseId": "A String", # Identifier of the course. Read-only.
          "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`.
            "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
              "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive folder. Read-only.
            },
          },
          "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
          "creationTime": "A String", # Timestamp when this course work was created. Read-only.
          "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
            "month": 42, # Month of year. Must be from 1 to 12.
            "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
            "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
          },
          "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
          "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
            { # Material attached to course work. When creating attachments, only the Link field may be specified.
              "link": { # URL item. # Link material.
                "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
                "title": "A String", # Title of the target of the URL. Read-only.
              },
              "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
                "driveFile": { # Representation of a Google Drive file. # Drive file details.
                  "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
                  "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
                  "id": "A String", # Drive API resource ID.
                  "title": "A String", # Title of the Drive item. Read-only.
                },
                "shareMode": "A String", # Mechanism by which students access the Drive item.
              },
              "youtubeVideo": { # YouTube video item. # YouTube video material.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
                "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
                "id": "A String", # YouTube API resource ID.
                "title": "A String", # Title of the YouTube video. Read-only.
              },
              "form": { # Google Forms item. # Google Forms material.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
                "formUrl": "A String", # URL of the form.
                "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
                "title": "A String", # Title of the Form. Read-only.
              },
            },
          ],
          "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. This is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`.
            "choices": [ # Possible choices.
              "A String",
            ],
          },
          "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
          "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
          "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
          "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
          },
          "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html000066400000000000000000001303651300622755700331470ustar00rootroot00000000000000

Google Classroom API . courses . courseWork . studentSubmissions

Instance Methods

get(courseId, courseWorkId, id, x__xgafv=None)

Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

list(courseId, courseWorkId, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

list_next(previous_request, previous_response)

Retrieves the next page of results.

modifyAttachments(courseId, courseWorkId, id, body, x__xgafv=None)

Modifies attachments of student submission. Attachments may only be added to student submissions whose type is `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

patch(courseId, courseWorkId, id, body, updateMask=None, x__xgafv=None)

Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

reclaim(courseId, courseWorkId, id, body, x__xgafv=None)

Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that ownes the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

return_(courseId, courseWorkId, id, body, x__xgafv=None)

Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

turnIn(courseId, courseWorkId, id, body, x__xgafv=None)

Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Method Details

get(courseId, courseWorkId, id, x__xgafv=None) 
Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifier of the course work. (required)
  id: string, Identifier of the student submission. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
    "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
    "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
    "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
    "courseId": "A String", # Identifier of the course. Read-only.
    "userId": "A String", # Identifier for the student that owns this submission. Read-only.
    "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
    "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
      "answer": "A String", # Student response to a short-answer question.
    },
    "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
    "late": True or False, # Whether this submission is late. Read-only.
    "state": "A String", # State of this submission. Read-only.
    "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
    "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
    "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
      "answer": "A String", # Student's select choice.
    },
    "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
    "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
      "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
        { # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
          "link": { # URL item. # Link attachment.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "youTubeVideo": { # YouTube video item. # Youtube video attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
    },
    "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
  }
list(courseId, courseWorkId, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None) 
Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifer of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. (required)
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  userId: string, Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
  states: string, Requested submission states. If specified, returned student submissions match one of the specified submission states. (repeated)
  x__xgafv: string, V1 error format.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  late: string, Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.

Returns:
  An object of the form:

    { # Response when listing student submissions.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "studentSubmissions": [ # Student work that matches the request.
      { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
        "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
        "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
        "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
        "courseId": "A String", # Identifier of the course. Read-only.
        "userId": "A String", # Identifier for the student that owns this submission. Read-only.
        "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
        "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
          "answer": "A String", # Student response to a short-answer question.
        },
        "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
        "late": True or False, # Whether this submission is late. Read-only.
        "state": "A String", # State of this submission. Read-only.
        "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
        "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
        "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
          "answer": "A String", # Student's select choice.
        },
        "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
        "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
          "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
            { # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
              "link": { # URL item. # Link attachment.
                "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
                "title": "A String", # Title of the target of the URL. Read-only.
              },
              "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
                "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
                "id": "A String", # Drive API resource ID.
                "title": "A String", # Title of the Drive item. Read-only.
              },
              "youTubeVideo": { # YouTube video item. # Youtube video attachment.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
                "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
                "id": "A String", # YouTube API resource ID.
                "title": "A String", # Title of the YouTube video. Read-only.
              },
              "form": { # Google Forms item. # Google Forms attachment.
                "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
                "formUrl": "A String", # URL of the form.
                "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
                "title": "A String", # Title of the Form. Read-only.
              },
            },
          ],
        },
        "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-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.
modifyAttachments(courseId, courseWorkId, id, body, x__xgafv=None) 
Modifies attachments of student submission. Attachments may only be added to student submissions whose type is `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifier of the course work. (required)
  id: string, Identifier of the student submission. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to modify the attachments of a student submission.
    "addAttachments": [ # Attachments to add. A student submission may not have more than 20 attachments. This may only contain link attachments.
      { # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
        "link": { # URL item. # Link attachment.
          "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
          "title": "A String", # Title of the target of the URL. Read-only.
        },
        "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "youTubeVideo": { # YouTube video item. # Youtube video attachment.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
          "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
          "id": "A String", # YouTube API resource ID.
          "title": "A String", # Title of the YouTube video. Read-only.
        },
        "form": { # Google Forms item. # Google Forms attachment.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
          "formUrl": "A String", # URL of the form.
          "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
          "title": "A String", # Title of the Form. Read-only.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
    "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
    "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
    "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
    "courseId": "A String", # Identifier of the course. Read-only.
    "userId": "A String", # Identifier for the student that owns this submission. Read-only.
    "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
    "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
      "answer": "A String", # Student response to a short-answer question.
    },
    "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
    "late": True or False, # Whether this submission is late. Read-only.
    "state": "A String", # State of this submission. Read-only.
    "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
    "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
    "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
      "answer": "A String", # Student's select choice.
    },
    "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
    "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
      "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
        { # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
          "link": { # URL item. # Link attachment.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "youTubeVideo": { # YouTube video item. # Youtube video attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
    },
    "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
  }
patch(courseId, courseWorkId, id, body, updateMask=None, x__xgafv=None) 
Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifier of the course work. (required)
  id: string, Identifier of the student submission. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
  "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
  "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
  "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
  "courseId": "A String", # Identifier of the course. Read-only.
  "userId": "A String", # Identifier for the student that owns this submission. Read-only.
  "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
  "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
    "answer": "A String", # Student response to a short-answer question.
  },
  "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
  "late": True or False, # Whether this submission is late. Read-only.
  "state": "A String", # State of this submission. Read-only.
  "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
  "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
  "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
    "answer": "A String", # Student's select choice.
  },
  "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
  "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
    "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
      { # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
        "link": { # URL item. # Link attachment.
          "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
          "title": "A String", # Title of the target of the URL. Read-only.
        },
        "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "youTubeVideo": { # YouTube video item. # Youtube video attachment.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
          "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
          "id": "A String", # YouTube API resource ID.
          "title": "A String", # Title of the YouTube video. Read-only.
        },
        "form": { # Google Forms item. # Google Forms attachment.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
          "formUrl": "A String", # URL of the form.
          "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
          "title": "A String", # Title of the Form. Read-only.
        },
      },
    ],
  },
  "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
}

  updateMask: string, Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
    "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
    "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
    "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
    "courseId": "A String", # Identifier of the course. Read-only.
    "userId": "A String", # Identifier for the student that owns this submission. Read-only.
    "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
    "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
      "answer": "A String", # Student response to a short-answer question.
    },
    "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
    "late": True or False, # Whether this submission is late. Read-only.
    "state": "A String", # State of this submission. Read-only.
    "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
    "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
    "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
      "answer": "A String", # Student's select choice.
    },
    "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
    "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
      "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
        { # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
          "link": { # URL item. # Link attachment.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "youTubeVideo": { # YouTube video item. # Youtube video attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
    },
    "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
  }
reclaim(courseId, courseWorkId, id, body, x__xgafv=None) 
Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that ownes the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifier of the course work. (required)
  id: string, Identifier of the student submission. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to reclaim a student submission.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
return_(courseId, courseWorkId, id, body, x__xgafv=None) 
Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifier of the course work. (required)
  id: string, Identifier of the student submission. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to return a student submission.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
turnIn(courseId, courseWorkId, id, body, x__xgafv=None) 
Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkId: string, Identifier of the course work. (required)
  id: string, Identifier of the student submission. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to turn in a student submission.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/classroom_v1.courses.html000066400000000000000000001600651300622755700250610ustar00rootroot00000000000000

Google Classroom API . courses

Instance Methods

aliases()

Returns the aliases Resource.

courseWork()

Returns the courseWork Resource.

students()

Returns the students Resource.

teachers()

Returns the teachers Resource.

create(body, x__xgafv=None)

Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.

delete(id, x__xgafv=None)

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

get(id, x__xgafv=None)

Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(id, body, updateMask=None, x__xgafv=None)

Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

update(id, body, x__xgafv=None)

Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

Method Details

create(body, x__xgafv=None) 
Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A Course in Classroom.
  "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
  "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
  "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
  "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
  "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
  "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
  "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
    "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
    "id": "A String", # Drive API resource ID.
    "title": "A String", # Title of the Drive folder. Read-only.
  },
  "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
  "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
  "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
  "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
    { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
      "materials": [ # Materials attached to this set.
        { # A material attached to a course as part of a material set.
          "link": { # URL item. # Link atatchment.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "youTubeVideo": { # YouTube video item. # Youtube video attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
      "title": "A String", # Title for this set.
    },
  ],
  "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
  "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
  "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
  "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
  "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Course in Classroom.
    "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
    "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
    "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
    "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
    "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
    "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
    "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
      "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
      "id": "A String", # Drive API resource ID.
      "title": "A String", # Title of the Drive folder. Read-only.
    },
    "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
    "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
    "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
    "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
      { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
        "materials": [ # Materials attached to this set.
          { # A material attached to a course as part of a material set.
            "link": { # URL item. # Link atatchment.
              "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
              "title": "A String", # Title of the target of the URL. Read-only.
            },
            "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "youTubeVideo": { # YouTube video item. # Youtube video attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
              "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
              "id": "A String", # YouTube API resource ID.
              "title": "A String", # Title of the YouTube video. Read-only.
            },
            "form": { # Google Forms item. # Google Forms attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
              "formUrl": "A String", # URL of the form.
              "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
              "title": "A String", # Title of the Form. Read-only.
            },
          },
        ],
        "title": "A String", # Title for this set.
      },
    ],
    "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
    "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
    "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
    "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
    "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
    "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
  }
delete(id, x__xgafv=None) 
Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

Args:
  id: string, Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(id, x__xgafv=None) 
Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

Args:
  id: string, Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Course in Classroom.
    "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
    "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
    "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
    "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
    "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
    "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
    "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
      "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
      "id": "A String", # Drive API resource ID.
      "title": "A String", # Title of the Drive folder. Read-only.
    },
    "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
    "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
    "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
    "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
      { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
        "materials": [ # Materials attached to this set.
          { # A material attached to a course as part of a material set.
            "link": { # URL item. # Link atatchment.
              "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
              "title": "A String", # Title of the target of the URL. Read-only.
            },
            "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "youTubeVideo": { # YouTube video item. # Youtube video attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
              "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
              "id": "A String", # YouTube API resource ID.
              "title": "A String", # Title of the YouTube video. Read-only.
            },
            "form": { # Google Forms item. # Google Forms attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
              "formUrl": "A String", # URL of the form.
              "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
              "title": "A String", # Title of the Form. Read-only.
            },
          },
        ],
        "title": "A String", # Title for this set.
      },
    ],
    "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
    "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
    "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
    "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
    "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
    "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
  }
list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None) 
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

Args:
  studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  courseStates: string, Restricts returned courses to those in one of the specified states (repeated)
  teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response when listing courses.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "courses": [ # Courses that match the list request.
      { # A Course in Classroom.
        "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
        "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
        "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
        "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
        "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
        "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
        "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
          "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
          "id": "A String", # Drive API resource ID.
          "title": "A String", # Title of the Drive folder. Read-only.
        },
        "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
        "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
        "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
        "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
          { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
            "materials": [ # Materials attached to this set.
              { # A material attached to a course as part of a material set.
                "link": { # URL item. # Link atatchment.
                  "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
                  "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
                  "title": "A String", # Title of the target of the URL. Read-only.
                },
                "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
                  "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
                  "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
                  "id": "A String", # Drive API resource ID.
                  "title": "A String", # Title of the Drive item. Read-only.
                },
                "youTubeVideo": { # YouTube video item. # Youtube video attachment.
                  "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
                  "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
                  "id": "A String", # YouTube API resource ID.
                  "title": "A String", # Title of the YouTube video. Read-only.
                },
                "form": { # Google Forms item. # Google Forms attachment.
                  "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
                  "formUrl": "A String", # URL of the form.
                  "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
                  "title": "A String", # Title of the Form. Read-only.
                },
              },
            ],
            "title": "A String", # Title for this set.
          },
        ],
        "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
        "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
        "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
        "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
        "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
        "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
      },
    ],
  }
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, updateMask=None, x__xgafv=None) 
Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

Args:
  id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Course in Classroom.
  "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
  "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
  "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
  "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
  "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
  "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
  "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
    "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
    "id": "A String", # Drive API resource ID.
    "title": "A String", # Title of the Drive folder. Read-only.
  },
  "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
  "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
  "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
  "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
    { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
      "materials": [ # Materials attached to this set.
        { # A material attached to a course as part of a material set.
          "link": { # URL item. # Link atatchment.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "youTubeVideo": { # YouTube video item. # Youtube video attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
      "title": "A String", # Title for this set.
    },
  ],
  "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
  "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
  "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
  "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
  "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}

  updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Course in Classroom.
    "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
    "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
    "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
    "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
    "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
    "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
    "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
      "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
      "id": "A String", # Drive API resource ID.
      "title": "A String", # Title of the Drive folder. Read-only.
    },
    "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
    "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
    "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
    "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
      { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
        "materials": [ # Materials attached to this set.
          { # A material attached to a course as part of a material set.
            "link": { # URL item. # Link atatchment.
              "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
              "title": "A String", # Title of the target of the URL. Read-only.
            },
            "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "youTubeVideo": { # YouTube video item. # Youtube video attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
              "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
              "id": "A String", # YouTube API resource ID.
              "title": "A String", # Title of the YouTube video. Read-only.
            },
            "form": { # Google Forms item. # Google Forms attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
              "formUrl": "A String", # URL of the form.
              "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
              "title": "A String", # Title of the Form. Read-only.
            },
          },
        ],
        "title": "A String", # Title for this set.
      },
    ],
    "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
    "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
    "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
    "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
    "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
    "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
  }
update(id, body, x__xgafv=None) 
Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

Args:
  id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Course in Classroom.
  "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
  "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
  "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
  "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
  "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
  "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
  "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
    "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
    "id": "A String", # Drive API resource ID.
    "title": "A String", # Title of the Drive folder. Read-only.
  },
  "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
  "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
  "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
  "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
    { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
      "materials": [ # Materials attached to this set.
        { # A material attached to a course as part of a material set.
          "link": { # URL item. # Link atatchment.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
          },
          "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive item. Read-only.
          },
          "youTubeVideo": { # YouTube video item. # Youtube video attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
          "form": { # Google Forms item. # Google Forms attachment.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
        },
      ],
      "title": "A String", # Title for this set.
    },
  ],
  "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
  "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
  "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
  "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
  "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Course in Classroom.
    "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
    "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
    "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
    "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
    "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
    "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
    "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
      "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
      "id": "A String", # Drive API resource ID.
      "title": "A String", # Title of the Drive folder. Read-only.
    },
    "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
    "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
    "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
    "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
      { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
        "materials": [ # Materials attached to this set.
          { # A material attached to a course as part of a material set.
            "link": { # URL item. # Link atatchment.
              "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
              "title": "A String", # Title of the target of the URL. Read-only.
            },
            "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "youTubeVideo": { # YouTube video item. # Youtube video attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
              "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
              "id": "A String", # YouTube API resource ID.
              "title": "A String", # Title of the YouTube video. Read-only.
            },
            "form": { # Google Forms item. # Google Forms attachment.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
              "formUrl": "A String", # URL of the form.
              "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
              "title": "A String", # Title of the Form. Read-only.
            },
          },
        ],
        "title": "A String", # Title for this set.
      },
    ],
    "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
    "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
    "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
    "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
    "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
    "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
  }
google-api-python-client-1.5.5/docs/dyn/classroom_v1.courses.students.html000066400000000000000000000353771300622755700267400ustar00rootroot00000000000000

Google Classroom API . courses . students

Instance Methods

create(courseId, body, enrollmentCode=None, x__xgafv=None)

Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.

delete(courseId, userId, x__xgafv=None)

Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

get(courseId, userId, x__xgafv=None)

Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

list(courseId, pageSize=None, x__xgafv=None, pageToken=None)

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, enrollmentCode=None, x__xgafv=None) 
Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.

Args:
  courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Student in a course.
    "courseId": "A String", # Identifier of the course. Read-only.
    "profile": { # Global information for a user. # Global user information for the student. Read-only.
      "permissions": [ # Global permissions of the user. Read-only.
        { # Global user permission description.
          "permission": "A String", # Permission value.
        },
      ],
      "photoUrl": "A String", # URL of user's profile photo. Read-only.
      "emailAddress": "A String", # Email address of the user. Read-only.
      "id": "A String", # Identifier of the user. Read-only.
      "name": { # Details of the user's name. # Name of the user. Read-only.
        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
        "givenName": "A String", # The user's first name. Read-only.
        "familyName": "A String", # The user's last name. Read-only.
      },
    },
    "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
      "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
      "id": "A String", # Drive API resource ID.
      "title": "A String", # Title of the Drive folder. Read-only.
    },
    "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
  }

  enrollmentCode: string, Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Student in a course.
      "courseId": "A String", # Identifier of the course. Read-only.
      "profile": { # Global information for a user. # Global user information for the student. Read-only.
        "permissions": [ # Global permissions of the user. Read-only.
          { # Global user permission description.
            "permission": "A String", # Permission value.
          },
        ],
        "photoUrl": "A String", # URL of user's profile photo. Read-only.
        "emailAddress": "A String", # Email address of the user. Read-only.
        "id": "A String", # Identifier of the user. Read-only.
        "name": { # Details of the user's name. # Name of the user. Read-only.
          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
          "givenName": "A String", # The user's first name. Read-only.
          "familyName": "A String", # The user's last name. Read-only.
        },
      },
      "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
        "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
        "id": "A String", # Drive API resource ID.
        "title": "A String", # Title of the Drive folder. Read-only.
      },
      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
    }
delete(courseId, userId, x__xgafv=None) 
Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  userId: string, Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(courseId, userId, x__xgafv=None) 
Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  userId: string, Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Student in a course.
      "courseId": "A String", # Identifier of the course. Read-only.
      "profile": { # Global information for a user. # Global user information for the student. Read-only.
        "permissions": [ # Global permissions of the user. Read-only.
          { # Global user permission description.
            "permission": "A String", # Permission value.
          },
        ],
        "photoUrl": "A String", # URL of user's profile photo. Read-only.
        "emailAddress": "A String", # Email address of the user. Read-only.
        "id": "A String", # Identifier of the user. Read-only.
        "name": { # Details of the user's name. # Name of the user. Read-only.
          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
          "givenName": "A String", # The user's first name. Read-only.
          "familyName": "A String", # The user's last name. Read-only.
        },
      },
      "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
        "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
        "id": "A String", # Drive API resource ID.
        "title": "A String", # Title of the Drive folder. Read-only.
      },
      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
    }
list(courseId, pageSize=None, x__xgafv=None, pageToken=None) 
Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
  x__xgafv: string, V1 error format.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Returns:
  An object of the form:

    { # Response when listing students.
    "students": [ # Students who match the list request.
      { # Student in a course.
          "courseId": "A String", # Identifier of the course. Read-only.
          "profile": { # Global information for a user. # Global user information for the student. Read-only.
            "permissions": [ # Global permissions of the user. Read-only.
              { # Global user permission description.
                "permission": "A String", # Permission value.
              },
            ],
            "photoUrl": "A String", # URL of user's profile photo. Read-only.
            "emailAddress": "A String", # Email address of the user. Read-only.
            "id": "A String", # Identifier of the user. Read-only.
            "name": { # Details of the user's name. # Name of the user. Read-only.
              "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
              "givenName": "A String", # The user's first name. Read-only.
              "familyName": "A String", # The user's last name. Read-only.
            },
          },
          "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
            "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
            "id": "A String", # Drive API resource ID.
            "title": "A String", # Title of the Drive folder. Read-only.
          },
          "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
        },
    ],
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
  }
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.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.courses.teachers.html000066400000000000000000000316571300622755700266620ustar00rootroot00000000000000

Google Classroom API . courses . teachers

Instance Methods

create(courseId, body, x__xgafv=None)

Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

delete(courseId, userId, x__xgafv=None)

Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.

get(courseId, userId, x__xgafv=None)

Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

list(courseId, pageSize=None, x__xgafv=None, pageToken=None)

Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, x__xgafv=None) 
Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Teacher of a course.
    "courseId": "A String", # Identifier of the course. Read-only.
    "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
      "permissions": [ # Global permissions of the user. Read-only.
        { # Global user permission description.
          "permission": "A String", # Permission value.
        },
      ],
      "photoUrl": "A String", # URL of user's profile photo. Read-only.
      "emailAddress": "A String", # Email address of the user. Read-only.
      "id": "A String", # Identifier of the user. Read-only.
      "name": { # Details of the user's name. # Name of the user. Read-only.
        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
        "givenName": "A String", # The user's first name. Read-only.
        "familyName": "A String", # The user's last name. Read-only.
      },
    },
    "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Teacher of a course.
      "courseId": "A String", # Identifier of the course. Read-only.
      "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
        "permissions": [ # Global permissions of the user. Read-only.
          { # Global user permission description.
            "permission": "A String", # Permission value.
          },
        ],
        "photoUrl": "A String", # URL of user's profile photo. Read-only.
        "emailAddress": "A String", # Email address of the user. Read-only.
        "id": "A String", # Identifier of the user. Read-only.
        "name": { # Details of the user's name. # Name of the user. Read-only.
          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
          "givenName": "A String", # The user's first name. Read-only.
          "familyName": "A String", # The user's last name. Read-only.
        },
      },
      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
    }
delete(courseId, userId, x__xgafv=None) 
Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  userId: string, Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(courseId, userId, x__xgafv=None) 
Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  userId: string, Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Teacher of a course.
      "courseId": "A String", # Identifier of the course. Read-only.
      "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
        "permissions": [ # Global permissions of the user. Read-only.
          { # Global user permission description.
            "permission": "A String", # Permission value.
          },
        ],
        "photoUrl": "A String", # URL of user's profile photo. Read-only.
        "emailAddress": "A String", # Email address of the user. Read-only.
        "id": "A String", # Identifier of the user. Read-only.
        "name": { # Details of the user's name. # Name of the user. Read-only.
          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
          "givenName": "A String", # The user's first name. Read-only.
          "familyName": "A String", # The user's last name. Read-only.
        },
      },
      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
    }
list(courseId, pageSize=None, x__xgafv=None, pageToken=None) 
Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
  x__xgafv: string, V1 error format.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Returns:
  An object of the form:

    { # Response when listing teachers.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "teachers": [ # Teachers who match the list request.
      { # Teacher of a course.
          "courseId": "A String", # Identifier of the course. Read-only.
          "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
            "permissions": [ # Global permissions of the user. Read-only.
              { # Global user permission description.
                "permission": "A String", # Permission value.
              },
            ],
            "photoUrl": "A String", # URL of user's profile photo. Read-only.
            "emailAddress": "A String", # Email address of the user. Read-only.
            "id": "A String", # Identifier of the user. Read-only.
            "name": { # Details of the user's name. # Name of the user. Read-only.
              "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
              "givenName": "A String", # The user's first name. Read-only.
              "familyName": "A String", # The user's last name. Read-only.
            },
          },
          "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.html000066400000000000000000000046331300622755700233750ustar00rootroot00000000000000

Google Classroom API

Instance Methods

courses()

Returns the courses Resource.

invitations()

Returns the invitations Resource.

userProfiles()

Returns the userProfiles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.invitations.html000066400000000000000000000266541300622755700257520ustar00rootroot00000000000000

Google Classroom API . invitations

Instance Methods

accept(id, x__xgafv=None)

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

create(body, x__xgafv=None)

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

delete(id, x__xgafv=None)

Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

get(id, x__xgafv=None)

Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

list(pageSize=None, courseId=None, userId=None, x__xgafv=None, pageToken=None)

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

accept(id, x__xgafv=None) 
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

Args:
  id: string, Identifier of the invitation to accept. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
create(body, x__xgafv=None) 
Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An invitation to join a course.
    "courseId": "A String", # Identifier of the course to invite the user to.
    "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
    "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
    "id": "A String", # Identifier assigned by Classroom. Read-only.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An invitation to join a course.
      "courseId": "A String", # Identifier of the course to invite the user to.
      "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
      "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
      "id": "A String", # Identifier assigned by Classroom. Read-only.
    }
delete(id, x__xgafv=None) 
Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

Args:
  id: string, Identifier of the invitation to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(id, x__xgafv=None) 
Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

Args:
  id: string, Identifier of the invitation to return. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An invitation to join a course.
      "courseId": "A String", # Identifier of the course to invite the user to.
      "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
      "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
      "id": "A String", # Identifier assigned by Classroom. Read-only.
    }
list(pageSize=None, courseId=None, userId=None, x__xgafv=None, pageToken=None) 
Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

Args:
  pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
  courseId: string, Restricts returned invitations to those for a course with the specified identifier.
  userId: string, Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
  x__xgafv: string, V1 error format.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Returns:
  An object of the form:

    { # Response when listing invitations.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "invitations": [ # Invitations that match the list request.
      { # An invitation to join a course.
          "courseId": "A String", # Identifier of the course to invite the user to.
          "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
          "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
          "id": "A String", # Identifier assigned by Classroom. Read-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.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html000066400000000000000000000416351300622755700321020ustar00rootroot00000000000000

Google Classroom API . userProfiles . guardianInvitations

Instance Methods

create(studentId, body, x__xgafv=None)

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.

get(studentId, invitationId, x__xgafv=None)

Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.

list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None)

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(studentId, invitationId, body, updateMask=None, x__xgafv=None)

Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.

Method Details

create(studentId, body, x__xgafv=None) 
Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.

Args:
  studentId: string, ID of the student (in standard format) (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An invitation to become the guardian of a specified user, sent to a specified email address.
    "invitationId": "A String", # Unique identifier for this invitation. Read-only.
    "studentId": "A String", # ID of the student (in standard format)
    "creationTime": "A String", # The time that this invitation was created. Read-only.
    "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
    "state": "A String", # The state that this invitation is in.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An invitation to become the guardian of a specified user, sent to a specified email address.
      "invitationId": "A String", # Unique identifier for this invitation. Read-only.
      "studentId": "A String", # ID of the student (in standard format)
      "creationTime": "A String", # The time that this invitation was created. Read-only.
      "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
      "state": "A String", # The state that this invitation is in.
    }
get(studentId, invitationId, x__xgafv=None) 
Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.

Args:
  studentId: string, The ID of the student whose guardian invitation is being requested. (required)
  invitationId: string, The `id` field of the `GuardianInvitation` being requested. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An invitation to become the guardian of a specified user, sent to a specified email address.
      "invitationId": "A String", # Unique identifier for this invitation. Read-only.
      "studentId": "A String", # ID of the student (in standard format)
      "creationTime": "A String", # The time that this invitation was created. Read-only.
      "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
      "state": "A String", # The state that this invitation is in.
    }
list(studentId, invitedEmailAddress=None, pageSize=None, states=None, pageToken=None, x__xgafv=None) 
Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

Args:
  studentId: string, The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. (required)
  invitedEmailAddress: string, If specified, only results with the specified `invited_email_address` will be returned.
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  states: string, If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned. (repeated)
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response when listing guardian invitations.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "guardianInvitations": [ # Guardian invitations that matched the list request.
      { # An invitation to become the guardian of a specified user, sent to a specified email address.
          "invitationId": "A String", # Unique identifier for this invitation. Read-only.
          "studentId": "A String", # ID of the student (in standard format)
          "creationTime": "A String", # The time that this invitation was created. Read-only.
          "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
          "state": "A String", # The state that this invitation is in.
        },
    ],
  }
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(studentId, invitationId, body, updateMask=None, x__xgafv=None) 
Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.

Args:
  studentId: string, The ID of the student whose guardian invitation is to be modified. (required)
  invitationId: string, The `id` field of the `GuardianInvitation` to be modified. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An invitation to become the guardian of a specified user, sent to a specified email address.
    "invitationId": "A String", # Unique identifier for this invitation. Read-only.
    "studentId": "A String", # ID of the student (in standard format)
    "creationTime": "A String", # The time that this invitation was created. Read-only.
    "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
    "state": "A String", # The state that this invitation is in.
  }

  updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An invitation to become the guardian of a specified user, sent to a specified email address.
      "invitationId": "A String", # Unique identifier for this invitation. Read-only.
      "studentId": "A String", # ID of the student (in standard format)
      "creationTime": "A String", # The time that this invitation was created. Read-only.
      "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
      "state": "A String", # The state that this invitation is in.
    }
google-api-python-client-1.5.5/docs/dyn/classroom_v1.userProfiles.guardians.html000066400000000000000000000305611300622755700300310ustar00rootroot00000000000000

Google Classroom API . userProfiles . guardians

Instance Methods

delete(studentId, guardianId, x__xgafv=None)

Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if Classroom cannot find any record of the given `student_id` or `guardian_id`, or if the guardian has already been disabled.

get(studentId, guardianId, x__xgafv=None)

Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.

list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None)

Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(studentId, guardianId, x__xgafv=None) 
Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if Classroom cannot find any record of the given `student_id` or `guardian_id`, or if the guardian has already been disabled.

Args:
  studentId: string, The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  guardianId: string, The `id` field from a `Guardian`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(studentId, guardianId, x__xgafv=None) 
Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.

Args:
  studentId: string, The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  guardianId: string, The `id` field from a `Guardian`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
    "guardianId": "A String", # Identifier for the guardian.
    "guardianProfile": { # Global information for a user. # User profile for the guardian.
      "permissions": [ # Global permissions of the user. Read-only.
        { # Global user permission description.
          "permission": "A String", # Permission value.
        },
      ],
      "photoUrl": "A String", # URL of user's profile photo. Read-only.
      "emailAddress": "A String", # Email address of the user. Read-only.
      "id": "A String", # Identifier of the user. Read-only.
      "name": { # Details of the user's name. # Name of the user. Read-only.
        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
        "givenName": "A String", # The user's first name. Read-only.
        "familyName": "A String", # The user's last name. Read-only.
      },
    },
    "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
    "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
  }
list(studentId, invitedEmailAddress=None, pageSize=None, pageToken=None, x__xgafv=None) 
Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

Args:
  studentId: string, Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. (required)
  invitedEmailAddress: string, Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response when listing guardians.
    "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
    "guardians": [ # Guardians on this page of results that met the criteria specified in the request.
      { # Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
        "guardianId": "A String", # Identifier for the guardian.
        "guardianProfile": { # Global information for a user. # User profile for the guardian.
          "permissions": [ # Global permissions of the user. Read-only.
            { # Global user permission description.
              "permission": "A String", # Permission value.
            },
          ],
          "photoUrl": "A String", # URL of user's profile photo. Read-only.
          "emailAddress": "A String", # Email address of the user. Read-only.
          "id": "A String", # Identifier of the user. Read-only.
          "name": { # Details of the user's name. # Name of the user. Read-only.
            "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
            "givenName": "A String", # The user's first name. Read-only.
            "familyName": "A String", # The user's last name. Read-only.
          },
        },
        "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
        "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/classroom_v1.userProfiles.html000066400000000000000000000062701300622755700260550ustar00rootroot00000000000000

Google Classroom API . userProfiles

Instance Methods

guardianInvitations()

Returns the guardianInvitations Resource.

guardians()

Returns the guardians Resource.

get(userId, x__xgafv=None)

Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.

Method Details

get(userId, x__xgafv=None) 
Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.

Args:
  userId: string, Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Global information for a user.
    "permissions": [ # Global permissions of the user. Read-only.
      { # Global user permission description.
        "permission": "A String", # Permission value.
      },
    ],
    "photoUrl": "A String", # URL of user's profile photo. Read-only.
    "emailAddress": "A String", # Email address of the user. Read-only.
    "id": "A String", # Identifier of the user. Read-only.
    "name": { # Details of the user's name. # Name of the user. Read-only.
      "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
      "givenName": "A String", # The user's first name. Read-only.
      "familyName": "A String", # The user's last name. Read-only.
    },
  }
google-api-python-client-1.5.5/docs/dyn/cloudbilling_v1.billingAccounts.html000066400000000000000000000131301300622755700271510ustar00rootroot00000000000000

Google Cloud Billing API . billingAccounts

Instance Methods

projects()

Returns the projects Resource.

get(name, x__xgafv=None)

Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).

list(pageSize=None, pageToken=None, x__xgafv=None)

Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(name, x__xgafv=None) 
Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).

Args:
  name: string, The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.
    "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Developers Console.
    "open": True or False, # True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
    "name": "A String", # The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
  }
list(pageSize=None, pageToken=None, x__xgafv=None) 
Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).

Args:
  pageSize: integer, Requested page size. The maximum page size is 100; this is also the default.
  pageToken: string, A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `ListBillingAccounts`.
    "nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
    "billingAccounts": [ # A list of billing accounts.
      { # A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.
        "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Developers Console.
        "open": True or False, # True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
        "name": "A String", # The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/cloudbilling_v1.billingAccounts.projects.html000066400000000000000000000112671300622755700310120ustar00rootroot00000000000000

Google Cloud Billing API . billingAccounts . projects

Instance Methods

list(name, pageToken=None, x__xgafv=None, pageSize=None)

Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(name, pageToken=None, x__xgafv=None, pageSize=None) 
Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).

Args:
  name: string, The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. (required)
  pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.
  x__xgafv: string, V1 error format.
  pageSize: integer, Requested page size. The maximum page size is 100; this is also the default.

Returns:
  An object of the form:

    { # Request message for `ListProjectBillingInfoResponse`.
    "nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
    "projectBillingInfo": [ # A list of `ProjectBillingInfo` resources representing the projects associated with the billing account.
      { # Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
        "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only.
        "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only.
        "billingEnabled": True or False, # True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.
        "billingAccountName": "A String", # The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/cloudbilling_v1.html000066400000000000000000000044221300622755700240360ustar00rootroot00000000000000

Google Cloud Billing API

Instance Methods

billingAccounts()

Returns the billingAccounts Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/cloudbilling_v1.projects.html000066400000000000000000000227411300622755700256720ustar00rootroot00000000000000

Google Cloud Billing API . projects

Instance Methods

getBillingInfo(name, x__xgafv=None)

Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).

updateBillingInfo(name, body, x__xgafv=None)

Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Developers Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.

Method Details

getBillingInfo(name, x__xgafv=None) 
Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).

Args:
  name: string, The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
    "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only.
    "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only.
    "billingEnabled": True or False, # True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.
    "billingAccountName": "A String", # The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`.
  }
updateBillingInfo(name, body, x__xgafv=None) 
Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Developers Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.

Args:
  name: string, The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
  "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only.
  "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only.
  "billingEnabled": True or False, # True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.
  "billingAccountName": "A String", # The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
    "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only.
    "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only.
    "billingEnabled": True or False, # True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.
    "billingAccountName": "A String", # The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`.
  }
google-api-python-client-1.5.5/docs/dyn/cloudbuild_v1.html000066400000000000000000000044071300622755700235200ustar00rootroot00000000000000

Google Cloud Container Builder API

Instance Methods

operations()

Returns the operations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/cloudbuild_v1.operations.html000066400000000000000000000345021300622755700257010ustar00rootroot00000000000000

Google Cloud Container Builder API . operations

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(name, x__xgafv=None) 
Gets the latest state of a long-running operation.  Clients can use this
method to poll the operation result at intervals as recommended by the API
service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding below allows API services to override the binding
to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "nextPageToken": "A String", # The standard List next-page token.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If true, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should have the format of `operations/some/unique/name`.
        "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/cloudbuild_v1.projects.builds.html000066400000000000000000001475771300622755700266510ustar00rootroot00000000000000

Google Cloud Container Builder API . projects . builds

Instance Methods

cancel(projectId, id, body, x__xgafv=None)

Cancels a requested build in progress.

create(projectId, body, x__xgafv=None)

Starts a build with the specified configuration.

get(projectId, id, x__xgafv=None)

Returns information about a previously requested build.

list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists previously requested builds.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(projectId, id, body, x__xgafv=None) 
Cancels a requested build in progress.

Args:
  projectId: string, ID of the project. (required)
  id: string, ID of the build. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to cancel an ongoing build.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A build resource in the Container Builder API.
      #
      # At a high level, a Build describes where to find source code, how to build
      # it (for example, the builder image to run on the source), and what tag to
      # apply to the built image when it is pushed to Google Container Registry.
      #
      # Fields can include the following variables which will be expanded when the
      # build is created:
      #
      # - $PROJECT_ID: the project ID of the build.
      # - $BUILD_ID: the autogenerated ID of the build.
      # - $REPO_NAME: the source repository name specified by RepoSource.
      # - $BRANCH_NAME: the branch name specified by RepoSource.
      # - $TAG_NAME: the tag name specified by RepoSource.
      # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
      #   resolved from the specified branch or tag.
    "status": "A String", # Status of the build.
        # @OutputOnly
    "finishTime": "A String", # Time at which execution of the build was finished.
        # @OutputOnly
    "timeout": "A String", # Amount of time that this build should be allowed to run, to second
        # granularity. If this amount of time elapses, work on the build will cease
        # and the build status will be TIMEOUT.
        #
        # Default time is ten minutes.
    "statusDetail": "A String", # Customer-readable message about the current status.
        # @OutputOnly
    "startTime": "A String", # Time at which execution of the build was started.
        # @OutputOnly
    "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
        # [Bucket Name
        # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
    "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
        # @OutputOnly
      "images": [ # Images that were built as a part of the build.
        { # BuiltImage describes an image built by the pipeline.
          "name": "A String", # Name used to push the container image to Google Container Registry, as
              # presented to `docker push`.
          "digest": "A String", # Docker Registry 2.0 digest.
        },
      ],
      "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
        "A String",
      ],
    },
    "createTime": "A String", # Time at which the build was created.
        # @OutputOnly
    "id": "A String", # Unique identifier of the build.
        # @OutputOnly
    "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
        # service.
      "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
          # Storage.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
      "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
    },
    "steps": [ # Describes the operations to be performed on the workspace.
      { # BuildStep describes a step to perform in the build pipeline.
        "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
            # This build step will not start until all the build steps in wait_for
            # have completed successfully. If wait_for is empty, this build step will
            # start when all previous build steps in the Build.Steps list have completed
            # successfully.
          "A String",
        ],
        "name": "A String", # The name of the container image that will run this particular build step.
            #
            # If the image is already available in the host's
            # Docker daemon's cache, it will be run directly. If not, the host will
            # attempt to pull the image first, using the builder service account's
            # credentials if necessary.
            #
            # The Docker daemon's cache will already have the latest versions of all of
            # the officially supported build steps
            # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
            # will also have cached many of the layers for some popular images, like
            # "ubuntu", "debian", but they will be refreshed at the time you attempt to
            # use them.
            #
            # If you built an image in a previous build step, it will be stored in the
            # host's Docker daemon's cache and is available to use as the name for a
            # later build step.
        "args": [ # A list of arguments that will be presented to the step when it is started.
            #
            # If the image used to run the step's container has an entrypoint, these args
            # will be used as arguments to that entrypoint. If the image does not define
            # an entrypoint, the first element in args will be used as the entrypoint,
            # and the remainder will be used as arguments.
          "A String",
        ],
        "env": [ # A list of environment variable definitions to be used when running a step.
            #
            # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
            # being given the value "VALUE".
          "A String",
        ],
        "id": "A String", # Optional unique identifier for this build step, used in wait_for to
            # reference this build step as a dependency.
        "dir": "A String", # Working directory (relative to project source root) to use when running
            # this operation's container.
      },
    ],
    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
        # @OutputOnly
        # some source was used for this build.
      "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
          # revisions resolved.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
      "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
          # source integrity was maintained in the build. Note that FileHashes will
          # only be populated if BuildOptions has requested a SourceProvenanceHash.
          #
          # The keys to this map are file paths used as build source and the values
          # contain the hash values for those files.
          #
          # If the build source came in a single package such as a gzipped tarfile
          # (.tar.gz), the FileHash will be for the single path to that file.
          # @OutputOnly
        "a_key": { # Container message for hashes of byte content of files, used in
            # SourceProvenance messages to verify integrity of source input to the build.
          "fileHash": [ # Collection of file hashes.
            { # Container message for hash values.
              "type": "A String", # The type of hash that was performed.
              "value": "A String", # The hash value.
            },
          ],
        },
      },
      "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
          # generations resolved.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
    },
    "projectId": "A String", # ID of the project.
        # @OutputOnly.
    "images": [ # A list of images to be pushed upon the successful completion of all build
        # steps.
        #
        # The images will be pushed using the builder
        # service account's credentials.
        #
        # The digests of the pushed images will be stored in the Build resource's
        # results field.
        #
        # If any of the images fail to be pushed, the build is marked FAILURE.
      "A String",
    ],
    "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
      "requestedVerifyOption": "A String", # Requested verifiability options.
      "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
        "A String",
      ],
    },
    "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
        # @OutputOnly
  }
create(projectId, body, x__xgafv=None) 
Starts a build with the specified configuration.

The long-running Operation returned by this method will include the ID of
the build, which can be passed to GetBuild to determine its status (e.g.,
success or failure).

Args:
  projectId: string, ID of the project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A build resource in the Container Builder API.
    # 
    # At a high level, a Build describes where to find source code, how to build
    # it (for example, the builder image to run on the source), and what tag to
    # apply to the built image when it is pushed to Google Container Registry.
    # 
    # Fields can include the following variables which will be expanded when the
    # build is created:
    # 
    # - $PROJECT_ID: the project ID of the build.
    # - $BUILD_ID: the autogenerated ID of the build.
    # - $REPO_NAME: the source repository name specified by RepoSource.
    # - $BRANCH_NAME: the branch name specified by RepoSource.
    # - $TAG_NAME: the tag name specified by RepoSource.
    # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
    #   resolved from the specified branch or tag.
  "status": "A String", # Status of the build.
      # @OutputOnly
  "finishTime": "A String", # Time at which execution of the build was finished.
      # @OutputOnly
  "timeout": "A String", # Amount of time that this build should be allowed to run, to second
      # granularity. If this amount of time elapses, work on the build will cease
      # and the build status will be TIMEOUT.
      # 
      # Default time is ten minutes.
  "statusDetail": "A String", # Customer-readable message about the current status.
      # @OutputOnly
  "startTime": "A String", # Time at which execution of the build was started.
      # @OutputOnly
  "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
      # [Bucket Name
      # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
  "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
      # @OutputOnly
    "images": [ # Images that were built as a part of the build.
      { # BuiltImage describes an image built by the pipeline.
        "name": "A String", # Name used to push the container image to Google Container Registry, as
            # presented to `docker push`.
        "digest": "A String", # Docker Registry 2.0 digest.
      },
    ],
    "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
      "A String",
    ],
  },
  "createTime": "A String", # Time at which the build was created.
      # @OutputOnly
  "id": "A String", # Unique identifier of the build.
      # @OutputOnly
  "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
      # service.
    "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
        # Storage.
        # Google Cloud Storage.
      "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
          # omitted, the latest generation will be used.
      "object": "A String", # Google Cloud Storage object containing source.
          #
          # This object must be a gzipped archive file (.tar.gz) containing source to
          # build.
      "bucket": "A String", # Google Cloud Storage bucket containing source (see
          # [Bucket Name
          # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
    },
    "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
        # Repository.
      "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
          # the build is assumed.
      "branchName": "A String", # Name of the branch to build.
      "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      "tagName": "A String", # Name of the tag to build.
      "commitSha": "A String", # Explicit commit SHA to build.
    },
  },
  "steps": [ # Describes the operations to be performed on the workspace.
    { # BuildStep describes a step to perform in the build pipeline.
      "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
          # This build step will not start until all the build steps in wait_for
          # have completed successfully. If wait_for is empty, this build step will
          # start when all previous build steps in the Build.Steps list have completed
          # successfully.
        "A String",
      ],
      "name": "A String", # The name of the container image that will run this particular build step.
          #
          # If the image is already available in the host's
          # Docker daemon's cache, it will be run directly. If not, the host will
          # attempt to pull the image first, using the builder service account's
          # credentials if necessary.
          #
          # The Docker daemon's cache will already have the latest versions of all of
          # the officially supported build steps
          # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
          # will also have cached many of the layers for some popular images, like
          # "ubuntu", "debian", but they will be refreshed at the time you attempt to
          # use them.
          #
          # If you built an image in a previous build step, it will be stored in the
          # host's Docker daemon's cache and is available to use as the name for a
          # later build step.
      "args": [ # A list of arguments that will be presented to the step when it is started.
          #
          # If the image used to run the step's container has an entrypoint, these args
          # will be used as arguments to that entrypoint. If the image does not define
          # an entrypoint, the first element in args will be used as the entrypoint,
          # and the remainder will be used as arguments.
        "A String",
      ],
      "env": [ # A list of environment variable definitions to be used when running a step.
          #
          # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
          # being given the value "VALUE".
        "A String",
      ],
      "id": "A String", # Optional unique identifier for this build step, used in wait_for to
          # reference this build step as a dependency.
      "dir": "A String", # Working directory (relative to project source root) to use when running
          # this operation's container.
    },
  ],
  "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
      # @OutputOnly
      # some source was used for this build.
    "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
        # revisions resolved.
        # Repository.
      "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
          # the build is assumed.
      "branchName": "A String", # Name of the branch to build.
      "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      "tagName": "A String", # Name of the tag to build.
      "commitSha": "A String", # Explicit commit SHA to build.
    },
    "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
        # source integrity was maintained in the build. Note that FileHashes will
        # only be populated if BuildOptions has requested a SourceProvenanceHash.
        #
        # The keys to this map are file paths used as build source and the values
        # contain the hash values for those files.
        #
        # If the build source came in a single package such as a gzipped tarfile
        # (.tar.gz), the FileHash will be for the single path to that file.
        # @OutputOnly
      "a_key": { # Container message for hashes of byte content of files, used in
          # SourceProvenance messages to verify integrity of source input to the build.
        "fileHash": [ # Collection of file hashes.
          { # Container message for hash values.
            "type": "A String", # The type of hash that was performed.
            "value": "A String", # The hash value.
          },
        ],
      },
    },
    "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
        # generations resolved.
        # Google Cloud Storage.
      "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
          # omitted, the latest generation will be used.
      "object": "A String", # Google Cloud Storage object containing source.
          #
          # This object must be a gzipped archive file (.tar.gz) containing source to
          # build.
      "bucket": "A String", # Google Cloud Storage bucket containing source (see
          # [Bucket Name
          # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
    },
  },
  "projectId": "A String", # ID of the project.
      # @OutputOnly.
  "images": [ # A list of images to be pushed upon the successful completion of all build
      # steps.
      # 
      # The images will be pushed using the builder
      # service account's credentials.
      # 
      # The digests of the pushed images will be stored in the Build resource's
      # results field.
      # 
      # If any of the images fail to be pushed, the build is marked FAILURE.
    "A String",
  ],
  "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
    "requestedVerifyOption": "A String", # Requested verifiability options.
    "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
      "A String",
    ],
  },
  "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
      # @OutputOnly
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
get(projectId, id, x__xgafv=None) 
Returns information about a previously requested build.

The Build that is returned includes its status (e.g., success or failure,
or in-progress), and timing information.

Args:
  projectId: string, ID of the project. (required)
  id: string, ID of the build. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A build resource in the Container Builder API.
      #
      # At a high level, a Build describes where to find source code, how to build
      # it (for example, the builder image to run on the source), and what tag to
      # apply to the built image when it is pushed to Google Container Registry.
      #
      # Fields can include the following variables which will be expanded when the
      # build is created:
      #
      # - $PROJECT_ID: the project ID of the build.
      # - $BUILD_ID: the autogenerated ID of the build.
      # - $REPO_NAME: the source repository name specified by RepoSource.
      # - $BRANCH_NAME: the branch name specified by RepoSource.
      # - $TAG_NAME: the tag name specified by RepoSource.
      # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
      #   resolved from the specified branch or tag.
    "status": "A String", # Status of the build.
        # @OutputOnly
    "finishTime": "A String", # Time at which execution of the build was finished.
        # @OutputOnly
    "timeout": "A String", # Amount of time that this build should be allowed to run, to second
        # granularity. If this amount of time elapses, work on the build will cease
        # and the build status will be TIMEOUT.
        #
        # Default time is ten minutes.
    "statusDetail": "A String", # Customer-readable message about the current status.
        # @OutputOnly
    "startTime": "A String", # Time at which execution of the build was started.
        # @OutputOnly
    "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
        # [Bucket Name
        # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
    "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
        # @OutputOnly
      "images": [ # Images that were built as a part of the build.
        { # BuiltImage describes an image built by the pipeline.
          "name": "A String", # Name used to push the container image to Google Container Registry, as
              # presented to `docker push`.
          "digest": "A String", # Docker Registry 2.0 digest.
        },
      ],
      "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
        "A String",
      ],
    },
    "createTime": "A String", # Time at which the build was created.
        # @OutputOnly
    "id": "A String", # Unique identifier of the build.
        # @OutputOnly
    "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
        # service.
      "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
          # Storage.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
      "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
    },
    "steps": [ # Describes the operations to be performed on the workspace.
      { # BuildStep describes a step to perform in the build pipeline.
        "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
            # This build step will not start until all the build steps in wait_for
            # have completed successfully. If wait_for is empty, this build step will
            # start when all previous build steps in the Build.Steps list have completed
            # successfully.
          "A String",
        ],
        "name": "A String", # The name of the container image that will run this particular build step.
            #
            # If the image is already available in the host's
            # Docker daemon's cache, it will be run directly. If not, the host will
            # attempt to pull the image first, using the builder service account's
            # credentials if necessary.
            #
            # The Docker daemon's cache will already have the latest versions of all of
            # the officially supported build steps
            # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
            # will also have cached many of the layers for some popular images, like
            # "ubuntu", "debian", but they will be refreshed at the time you attempt to
            # use them.
            #
            # If you built an image in a previous build step, it will be stored in the
            # host's Docker daemon's cache and is available to use as the name for a
            # later build step.
        "args": [ # A list of arguments that will be presented to the step when it is started.
            #
            # If the image used to run the step's container has an entrypoint, these args
            # will be used as arguments to that entrypoint. If the image does not define
            # an entrypoint, the first element in args will be used as the entrypoint,
            # and the remainder will be used as arguments.
          "A String",
        ],
        "env": [ # A list of environment variable definitions to be used when running a step.
            #
            # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
            # being given the value "VALUE".
          "A String",
        ],
        "id": "A String", # Optional unique identifier for this build step, used in wait_for to
            # reference this build step as a dependency.
        "dir": "A String", # Working directory (relative to project source root) to use when running
            # this operation's container.
      },
    ],
    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
        # @OutputOnly
        # some source was used for this build.
      "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
          # revisions resolved.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
      "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
          # source integrity was maintained in the build. Note that FileHashes will
          # only be populated if BuildOptions has requested a SourceProvenanceHash.
          #
          # The keys to this map are file paths used as build source and the values
          # contain the hash values for those files.
          #
          # If the build source came in a single package such as a gzipped tarfile
          # (.tar.gz), the FileHash will be for the single path to that file.
          # @OutputOnly
        "a_key": { # Container message for hashes of byte content of files, used in
            # SourceProvenance messages to verify integrity of source input to the build.
          "fileHash": [ # Collection of file hashes.
            { # Container message for hash values.
              "type": "A String", # The type of hash that was performed.
              "value": "A String", # The hash value.
            },
          ],
        },
      },
      "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
          # generations resolved.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
    },
    "projectId": "A String", # ID of the project.
        # @OutputOnly.
    "images": [ # A list of images to be pushed upon the successful completion of all build
        # steps.
        #
        # The images will be pushed using the builder
        # service account's credentials.
        #
        # The digests of the pushed images will be stored in the Build resource's
        # results field.
        #
        # If any of the images fail to be pushed, the build is marked FAILURE.
      "A String",
    ],
    "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
      "requestedVerifyOption": "A String", # Requested verifiability options.
      "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
        "A String",
      ],
    },
    "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
        # @OutputOnly
  }
list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished
successfully or unsuccessfully.

Args:
  projectId: string, ID of the project. (required)
  pageSize: integer, Number of results to return in the list.
  filter: string, The raw filter text to constrain the results.
  pageToken: string, Token to provide to skip to a particular spot in the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response including listed builds.
    "nextPageToken": "A String", # Token to receive the next page of results.
    "builds": [ # Builds will be sorted by create_time, descending.
      { # A build resource in the Container Builder API.
          #
          # At a high level, a Build describes where to find source code, how to build
          # it (for example, the builder image to run on the source), and what tag to
          # apply to the built image when it is pushed to Google Container Registry.
          #
          # Fields can include the following variables which will be expanded when the
          # build is created:
          #
          # - $PROJECT_ID: the project ID of the build.
          # - $BUILD_ID: the autogenerated ID of the build.
          # - $REPO_NAME: the source repository name specified by RepoSource.
          # - $BRANCH_NAME: the branch name specified by RepoSource.
          # - $TAG_NAME: the tag name specified by RepoSource.
          # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
          #   resolved from the specified branch or tag.
        "status": "A String", # Status of the build.
            # @OutputOnly
        "finishTime": "A String", # Time at which execution of the build was finished.
            # @OutputOnly
        "timeout": "A String", # Amount of time that this build should be allowed to run, to second
            # granularity. If this amount of time elapses, work on the build will cease
            # and the build status will be TIMEOUT.
            #
            # Default time is ten minutes.
        "statusDetail": "A String", # Customer-readable message about the current status.
            # @OutputOnly
        "startTime": "A String", # Time at which execution of the build was started.
            # @OutputOnly
        "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
            # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
        "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
            # @OutputOnly
          "images": [ # Images that were built as a part of the build.
            { # BuiltImage describes an image built by the pipeline.
              "name": "A String", # Name used to push the container image to Google Container Registry, as
                  # presented to `docker push`.
              "digest": "A String", # Docker Registry 2.0 digest.
            },
          ],
          "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
            "A String",
          ],
        },
        "createTime": "A String", # Time at which the build was created.
            # @OutputOnly
        "id": "A String", # Unique identifier of the build.
            # @OutputOnly
        "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
            # service.
          "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
              # Storage.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
          "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
        },
        "steps": [ # Describes the operations to be performed on the workspace.
          { # BuildStep describes a step to perform in the build pipeline.
            "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
                # This build step will not start until all the build steps in wait_for
                # have completed successfully. If wait_for is empty, this build step will
                # start when all previous build steps in the Build.Steps list have completed
                # successfully.
              "A String",
            ],
            "name": "A String", # The name of the container image that will run this particular build step.
                #
                # If the image is already available in the host's
                # Docker daemon's cache, it will be run directly. If not, the host will
                # attempt to pull the image first, using the builder service account's
                # credentials if necessary.
                #
                # The Docker daemon's cache will already have the latest versions of all of
                # the officially supported build steps
                # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
                # will also have cached many of the layers for some popular images, like
                # "ubuntu", "debian", but they will be refreshed at the time you attempt to
                # use them.
                #
                # If you built an image in a previous build step, it will be stored in the
                # host's Docker daemon's cache and is available to use as the name for a
                # later build step.
            "args": [ # A list of arguments that will be presented to the step when it is started.
                #
                # If the image used to run the step's container has an entrypoint, these args
                # will be used as arguments to that entrypoint. If the image does not define
                # an entrypoint, the first element in args will be used as the entrypoint,
                # and the remainder will be used as arguments.
              "A String",
            ],
            "env": [ # A list of environment variable definitions to be used when running a step.
                #
                # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
                # being given the value "VALUE".
              "A String",
            ],
            "id": "A String", # Optional unique identifier for this build step, used in wait_for to
                # reference this build step as a dependency.
            "dir": "A String", # Working directory (relative to project source root) to use when running
                # this operation's container.
          },
        ],
        "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
            # @OutputOnly
            # some source was used for this build.
          "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
              # revisions resolved.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
          "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
              # source integrity was maintained in the build. Note that FileHashes will
              # only be populated if BuildOptions has requested a SourceProvenanceHash.
              #
              # The keys to this map are file paths used as build source and the values
              # contain the hash values for those files.
              #
              # If the build source came in a single package such as a gzipped tarfile
              # (.tar.gz), the FileHash will be for the single path to that file.
              # @OutputOnly
            "a_key": { # Container message for hashes of byte content of files, used in
                # SourceProvenance messages to verify integrity of source input to the build.
              "fileHash": [ # Collection of file hashes.
                { # Container message for hash values.
                  "type": "A String", # The type of hash that was performed.
                  "value": "A String", # The hash value.
                },
              ],
            },
          },
          "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
              # generations resolved.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
        },
        "projectId": "A String", # ID of the project.
            # @OutputOnly.
        "images": [ # A list of images to be pushed upon the successful completion of all build
            # steps.
            #
            # The images will be pushed using the builder
            # service account's credentials.
            #
            # The digests of the pushed images will be stored in the Build resource's
            # results field.
            #
            # If any of the images fail to be pushed, the build is marked FAILURE.
          "A String",
        ],
        "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
          "requestedVerifyOption": "A String", # Requested verifiability options.
          "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
            "A String",
          ],
        },
        "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
            # @OutputOnly
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/cloudbuild_v1.projects.html000066400000000000000000000026231300622755700253460ustar00rootroot00000000000000

Google Cloud Container Builder API . projects

Instance Methods

builds()

Returns the builds Resource.

triggers()

Returns the triggers Resource.

google-api-python-client-1.5.5/docs/dyn/cloudbuild_v1.projects.triggers.html000066400000000000000000002401111300622755700271670ustar00rootroot00000000000000

Google Cloud Container Builder API . projects . triggers

Instance Methods

create(projectId, body, x__xgafv=None)

Creates a new BuildTrigger.

delete(projectId, triggerId, x__xgafv=None)

Deletes an BuildTrigger by its project ID and trigger ID.

get(projectId, triggerId, x__xgafv=None)

Gets information about a BuildTrigger.

list(projectId, x__xgafv=None)

Lists existing BuildTrigger.

patch(projectId, triggerId, body, x__xgafv=None)

Updates an BuildTrigger by its project ID and trigger ID.

Method Details

create(projectId, body, x__xgafv=None) 
Creates a new BuildTrigger.

This API is experimental.

Args:
  projectId: string, ID of the project for which to configure automatic builds. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Configuration for an automated build in response to source repository
      # changes.
    "description": "A String", # Human-readable description of this trigger.
    "createTime": "A String", # Time when the trigger was created.
        # 
        # @OutputOnly
    "filename": "A String", # Path, from the source root, to a file whose contents is used for the
        # template.
    "disabled": True or False, # If true, the trigger will never result in a build.
    "build": { # A build resource in the Container Builder API. # Contents of the build template.
        #
        # At a high level, a Build describes where to find source code, how to build
        # it (for example, the builder image to run on the source), and what tag to
        # apply to the built image when it is pushed to Google Container Registry.
        #
        # Fields can include the following variables which will be expanded when the
        # build is created:
        #
        # - $PROJECT_ID: the project ID of the build.
        # - $BUILD_ID: the autogenerated ID of the build.
        # - $REPO_NAME: the source repository name specified by RepoSource.
        # - $BRANCH_NAME: the branch name specified by RepoSource.
        # - $TAG_NAME: the tag name specified by RepoSource.
        # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
        #   resolved from the specified branch or tag.
      "status": "A String", # Status of the build.
          # @OutputOnly
      "finishTime": "A String", # Time at which execution of the build was finished.
          # @OutputOnly
      "timeout": "A String", # Amount of time that this build should be allowed to run, to second
          # granularity. If this amount of time elapses, work on the build will cease
          # and the build status will be TIMEOUT.
          #
          # Default time is ten minutes.
      "statusDetail": "A String", # Customer-readable message about the current status.
          # @OutputOnly
      "startTime": "A String", # Time at which execution of the build was started.
          # @OutputOnly
      "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
          # [Bucket Name
          # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
      "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
          # @OutputOnly
        "images": [ # Images that were built as a part of the build.
          { # BuiltImage describes an image built by the pipeline.
            "name": "A String", # Name used to push the container image to Google Container Registry, as
                # presented to `docker push`.
            "digest": "A String", # Docker Registry 2.0 digest.
          },
        ],
        "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
          "A String",
        ],
      },
      "createTime": "A String", # Time at which the build was created.
          # @OutputOnly
      "id": "A String", # Unique identifier of the build.
          # @OutputOnly
      "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
          # service.
        "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
            # Storage.
            # Google Cloud Storage.
          "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
              # omitted, the latest generation will be used.
          "object": "A String", # Google Cloud Storage object containing source.
              #
              # This object must be a gzipped archive file (.tar.gz) containing source to
              # build.
          "bucket": "A String", # Google Cloud Storage bucket containing source (see
              # [Bucket Name
              # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        },
        "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
            # Repository.
          "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
              # the build is assumed.
          "branchName": "A String", # Name of the branch to build.
          "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
          "tagName": "A String", # Name of the tag to build.
          "commitSha": "A String", # Explicit commit SHA to build.
        },
      },
      "steps": [ # Describes the operations to be performed on the workspace.
        { # BuildStep describes a step to perform in the build pipeline.
          "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
              # This build step will not start until all the build steps in wait_for
              # have completed successfully. If wait_for is empty, this build step will
              # start when all previous build steps in the Build.Steps list have completed
              # successfully.
            "A String",
          ],
          "name": "A String", # The name of the container image that will run this particular build step.
              #
              # If the image is already available in the host's
              # Docker daemon's cache, it will be run directly. If not, the host will
              # attempt to pull the image first, using the builder service account's
              # credentials if necessary.
              #
              # The Docker daemon's cache will already have the latest versions of all of
              # the officially supported build steps
              # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
              # will also have cached many of the layers for some popular images, like
              # "ubuntu", "debian", but they will be refreshed at the time you attempt to
              # use them.
              #
              # If you built an image in a previous build step, it will be stored in the
              # host's Docker daemon's cache and is available to use as the name for a
              # later build step.
          "args": [ # A list of arguments that will be presented to the step when it is started.
              #
              # If the image used to run the step's container has an entrypoint, these args
              # will be used as arguments to that entrypoint. If the image does not define
              # an entrypoint, the first element in args will be used as the entrypoint,
              # and the remainder will be used as arguments.
            "A String",
          ],
          "env": [ # A list of environment variable definitions to be used when running a step.
              #
              # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
              # being given the value "VALUE".
            "A String",
          ],
          "id": "A String", # Optional unique identifier for this build step, used in wait_for to
              # reference this build step as a dependency.
          "dir": "A String", # Working directory (relative to project source root) to use when running
              # this operation's container.
        },
      ],
      "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
          # @OutputOnly
          # some source was used for this build.
        "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
            # revisions resolved.
            # Repository.
          "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
              # the build is assumed.
          "branchName": "A String", # Name of the branch to build.
          "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
          "tagName": "A String", # Name of the tag to build.
          "commitSha": "A String", # Explicit commit SHA to build.
        },
        "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
            # source integrity was maintained in the build. Note that FileHashes will
            # only be populated if BuildOptions has requested a SourceProvenanceHash.
            #
            # The keys to this map are file paths used as build source and the values
            # contain the hash values for those files.
            #
            # If the build source came in a single package such as a gzipped tarfile
            # (.tar.gz), the FileHash will be for the single path to that file.
            # @OutputOnly
          "a_key": { # Container message for hashes of byte content of files, used in
              # SourceProvenance messages to verify integrity of source input to the build.
            "fileHash": [ # Collection of file hashes.
              { # Container message for hash values.
                "type": "A String", # The type of hash that was performed.
                "value": "A String", # The hash value.
              },
            ],
          },
        },
        "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
            # generations resolved.
            # Google Cloud Storage.
          "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
              # omitted, the latest generation will be used.
          "object": "A String", # Google Cloud Storage object containing source.
              #
              # This object must be a gzipped archive file (.tar.gz) containing source to
              # build.
          "bucket": "A String", # Google Cloud Storage bucket containing source (see
              # [Bucket Name
              # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        },
      },
      "projectId": "A String", # ID of the project.
          # @OutputOnly.
      "images": [ # A list of images to be pushed upon the successful completion of all build
          # steps.
          #
          # The images will be pushed using the builder
          # service account's credentials.
          #
          # The digests of the pushed images will be stored in the Build resource's
          # results field.
          #
          # If any of the images fail to be pushed, the build is marked FAILURE.
        "A String",
      ],
      "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
        "requestedVerifyOption": "A String", # Requested verifiability options.
        "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
          "A String",
        ],
      },
      "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
          # @OutputOnly
    },
    "id": "A String", # Unique identifier of the trigger.
        # 
        # @OutputOnly
    "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
        # 
        # Branch and tag names in trigger templates are interpreted as regular
        # expressions. Any branch or tag change that matches that regular expression
        # will trigger a build.
        # Repository.
      "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
          # the build is assumed.
      "branchName": "A String", # Name of the branch to build.
      "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      "tagName": "A String", # Name of the tag to build.
      "commitSha": "A String", # Explicit commit SHA to build.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for an automated build in response to source repository
        # changes.
      "description": "A String", # Human-readable description of this trigger.
      "createTime": "A String", # Time when the trigger was created.
          #
          # @OutputOnly
      "filename": "A String", # Path, from the source root, to a file whose contents is used for the
          # template.
      "disabled": True or False, # If true, the trigger will never result in a build.
      "build": { # A build resource in the Container Builder API. # Contents of the build template.
          #
          # At a high level, a Build describes where to find source code, how to build
          # it (for example, the builder image to run on the source), and what tag to
          # apply to the built image when it is pushed to Google Container Registry.
          #
          # Fields can include the following variables which will be expanded when the
          # build is created:
          #
          # - $PROJECT_ID: the project ID of the build.
          # - $BUILD_ID: the autogenerated ID of the build.
          # - $REPO_NAME: the source repository name specified by RepoSource.
          # - $BRANCH_NAME: the branch name specified by RepoSource.
          # - $TAG_NAME: the tag name specified by RepoSource.
          # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
          #   resolved from the specified branch or tag.
        "status": "A String", # Status of the build.
            # @OutputOnly
        "finishTime": "A String", # Time at which execution of the build was finished.
            # @OutputOnly
        "timeout": "A String", # Amount of time that this build should be allowed to run, to second
            # granularity. If this amount of time elapses, work on the build will cease
            # and the build status will be TIMEOUT.
            #
            # Default time is ten minutes.
        "statusDetail": "A String", # Customer-readable message about the current status.
            # @OutputOnly
        "startTime": "A String", # Time at which execution of the build was started.
            # @OutputOnly
        "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
            # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
        "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
            # @OutputOnly
          "images": [ # Images that were built as a part of the build.
            { # BuiltImage describes an image built by the pipeline.
              "name": "A String", # Name used to push the container image to Google Container Registry, as
                  # presented to `docker push`.
              "digest": "A String", # Docker Registry 2.0 digest.
            },
          ],
          "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
            "A String",
          ],
        },
        "createTime": "A String", # Time at which the build was created.
            # @OutputOnly
        "id": "A String", # Unique identifier of the build.
            # @OutputOnly
        "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
            # service.
          "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
              # Storage.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
          "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
        },
        "steps": [ # Describes the operations to be performed on the workspace.
          { # BuildStep describes a step to perform in the build pipeline.
            "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
                # This build step will not start until all the build steps in wait_for
                # have completed successfully. If wait_for is empty, this build step will
                # start when all previous build steps in the Build.Steps list have completed
                # successfully.
              "A String",
            ],
            "name": "A String", # The name of the container image that will run this particular build step.
                #
                # If the image is already available in the host's
                # Docker daemon's cache, it will be run directly. If not, the host will
                # attempt to pull the image first, using the builder service account's
                # credentials if necessary.
                #
                # The Docker daemon's cache will already have the latest versions of all of
                # the officially supported build steps
                # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
                # will also have cached many of the layers for some popular images, like
                # "ubuntu", "debian", but they will be refreshed at the time you attempt to
                # use them.
                #
                # If you built an image in a previous build step, it will be stored in the
                # host's Docker daemon's cache and is available to use as the name for a
                # later build step.
            "args": [ # A list of arguments that will be presented to the step when it is started.
                #
                # If the image used to run the step's container has an entrypoint, these args
                # will be used as arguments to that entrypoint. If the image does not define
                # an entrypoint, the first element in args will be used as the entrypoint,
                # and the remainder will be used as arguments.
              "A String",
            ],
            "env": [ # A list of environment variable definitions to be used when running a step.
                #
                # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
                # being given the value "VALUE".
              "A String",
            ],
            "id": "A String", # Optional unique identifier for this build step, used in wait_for to
                # reference this build step as a dependency.
            "dir": "A String", # Working directory (relative to project source root) to use when running
                # this operation's container.
          },
        ],
        "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
            # @OutputOnly
            # some source was used for this build.
          "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
              # revisions resolved.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
          "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
              # source integrity was maintained in the build. Note that FileHashes will
              # only be populated if BuildOptions has requested a SourceProvenanceHash.
              #
              # The keys to this map are file paths used as build source and the values
              # contain the hash values for those files.
              #
              # If the build source came in a single package such as a gzipped tarfile
              # (.tar.gz), the FileHash will be for the single path to that file.
              # @OutputOnly
            "a_key": { # Container message for hashes of byte content of files, used in
                # SourceProvenance messages to verify integrity of source input to the build.
              "fileHash": [ # Collection of file hashes.
                { # Container message for hash values.
                  "type": "A String", # The type of hash that was performed.
                  "value": "A String", # The hash value.
                },
              ],
            },
          },
          "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
              # generations resolved.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
        },
        "projectId": "A String", # ID of the project.
            # @OutputOnly.
        "images": [ # A list of images to be pushed upon the successful completion of all build
            # steps.
            #
            # The images will be pushed using the builder
            # service account's credentials.
            #
            # The digests of the pushed images will be stored in the Build resource's
            # results field.
            #
            # If any of the images fail to be pushed, the build is marked FAILURE.
          "A String",
        ],
        "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
          "requestedVerifyOption": "A String", # Requested verifiability options.
          "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
            "A String",
          ],
        },
        "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
            # @OutputOnly
      },
      "id": "A String", # Unique identifier of the trigger.
          #
          # @OutputOnly
      "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
          #
          # Branch and tag names in trigger templates are interpreted as regular
          # expressions. Any branch or tag change that matches that regular expression
          # will trigger a build.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
    }
delete(projectId, triggerId, x__xgafv=None) 
Deletes an BuildTrigger by its project ID and trigger ID.

This API is experimental.

Args:
  projectId: string, ID of the project that owns the trigger. (required)
  triggerId: string, ID of the BuildTrigger to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(projectId, triggerId, x__xgafv=None) 
Gets information about a BuildTrigger.

This API is experimental.

Args:
  projectId: string, ID of the project that owns the trigger. (required)
  triggerId: string, ID of the BuildTrigger to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for an automated build in response to source repository
        # changes.
      "description": "A String", # Human-readable description of this trigger.
      "createTime": "A String", # Time when the trigger was created.
          #
          # @OutputOnly
      "filename": "A String", # Path, from the source root, to a file whose contents is used for the
          # template.
      "disabled": True or False, # If true, the trigger will never result in a build.
      "build": { # A build resource in the Container Builder API. # Contents of the build template.
          #
          # At a high level, a Build describes where to find source code, how to build
          # it (for example, the builder image to run on the source), and what tag to
          # apply to the built image when it is pushed to Google Container Registry.
          #
          # Fields can include the following variables which will be expanded when the
          # build is created:
          #
          # - $PROJECT_ID: the project ID of the build.
          # - $BUILD_ID: the autogenerated ID of the build.
          # - $REPO_NAME: the source repository name specified by RepoSource.
          # - $BRANCH_NAME: the branch name specified by RepoSource.
          # - $TAG_NAME: the tag name specified by RepoSource.
          # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
          #   resolved from the specified branch or tag.
        "status": "A String", # Status of the build.
            # @OutputOnly
        "finishTime": "A String", # Time at which execution of the build was finished.
            # @OutputOnly
        "timeout": "A String", # Amount of time that this build should be allowed to run, to second
            # granularity. If this amount of time elapses, work on the build will cease
            # and the build status will be TIMEOUT.
            #
            # Default time is ten minutes.
        "statusDetail": "A String", # Customer-readable message about the current status.
            # @OutputOnly
        "startTime": "A String", # Time at which execution of the build was started.
            # @OutputOnly
        "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
            # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
        "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
            # @OutputOnly
          "images": [ # Images that were built as a part of the build.
            { # BuiltImage describes an image built by the pipeline.
              "name": "A String", # Name used to push the container image to Google Container Registry, as
                  # presented to `docker push`.
              "digest": "A String", # Docker Registry 2.0 digest.
            },
          ],
          "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
            "A String",
          ],
        },
        "createTime": "A String", # Time at which the build was created.
            # @OutputOnly
        "id": "A String", # Unique identifier of the build.
            # @OutputOnly
        "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
            # service.
          "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
              # Storage.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
          "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
        },
        "steps": [ # Describes the operations to be performed on the workspace.
          { # BuildStep describes a step to perform in the build pipeline.
            "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
                # This build step will not start until all the build steps in wait_for
                # have completed successfully. If wait_for is empty, this build step will
                # start when all previous build steps in the Build.Steps list have completed
                # successfully.
              "A String",
            ],
            "name": "A String", # The name of the container image that will run this particular build step.
                #
                # If the image is already available in the host's
                # Docker daemon's cache, it will be run directly. If not, the host will
                # attempt to pull the image first, using the builder service account's
                # credentials if necessary.
                #
                # The Docker daemon's cache will already have the latest versions of all of
                # the officially supported build steps
                # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
                # will also have cached many of the layers for some popular images, like
                # "ubuntu", "debian", but they will be refreshed at the time you attempt to
                # use them.
                #
                # If you built an image in a previous build step, it will be stored in the
                # host's Docker daemon's cache and is available to use as the name for a
                # later build step.
            "args": [ # A list of arguments that will be presented to the step when it is started.
                #
                # If the image used to run the step's container has an entrypoint, these args
                # will be used as arguments to that entrypoint. If the image does not define
                # an entrypoint, the first element in args will be used as the entrypoint,
                # and the remainder will be used as arguments.
              "A String",
            ],
            "env": [ # A list of environment variable definitions to be used when running a step.
                #
                # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
                # being given the value "VALUE".
              "A String",
            ],
            "id": "A String", # Optional unique identifier for this build step, used in wait_for to
                # reference this build step as a dependency.
            "dir": "A String", # Working directory (relative to project source root) to use when running
                # this operation's container.
          },
        ],
        "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
            # @OutputOnly
            # some source was used for this build.
          "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
              # revisions resolved.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
          "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
              # source integrity was maintained in the build. Note that FileHashes will
              # only be populated if BuildOptions has requested a SourceProvenanceHash.
              #
              # The keys to this map are file paths used as build source and the values
              # contain the hash values for those files.
              #
              # If the build source came in a single package such as a gzipped tarfile
              # (.tar.gz), the FileHash will be for the single path to that file.
              # @OutputOnly
            "a_key": { # Container message for hashes of byte content of files, used in
                # SourceProvenance messages to verify integrity of source input to the build.
              "fileHash": [ # Collection of file hashes.
                { # Container message for hash values.
                  "type": "A String", # The type of hash that was performed.
                  "value": "A String", # The hash value.
                },
              ],
            },
          },
          "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
              # generations resolved.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
        },
        "projectId": "A String", # ID of the project.
            # @OutputOnly.
        "images": [ # A list of images to be pushed upon the successful completion of all build
            # steps.
            #
            # The images will be pushed using the builder
            # service account's credentials.
            #
            # The digests of the pushed images will be stored in the Build resource's
            # results field.
            #
            # If any of the images fail to be pushed, the build is marked FAILURE.
          "A String",
        ],
        "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
          "requestedVerifyOption": "A String", # Requested verifiability options.
          "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
            "A String",
          ],
        },
        "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
            # @OutputOnly
      },
      "id": "A String", # Unique identifier of the trigger.
          #
          # @OutputOnly
      "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
          #
          # Branch and tag names in trigger templates are interpreted as regular
          # expressions. Any branch or tag change that matches that regular expression
          # will trigger a build.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
    }
list(projectId, x__xgafv=None) 
Lists existing BuildTrigger.

This API is experimental.

Args:
  projectId: string, ID of the project for which to list BuildTriggers. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response containing existing BuildTriggers.
    "triggers": [ # BuildTriggers for the project, sorted by create_time descending.
      { # Configuration for an automated build in response to source repository
            # changes.
          "description": "A String", # Human-readable description of this trigger.
          "createTime": "A String", # Time when the trigger was created.
              #
              # @OutputOnly
          "filename": "A String", # Path, from the source root, to a file whose contents is used for the
              # template.
          "disabled": True or False, # If true, the trigger will never result in a build.
          "build": { # A build resource in the Container Builder API. # Contents of the build template.
              #
              # At a high level, a Build describes where to find source code, how to build
              # it (for example, the builder image to run on the source), and what tag to
              # apply to the built image when it is pushed to Google Container Registry.
              #
              # Fields can include the following variables which will be expanded when the
              # build is created:
              #
              # - $PROJECT_ID: the project ID of the build.
              # - $BUILD_ID: the autogenerated ID of the build.
              # - $REPO_NAME: the source repository name specified by RepoSource.
              # - $BRANCH_NAME: the branch name specified by RepoSource.
              # - $TAG_NAME: the tag name specified by RepoSource.
              # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
              #   resolved from the specified branch or tag.
            "status": "A String", # Status of the build.
                # @OutputOnly
            "finishTime": "A String", # Time at which execution of the build was finished.
                # @OutputOnly
            "timeout": "A String", # Amount of time that this build should be allowed to run, to second
                # granularity. If this amount of time elapses, work on the build will cease
                # and the build status will be TIMEOUT.
                #
                # Default time is ten minutes.
            "statusDetail": "A String", # Customer-readable message about the current status.
                # @OutputOnly
            "startTime": "A String", # Time at which execution of the build was started.
                # @OutputOnly
            "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
                # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
            "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
                # @OutputOnly
              "images": [ # Images that were built as a part of the build.
                { # BuiltImage describes an image built by the pipeline.
                  "name": "A String", # Name used to push the container image to Google Container Registry, as
                      # presented to `docker push`.
                  "digest": "A String", # Docker Registry 2.0 digest.
                },
              ],
              "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
                "A String",
              ],
            },
            "createTime": "A String", # Time at which the build was created.
                # @OutputOnly
            "id": "A String", # Unique identifier of the build.
                # @OutputOnly
            "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
                # service.
              "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
                  # Storage.
                  # Google Cloud Storage.
                "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                    # omitted, the latest generation will be used.
                "object": "A String", # Google Cloud Storage object containing source.
                    #
                    # This object must be a gzipped archive file (.tar.gz) containing source to
                    # build.
                "bucket": "A String", # Google Cloud Storage bucket containing source (see
                    # [Bucket Name
                    # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
              },
              "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
                  # Repository.
                "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                    # the build is assumed.
                "branchName": "A String", # Name of the branch to build.
                "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
                "tagName": "A String", # Name of the tag to build.
                "commitSha": "A String", # Explicit commit SHA to build.
              },
            },
            "steps": [ # Describes the operations to be performed on the workspace.
              { # BuildStep describes a step to perform in the build pipeline.
                "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
                    # This build step will not start until all the build steps in wait_for
                    # have completed successfully. If wait_for is empty, this build step will
                    # start when all previous build steps in the Build.Steps list have completed
                    # successfully.
                  "A String",
                ],
                "name": "A String", # The name of the container image that will run this particular build step.
                    #
                    # If the image is already available in the host's
                    # Docker daemon's cache, it will be run directly. If not, the host will
                    # attempt to pull the image first, using the builder service account's
                    # credentials if necessary.
                    #
                    # The Docker daemon's cache will already have the latest versions of all of
                    # the officially supported build steps
                    # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
                    # will also have cached many of the layers for some popular images, like
                    # "ubuntu", "debian", but they will be refreshed at the time you attempt to
                    # use them.
                    #
                    # If you built an image in a previous build step, it will be stored in the
                    # host's Docker daemon's cache and is available to use as the name for a
                    # later build step.
                "args": [ # A list of arguments that will be presented to the step when it is started.
                    #
                    # If the image used to run the step's container has an entrypoint, these args
                    # will be used as arguments to that entrypoint. If the image does not define
                    # an entrypoint, the first element in args will be used as the entrypoint,
                    # and the remainder will be used as arguments.
                  "A String",
                ],
                "env": [ # A list of environment variable definitions to be used when running a step.
                    #
                    # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
                    # being given the value "VALUE".
                  "A String",
                ],
                "id": "A String", # Optional unique identifier for this build step, used in wait_for to
                    # reference this build step as a dependency.
                "dir": "A String", # Working directory (relative to project source root) to use when running
                    # this operation's container.
              },
            ],
            "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
                # @OutputOnly
                # some source was used for this build.
              "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
                  # revisions resolved.
                  # Repository.
                "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                    # the build is assumed.
                "branchName": "A String", # Name of the branch to build.
                "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
                "tagName": "A String", # Name of the tag to build.
                "commitSha": "A String", # Explicit commit SHA to build.
              },
              "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
                  # source integrity was maintained in the build. Note that FileHashes will
                  # only be populated if BuildOptions has requested a SourceProvenanceHash.
                  #
                  # The keys to this map are file paths used as build source and the values
                  # contain the hash values for those files.
                  #
                  # If the build source came in a single package such as a gzipped tarfile
                  # (.tar.gz), the FileHash will be for the single path to that file.
                  # @OutputOnly
                "a_key": { # Container message for hashes of byte content of files, used in
                    # SourceProvenance messages to verify integrity of source input to the build.
                  "fileHash": [ # Collection of file hashes.
                    { # Container message for hash values.
                      "type": "A String", # The type of hash that was performed.
                      "value": "A String", # The hash value.
                    },
                  ],
                },
              },
              "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
                  # generations resolved.
                  # Google Cloud Storage.
                "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                    # omitted, the latest generation will be used.
                "object": "A String", # Google Cloud Storage object containing source.
                    #
                    # This object must be a gzipped archive file (.tar.gz) containing source to
                    # build.
                "bucket": "A String", # Google Cloud Storage bucket containing source (see
                    # [Bucket Name
                    # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
              },
            },
            "projectId": "A String", # ID of the project.
                # @OutputOnly.
            "images": [ # A list of images to be pushed upon the successful completion of all build
                # steps.
                #
                # The images will be pushed using the builder
                # service account's credentials.
                #
                # The digests of the pushed images will be stored in the Build resource's
                # results field.
                #
                # If any of the images fail to be pushed, the build is marked FAILURE.
              "A String",
            ],
            "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
              "requestedVerifyOption": "A String", # Requested verifiability options.
              "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
                "A String",
              ],
            },
            "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
                # @OutputOnly
          },
          "id": "A String", # Unique identifier of the trigger.
              #
              # @OutputOnly
          "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
              #
              # Branch and tag names in trigger templates are interpreted as regular
              # expressions. Any branch or tag change that matches that regular expression
              # will trigger a build.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
        },
    ],
  }
patch(projectId, triggerId, body, x__xgafv=None) 
Updates an BuildTrigger by its project ID and trigger ID.

This API is experimental.

Args:
  projectId: string, ID of the project that owns the trigger. (required)
  triggerId: string, ID of the BuildTrigger to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Configuration for an automated build in response to source repository
      # changes.
    "description": "A String", # Human-readable description of this trigger.
    "createTime": "A String", # Time when the trigger was created.
        # 
        # @OutputOnly
    "filename": "A String", # Path, from the source root, to a file whose contents is used for the
        # template.
    "disabled": True or False, # If true, the trigger will never result in a build.
    "build": { # A build resource in the Container Builder API. # Contents of the build template.
        #
        # At a high level, a Build describes where to find source code, how to build
        # it (for example, the builder image to run on the source), and what tag to
        # apply to the built image when it is pushed to Google Container Registry.
        #
        # Fields can include the following variables which will be expanded when the
        # build is created:
        #
        # - $PROJECT_ID: the project ID of the build.
        # - $BUILD_ID: the autogenerated ID of the build.
        # - $REPO_NAME: the source repository name specified by RepoSource.
        # - $BRANCH_NAME: the branch name specified by RepoSource.
        # - $TAG_NAME: the tag name specified by RepoSource.
        # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
        #   resolved from the specified branch or tag.
      "status": "A String", # Status of the build.
          # @OutputOnly
      "finishTime": "A String", # Time at which execution of the build was finished.
          # @OutputOnly
      "timeout": "A String", # Amount of time that this build should be allowed to run, to second
          # granularity. If this amount of time elapses, work on the build will cease
          # and the build status will be TIMEOUT.
          #
          # Default time is ten minutes.
      "statusDetail": "A String", # Customer-readable message about the current status.
          # @OutputOnly
      "startTime": "A String", # Time at which execution of the build was started.
          # @OutputOnly
      "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
          # [Bucket Name
          # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
      "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
          # @OutputOnly
        "images": [ # Images that were built as a part of the build.
          { # BuiltImage describes an image built by the pipeline.
            "name": "A String", # Name used to push the container image to Google Container Registry, as
                # presented to `docker push`.
            "digest": "A String", # Docker Registry 2.0 digest.
          },
        ],
        "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
          "A String",
        ],
      },
      "createTime": "A String", # Time at which the build was created.
          # @OutputOnly
      "id": "A String", # Unique identifier of the build.
          # @OutputOnly
      "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
          # service.
        "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
            # Storage.
            # Google Cloud Storage.
          "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
              # omitted, the latest generation will be used.
          "object": "A String", # Google Cloud Storage object containing source.
              #
              # This object must be a gzipped archive file (.tar.gz) containing source to
              # build.
          "bucket": "A String", # Google Cloud Storage bucket containing source (see
              # [Bucket Name
              # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        },
        "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
            # Repository.
          "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
              # the build is assumed.
          "branchName": "A String", # Name of the branch to build.
          "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
          "tagName": "A String", # Name of the tag to build.
          "commitSha": "A String", # Explicit commit SHA to build.
        },
      },
      "steps": [ # Describes the operations to be performed on the workspace.
        { # BuildStep describes a step to perform in the build pipeline.
          "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
              # This build step will not start until all the build steps in wait_for
              # have completed successfully. If wait_for is empty, this build step will
              # start when all previous build steps in the Build.Steps list have completed
              # successfully.
            "A String",
          ],
          "name": "A String", # The name of the container image that will run this particular build step.
              #
              # If the image is already available in the host's
              # Docker daemon's cache, it will be run directly. If not, the host will
              # attempt to pull the image first, using the builder service account's
              # credentials if necessary.
              #
              # The Docker daemon's cache will already have the latest versions of all of
              # the officially supported build steps
              # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
              # will also have cached many of the layers for some popular images, like
              # "ubuntu", "debian", but they will be refreshed at the time you attempt to
              # use them.
              #
              # If you built an image in a previous build step, it will be stored in the
              # host's Docker daemon's cache and is available to use as the name for a
              # later build step.
          "args": [ # A list of arguments that will be presented to the step when it is started.
              #
              # If the image used to run the step's container has an entrypoint, these args
              # will be used as arguments to that entrypoint. If the image does not define
              # an entrypoint, the first element in args will be used as the entrypoint,
              # and the remainder will be used as arguments.
            "A String",
          ],
          "env": [ # A list of environment variable definitions to be used when running a step.
              #
              # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
              # being given the value "VALUE".
            "A String",
          ],
          "id": "A String", # Optional unique identifier for this build step, used in wait_for to
              # reference this build step as a dependency.
          "dir": "A String", # Working directory (relative to project source root) to use when running
              # this operation's container.
        },
      ],
      "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
          # @OutputOnly
          # some source was used for this build.
        "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
            # revisions resolved.
            # Repository.
          "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
              # the build is assumed.
          "branchName": "A String", # Name of the branch to build.
          "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
          "tagName": "A String", # Name of the tag to build.
          "commitSha": "A String", # Explicit commit SHA to build.
        },
        "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
            # source integrity was maintained in the build. Note that FileHashes will
            # only be populated if BuildOptions has requested a SourceProvenanceHash.
            #
            # The keys to this map are file paths used as build source and the values
            # contain the hash values for those files.
            #
            # If the build source came in a single package such as a gzipped tarfile
            # (.tar.gz), the FileHash will be for the single path to that file.
            # @OutputOnly
          "a_key": { # Container message for hashes of byte content of files, used in
              # SourceProvenance messages to verify integrity of source input to the build.
            "fileHash": [ # Collection of file hashes.
              { # Container message for hash values.
                "type": "A String", # The type of hash that was performed.
                "value": "A String", # The hash value.
              },
            ],
          },
        },
        "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
            # generations resolved.
            # Google Cloud Storage.
          "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
              # omitted, the latest generation will be used.
          "object": "A String", # Google Cloud Storage object containing source.
              #
              # This object must be a gzipped archive file (.tar.gz) containing source to
              # build.
          "bucket": "A String", # Google Cloud Storage bucket containing source (see
              # [Bucket Name
              # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        },
      },
      "projectId": "A String", # ID of the project.
          # @OutputOnly.
      "images": [ # A list of images to be pushed upon the successful completion of all build
          # steps.
          #
          # The images will be pushed using the builder
          # service account's credentials.
          #
          # The digests of the pushed images will be stored in the Build resource's
          # results field.
          #
          # If any of the images fail to be pushed, the build is marked FAILURE.
        "A String",
      ],
      "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
        "requestedVerifyOption": "A String", # Requested verifiability options.
        "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
          "A String",
        ],
      },
      "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
          # @OutputOnly
    },
    "id": "A String", # Unique identifier of the trigger.
        # 
        # @OutputOnly
    "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
        # 
        # Branch and tag names in trigger templates are interpreted as regular
        # expressions. Any branch or tag change that matches that regular expression
        # will trigger a build.
        # Repository.
      "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
          # the build is assumed.
      "branchName": "A String", # Name of the branch to build.
      "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      "tagName": "A String", # Name of the tag to build.
      "commitSha": "A String", # Explicit commit SHA to build.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for an automated build in response to source repository
        # changes.
      "description": "A String", # Human-readable description of this trigger.
      "createTime": "A String", # Time when the trigger was created.
          #
          # @OutputOnly
      "filename": "A String", # Path, from the source root, to a file whose contents is used for the
          # template.
      "disabled": True or False, # If true, the trigger will never result in a build.
      "build": { # A build resource in the Container Builder API. # Contents of the build template.
          #
          # At a high level, a Build describes where to find source code, how to build
          # it (for example, the builder image to run on the source), and what tag to
          # apply to the built image when it is pushed to Google Container Registry.
          #
          # Fields can include the following variables which will be expanded when the
          # build is created:
          #
          # - $PROJECT_ID: the project ID of the build.
          # - $BUILD_ID: the autogenerated ID of the build.
          # - $REPO_NAME: the source repository name specified by RepoSource.
          # - $BRANCH_NAME: the branch name specified by RepoSource.
          # - $TAG_NAME: the tag name specified by RepoSource.
          # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
          #   resolved from the specified branch or tag.
        "status": "A String", # Status of the build.
            # @OutputOnly
        "finishTime": "A String", # Time at which execution of the build was finished.
            # @OutputOnly
        "timeout": "A String", # Amount of time that this build should be allowed to run, to second
            # granularity. If this amount of time elapses, work on the build will cease
            # and the build status will be TIMEOUT.
            #
            # Default time is ten minutes.
        "statusDetail": "A String", # Customer-readable message about the current status.
            # @OutputOnly
        "startTime": "A String", # Time at which execution of the build was started.
            # @OutputOnly
        "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
            # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
        "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
            # @OutputOnly
          "images": [ # Images that were built as a part of the build.
            { # BuiltImage describes an image built by the pipeline.
              "name": "A String", # Name used to push the container image to Google Container Registry, as
                  # presented to `docker push`.
              "digest": "A String", # Docker Registry 2.0 digest.
            },
          ],
          "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
            "A String",
          ],
        },
        "createTime": "A String", # Time at which the build was created.
            # @OutputOnly
        "id": "A String", # Unique identifier of the build.
            # @OutputOnly
        "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
            # service.
          "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
              # Storage.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
          "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
        },
        "steps": [ # Describes the operations to be performed on the workspace.
          { # BuildStep describes a step to perform in the build pipeline.
            "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
                # This build step will not start until all the build steps in wait_for
                # have completed successfully. If wait_for is empty, this build step will
                # start when all previous build steps in the Build.Steps list have completed
                # successfully.
              "A String",
            ],
            "name": "A String", # The name of the container image that will run this particular build step.
                #
                # If the image is already available in the host's
                # Docker daemon's cache, it will be run directly. If not, the host will
                # attempt to pull the image first, using the builder service account's
                # credentials if necessary.
                #
                # The Docker daemon's cache will already have the latest versions of all of
                # the officially supported build steps
                # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
                # will also have cached many of the layers for some popular images, like
                # "ubuntu", "debian", but they will be refreshed at the time you attempt to
                # use them.
                #
                # If you built an image in a previous build step, it will be stored in the
                # host's Docker daemon's cache and is available to use as the name for a
                # later build step.
            "args": [ # A list of arguments that will be presented to the step when it is started.
                #
                # If the image used to run the step's container has an entrypoint, these args
                # will be used as arguments to that entrypoint. If the image does not define
                # an entrypoint, the first element in args will be used as the entrypoint,
                # and the remainder will be used as arguments.
              "A String",
            ],
            "env": [ # A list of environment variable definitions to be used when running a step.
                #
                # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
                # being given the value "VALUE".
              "A String",
            ],
            "id": "A String", # Optional unique identifier for this build step, used in wait_for to
                # reference this build step as a dependency.
            "dir": "A String", # Working directory (relative to project source root) to use when running
                # this operation's container.
          },
        ],
        "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
            # @OutputOnly
            # some source was used for this build.
          "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
              # revisions resolved.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
            "tagName": "A String", # Name of the tag to build.
            "commitSha": "A String", # Explicit commit SHA to build.
          },
          "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
              # source integrity was maintained in the build. Note that FileHashes will
              # only be populated if BuildOptions has requested a SourceProvenanceHash.
              #
              # The keys to this map are file paths used as build source and the values
              # contain the hash values for those files.
              #
              # If the build source came in a single package such as a gzipped tarfile
              # (.tar.gz), the FileHash will be for the single path to that file.
              # @OutputOnly
            "a_key": { # Container message for hashes of byte content of files, used in
                # SourceProvenance messages to verify integrity of source input to the build.
              "fileHash": [ # Collection of file hashes.
                { # Container message for hash values.
                  "type": "A String", # The type of hash that was performed.
                  "value": "A String", # The hash value.
                },
              ],
            },
          },
          "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
              # generations resolved.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
        },
        "projectId": "A String", # ID of the project.
            # @OutputOnly.
        "images": [ # A list of images to be pushed upon the successful completion of all build
            # steps.
            #
            # The images will be pushed using the builder
            # service account's credentials.
            #
            # The digests of the pushed images will be stored in the Build resource's
            # results field.
            #
            # If any of the images fail to be pushed, the build is marked FAILURE.
          "A String",
        ],
        "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
          "requestedVerifyOption": "A String", # Requested verifiability options.
          "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
            "A String",
          ],
        },
        "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
            # @OutputOnly
      },
      "id": "A String", # Unique identifier of the trigger.
          #
          # @OutputOnly
      "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
          #
          # Branch and tag names in trigger templates are interpreted as regular
          # expressions. Any branch or tag change that matches that regular expression
          # will trigger a build.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
        "tagName": "A String", # Name of the tag to build.
        "commitSha": "A String", # Explicit commit SHA to build.
      },
    }
google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html000066400000000000000000001635061300622755700326470ustar00rootroot00000000000000

Stackdriver Debugger API . controller . debuggees . breakpoints

Instance Methods

list(debuggeeId, successOnTimeout=None, waitToken=None, x__xgafv=None)

Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

update(debuggeeId, id, body, x__xgafv=None)

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expression` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Method Details

list(debuggeeId, successOnTimeout=None, waitToken=None, x__xgafv=None) 
Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

Args:
  debuggeeId: string, Identifies the debuggee. (required)
  successOnTimeout: boolean, If set to `true`, returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired (recommended). If set to `false`, returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired (deprecated).
  waitToken: string, A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired. The value should be set from the last returned response.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for listing active breakpoints.
    "waitExpired": True or False, # The `wait_expired` field is set to true by the server when the request times out and the field `success_on_timeout` is set to true.
    "nextWaitToken": "A String", # A wait token that can be used in the next method call to block until the list of breakpoints changes.
    "breakpoints": [ # List of all active breakpoints. The fields `id` and `location` are guaranteed to be set on each breakpoint.
      { # Represents the breakpoint specification, status and results.
        "userEmail": "A String", # E-mail address of the user that created this breakpoint
        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
          "isError": True or False, # Distinguishes errors from informational messages.
          "refersTo": "A String", # Reference to which the message applies.
          "description": { # Represents a message with parameters. # Status message text.
            "parameters": [ # Optional parameters to be embedded into the message.
              "A String",
            ],
            "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
          },
        },
        "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
        "variableTable": [ # The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
              "isError": True or False, # Distinguishes errors from informational messages.
              "refersTo": "A String", # Reference to which the message applies.
              "description": { # Represents a message with parameters. # Status message text.
                "parameters": [ # Optional parameters to be embedded into the message.
                  "A String",
                ],
                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
              },
            },
            "name": "A String", # Name of the variable, if any.
            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
            "value": "A String", # Simple value of the variable.
            "members": [ # Members contained or pointed to by the variable.
              # Object with schema name: Variable
            ],
            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
          },
        ],
        "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
        "labels": { # A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
          "a_key": "A String",
        },
        "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
        "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
        "stackFrames": [ # The stack at breakpoint time.
          { # Represents a stack frame context.
            "function": "A String", # Demangled function name at the call site.
            "location": { # Represents a location in the source code. # Source location of the call site.
              "path": "A String", # Path to the source file within the source context of the target binary.
              "line": 42, # Line inside the file. The first line in the file has the value `1`.
            },
            "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                  "isError": True or False, # Distinguishes errors from informational messages.
                  "refersTo": "A String", # Reference to which the message applies.
                  "description": { # Represents a message with parameters. # Status message text.
                    "parameters": [ # Optional parameters to be embedded into the message.
                      "A String",
                    ],
                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                  },
                },
                "name": "A String", # Name of the variable, if any.
                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
                "value": "A String", # Simple value of the variable.
                "members": [ # Members contained or pointed to by the variable.
                  # Object with schema name: Variable
                ],
                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
              },
            ],
            "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                  "isError": True or False, # Distinguishes errors from informational messages.
                  "refersTo": "A String", # Reference to which the message applies.
                  "description": { # Represents a message with parameters. # Status message text.
                    "parameters": [ # Optional parameters to be embedded into the message.
                      "A String",
                    ],
                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                  },
                },
                "name": "A String", # Name of the variable, if any.
                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
                "value": "A String", # Simple value of the variable.
                "members": [ # Members contained or pointed to by the variable.
                  # Object with schema name: Variable
                ],
                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
              },
            ],
          },
        ],
        "location": { # Represents a location in the source code. # Breakpoint source location.
          "path": "A String", # Path to the source file within the source context of the target binary.
          "line": 42, # Line inside the file. The first line in the file has the value `1`.
        },
        "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
        "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
          "A String",
        ],
        "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
        "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
              "isError": True or False, # Distinguishes errors from informational messages.
              "refersTo": "A String", # Reference to which the message applies.
              "description": { # Represents a message with parameters. # Status message text.
                "parameters": [ # Optional parameters to be embedded into the message.
                  "A String",
                ],
                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
              },
            },
            "name": "A String", # Name of the variable, if any.
            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
            "value": "A String", # Simple value of the variable.
            "members": [ # Members contained or pointed to by the variable.
              # Object with schema name: Variable
            ],
            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
          },
        ],
        "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
        "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
      },
    ],
  }
update(debuggeeId, id, body, x__xgafv=None) 
Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expression` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Args:
  debuggeeId: string, Identifies the debuggee being debugged. (required)
  id: string, Breakpoint identifier, unique in the scope of the debuggee. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to update an active breakpoint.
    "breakpoint": { # Represents the breakpoint specification, status and results. # Updated breakpoint information. The field 'id' must be set.
      "userEmail": "A String", # E-mail address of the user that created this breakpoint
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
      "variableTable": [ # The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
      "labels": { # A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
        "a_key": "A String",
      },
      "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
      "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
      "stackFrames": [ # The stack at breakpoint time.
        { # Represents a stack frame context.
          "function": "A String", # Demangled function name at the call site.
          "location": { # Represents a location in the source code. # Source location of the call site.
            "path": "A String", # Path to the source file within the source context of the target binary.
            "line": 42, # Line inside the file. The first line in the file has the value `1`.
          },
          "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                "isError": True or False, # Distinguishes errors from informational messages.
                "refersTo": "A String", # Reference to which the message applies.
                "description": { # Represents a message with parameters. # Status message text.
                  "parameters": [ # Optional parameters to be embedded into the message.
                    "A String",
                  ],
                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                },
              },
              "name": "A String", # Name of the variable, if any.
              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
              "value": "A String", # Simple value of the variable.
              "members": [ # Members contained or pointed to by the variable.
                # Object with schema name: Variable
              ],
              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
            },
          ],
          "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                "isError": True or False, # Distinguishes errors from informational messages.
                "refersTo": "A String", # Reference to which the message applies.
                "description": { # Represents a message with parameters. # Status message text.
                  "parameters": [ # Optional parameters to be embedded into the message.
                    "A String",
                  ],
                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                },
              },
              "name": "A String", # Name of the variable, if any.
              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
              "value": "A String", # Simple value of the variable.
              "members": [ # Members contained or pointed to by the variable.
                # Object with schema name: Variable
              ],
              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
            },
          ],
        },
      ],
      "location": { # Represents a location in the source code. # Breakpoint source location.
        "path": "A String", # Path to the source file within the source context of the target binary.
        "line": 42, # Line inside the file. The first line in the file has the value `1`.
      },
      "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
      "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
        "A String",
      ],
      "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
      "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
      "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for updating an active breakpoint. The message is defined to allow future extensions.
  }
google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.controller.debuggees.html000066400000000000000000000616561300622755700303320ustar00rootroot00000000000000

Stackdriver Debugger API . controller . debuggees

Instance Methods

breakpoints()

Returns the breakpoints Resource.

register(body, x__xgafv=None)

Registers the debuggee with the controller service. All agents attached to the same application should call this method with the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have `is_disabled` set to `true`.

Method Details

register(body, x__xgafv=None) 
Registers the debuggee with the controller service. All agents attached to the same application should call this method with the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have `is_disabled` set to `true`.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to register a debuggee.
    "debuggee": { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering. # Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
      "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
      "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
        "a_key": "A String",
      },
      "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
      "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
      "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.
        { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
          "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
            "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
            "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace.
              "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
                "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                  "projectId": "A String", # The ID of the project.
                  "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                },
                "uid": "A String", # A server-assigned, globally unique identifier.
              },
              "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
            },
          },
          "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo.
            "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
              "kind": "A String", # The alias kind.
              "name": "A String", # The alias name.
            },
            "revisionId": "A String", # A revision ID.
            "aliasName": "A String", # The name of an alias (branch, tag, etc.).
            "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
              "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                "projectId": "A String", # The ID of the project.
                "repoName": "A String", # The name of the repo. Leave empty for the default repo.
              },
              "uid": "A String", # A server-assigned, globally unique identifier.
            },
          },
          "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub).
            "url": "A String", # Git repository URL.
            "revisionId": "A String", # Git commit hash. required.
          },
          "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
            "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
              "kind": "A String", # The alias kind.
              "name": "A String", # The alias name.
            },
            "revisionId": "A String", # A revision (commit) ID.
            "hostUri": "A String", # The URI of a running Gerrit instance.
            "aliasName": "A String", # The name of an alias (branch, tag, etc.).
            "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
          },
        },
      ],
      "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`.
        { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
          "labels": { # Labels with user defined metadata.
            "a_key": "A String",
          },
          "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # Any source context.
            "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
              "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
              "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace.
                "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
                  "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                    "projectId": "A String", # The ID of the project.
                    "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                  },
                  "uid": "A String", # A server-assigned, globally unique identifier.
                },
                "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
              },
            },
            "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo.
              "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                "kind": "A String", # The alias kind.
                "name": "A String", # The alias name.
              },
              "revisionId": "A String", # A revision ID.
              "aliasName": "A String", # The name of an alias (branch, tag, etc.).
              "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
                "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                  "projectId": "A String", # The ID of the project.
                  "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                },
                "uid": "A String", # A server-assigned, globally unique identifier.
              },
            },
            "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub).
              "url": "A String", # Git repository URL.
              "revisionId": "A String", # Git commit hash. required.
            },
            "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
              "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                "kind": "A String", # The alias kind.
                "name": "A String", # The alias name.
              },
              "revisionId": "A String", # A revision (commit) ID.
              "hostUri": "A String", # The URI of a running Gerrit instance.
              "aliasName": "A String", # The name of an alias (branch, tag, etc.).
              "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
            },
          },
        },
      ],
      "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`).
      "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service.
      "id": "A String", # Unique identifier for the debuggee generated by the controller service.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for registering a debuggee.
    "debuggee": { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering. # Debuggee resource. The field `id` is guranteed to be set (in addition to the echoed fields).
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
      "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
      "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
        "a_key": "A String",
      },
      "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
      "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
      "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.
        { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
          "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
            "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
            "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace.
              "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
                "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                  "projectId": "A String", # The ID of the project.
                  "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                },
                "uid": "A String", # A server-assigned, globally unique identifier.
              },
              "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
            },
          },
          "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo.
            "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
              "kind": "A String", # The alias kind.
              "name": "A String", # The alias name.
            },
            "revisionId": "A String", # A revision ID.
            "aliasName": "A String", # The name of an alias (branch, tag, etc.).
            "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
              "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                "projectId": "A String", # The ID of the project.
                "repoName": "A String", # The name of the repo. Leave empty for the default repo.
              },
              "uid": "A String", # A server-assigned, globally unique identifier.
            },
          },
          "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub).
            "url": "A String", # Git repository URL.
            "revisionId": "A String", # Git commit hash. required.
          },
          "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
            "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
              "kind": "A String", # The alias kind.
              "name": "A String", # The alias name.
            },
            "revisionId": "A String", # A revision (commit) ID.
            "hostUri": "A String", # The URI of a running Gerrit instance.
            "aliasName": "A String", # The name of an alias (branch, tag, etc.).
            "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
          },
        },
      ],
      "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`.
        { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
          "labels": { # Labels with user defined metadata.
            "a_key": "A String",
          },
          "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # Any source context.
            "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
              "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
              "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace.
                "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
                  "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                    "projectId": "A String", # The ID of the project.
                    "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                  },
                  "uid": "A String", # A server-assigned, globally unique identifier.
                },
                "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
              },
            },
            "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo.
              "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                "kind": "A String", # The alias kind.
                "name": "A String", # The alias name.
              },
              "revisionId": "A String", # A revision ID.
              "aliasName": "A String", # The name of an alias (branch, tag, etc.).
              "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
                "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                  "projectId": "A String", # The ID of the project.
                  "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                },
                "uid": "A String", # A server-assigned, globally unique identifier.
              },
            },
            "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub).
              "url": "A String", # Git repository URL.
              "revisionId": "A String", # Git commit hash. required.
            },
            "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
              "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                "kind": "A String", # The alias kind.
                "name": "A String", # The alias name.
              },
              "revisionId": "A String", # A revision (commit) ID.
              "hostUri": "A String", # The URI of a running Gerrit instance.
              "aliasName": "A String", # The name of an alias (branch, tag, etc.).
              "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
            },
          },
        },
      ],
      "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`).
      "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service.
      "id": "A String", # Unique identifier for the debuggee generated by the controller service.
    },
  }
google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.controller.html000066400000000000000000000023761300622755700263730ustar00rootroot00000000000000

Stackdriver Debugger API . controller

Instance Methods

debuggees()

Returns the debuggees Resource.

google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html000066400000000000000000003331431300622755700322440ustar00rootroot00000000000000

Stackdriver Debugger API . debugger . debuggees . breakpoints

Instance Methods

delete(debuggeeId, breakpointId, clientVersion=None, x__xgafv=None)

Deletes the breakpoint from the debuggee.

get(debuggeeId, breakpointId, clientVersion=None, x__xgafv=None)

Gets breakpoint information.

list(debuggeeId, includeAllUsers=None, includeInactive=None, x__xgafv=None, clientVersion=None, stripResults=None, action_value=None, waitToken=None)

Lists all breakpoints for the debuggee.

set(debuggeeId, body, clientVersion=None, x__xgafv=None)

Sets the breakpoint to the debuggee.

Method Details

delete(debuggeeId, breakpointId, clientVersion=None, x__xgafv=None) 
Deletes the breakpoint from the debuggee.

Args:
  debuggeeId: string, ID of the debuggee whose breakpoint to delete. (required)
  breakpointId: string, ID of the breakpoint to delete. (required)
  clientVersion: string, The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(debuggeeId, breakpointId, clientVersion=None, x__xgafv=None) 
Gets breakpoint information.

Args:
  debuggeeId: string, ID of the debuggee whose breakpoint to get. (required)
  breakpointId: string, ID of the breakpoint to get. (required)
  clientVersion: string, The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for getting breakpoint information.
    "breakpoint": { # Represents the breakpoint specification, status and results. # Complete breakpoint state. The fields `id` and `location` are guaranteed to be set.
      "userEmail": "A String", # E-mail address of the user that created this breakpoint
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
      "variableTable": [ # The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
      "labels": { # A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
        "a_key": "A String",
      },
      "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
      "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
      "stackFrames": [ # The stack at breakpoint time.
        { # Represents a stack frame context.
          "function": "A String", # Demangled function name at the call site.
          "location": { # Represents a location in the source code. # Source location of the call site.
            "path": "A String", # Path to the source file within the source context of the target binary.
            "line": 42, # Line inside the file. The first line in the file has the value `1`.
          },
          "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                "isError": True or False, # Distinguishes errors from informational messages.
                "refersTo": "A String", # Reference to which the message applies.
                "description": { # Represents a message with parameters. # Status message text.
                  "parameters": [ # Optional parameters to be embedded into the message.
                    "A String",
                  ],
                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                },
              },
              "name": "A String", # Name of the variable, if any.
              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
              "value": "A String", # Simple value of the variable.
              "members": [ # Members contained or pointed to by the variable.
                # Object with schema name: Variable
              ],
              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
            },
          ],
          "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                "isError": True or False, # Distinguishes errors from informational messages.
                "refersTo": "A String", # Reference to which the message applies.
                "description": { # Represents a message with parameters. # Status message text.
                  "parameters": [ # Optional parameters to be embedded into the message.
                    "A String",
                  ],
                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                },
              },
              "name": "A String", # Name of the variable, if any.
              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
              "value": "A String", # Simple value of the variable.
              "members": [ # Members contained or pointed to by the variable.
                # Object with schema name: Variable
              ],
              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
            },
          ],
        },
      ],
      "location": { # Represents a location in the source code. # Breakpoint source location.
        "path": "A String", # Path to the source file within the source context of the target binary.
        "line": 42, # Line inside the file. The first line in the file has the value `1`.
      },
      "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
      "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
        "A String",
      ],
      "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
      "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
      "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
    },
  }
list(debuggeeId, includeAllUsers=None, includeInactive=None, x__xgafv=None, clientVersion=None, stripResults=None, action_value=None, waitToken=None) 
Lists all breakpoints for the debuggee.

Args:
  debuggeeId: string, ID of the debuggee whose breakpoints to list. (required)
  includeAllUsers: boolean, When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.
  includeInactive: boolean, When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.
  x__xgafv: string, V1 error format.
  clientVersion: string, The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
  stripResults: boolean, When set to `true`, the response breakpoints are stripped of the results fields: `stack_frames`, `evaluated_expressions` and `variable_table`.
  action_value: string, Only breakpoints with the specified action will pass the filter.
  waitToken: string, A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be called again with the same `wait_token`.

Returns:
  An object of the form:

    { # Response for listing breakpoints.
    "nextWaitToken": "A String", # A wait token that can be used in the next call to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes.
    "breakpoints": [ # List of all breakpoints with complete state. The fields `id` and `location` are guaranteed to be set on each breakpoint.
      { # Represents the breakpoint specification, status and results.
        "userEmail": "A String", # E-mail address of the user that created this breakpoint
        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
          "isError": True or False, # Distinguishes errors from informational messages.
          "refersTo": "A String", # Reference to which the message applies.
          "description": { # Represents a message with parameters. # Status message text.
            "parameters": [ # Optional parameters to be embedded into the message.
              "A String",
            ],
            "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
          },
        },
        "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
        "variableTable": [ # The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
              "isError": True or False, # Distinguishes errors from informational messages.
              "refersTo": "A String", # Reference to which the message applies.
              "description": { # Represents a message with parameters. # Status message text.
                "parameters": [ # Optional parameters to be embedded into the message.
                  "A String",
                ],
                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
              },
            },
            "name": "A String", # Name of the variable, if any.
            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
            "value": "A String", # Simple value of the variable.
            "members": [ # Members contained or pointed to by the variable.
              # Object with schema name: Variable
            ],
            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
          },
        ],
        "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
        "labels": { # A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
          "a_key": "A String",
        },
        "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
        "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
        "stackFrames": [ # The stack at breakpoint time.
          { # Represents a stack frame context.
            "function": "A String", # Demangled function name at the call site.
            "location": { # Represents a location in the source code. # Source location of the call site.
              "path": "A String", # Path to the source file within the source context of the target binary.
              "line": 42, # Line inside the file. The first line in the file has the value `1`.
            },
            "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                  "isError": True or False, # Distinguishes errors from informational messages.
                  "refersTo": "A String", # Reference to which the message applies.
                  "description": { # Represents a message with parameters. # Status message text.
                    "parameters": [ # Optional parameters to be embedded into the message.
                      "A String",
                    ],
                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                  },
                },
                "name": "A String", # Name of the variable, if any.
                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
                "value": "A String", # Simple value of the variable.
                "members": [ # Members contained or pointed to by the variable.
                  # Object with schema name: Variable
                ],
                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
              },
            ],
            "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                  "isError": True or False, # Distinguishes errors from informational messages.
                  "refersTo": "A String", # Reference to which the message applies.
                  "description": { # Represents a message with parameters. # Status message text.
                    "parameters": [ # Optional parameters to be embedded into the message.
                      "A String",
                    ],
                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                  },
                },
                "name": "A String", # Name of the variable, if any.
                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
                "value": "A String", # Simple value of the variable.
                "members": [ # Members contained or pointed to by the variable.
                  # Object with schema name: Variable
                ],
                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
              },
            ],
          },
        ],
        "location": { # Represents a location in the source code. # Breakpoint source location.
          "path": "A String", # Path to the source file within the source context of the target binary.
          "line": 42, # Line inside the file. The first line in the file has the value `1`.
        },
        "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
        "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
          "A String",
        ],
        "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
        "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
              "isError": True or False, # Distinguishes errors from informational messages.
              "refersTo": "A String", # Reference to which the message applies.
              "description": { # Represents a message with parameters. # Status message text.
                "parameters": [ # Optional parameters to be embedded into the message.
                  "A String",
                ],
                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
              },
            },
            "name": "A String", # Name of the variable, if any.
            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
            "value": "A String", # Simple value of the variable.
            "members": [ # Members contained or pointed to by the variable.
              # Object with schema name: Variable
            ],
            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
          },
        ],
        "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
        "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
      },
    ],
  }
set(debuggeeId, body, clientVersion=None, x__xgafv=None) 
Sets the breakpoint to the debuggee.

Args:
  debuggeeId: string, ID of the debuggee where the breakpoint is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents the breakpoint specification, status and results.
  "userEmail": "A String", # E-mail address of the user that created this breakpoint
  "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
    "isError": True or False, # Distinguishes errors from informational messages.
    "refersTo": "A String", # Reference to which the message applies.
    "description": { # Represents a message with parameters. # Status message text.
      "parameters": [ # Optional parameters to be embedded into the message.
        "A String",
      ],
      "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
    },
  },
  "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
  "variableTable": [ # The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
    { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
        # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "name": "A String", # Name of the variable, if any.
      "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
      "value": "A String", # Simple value of the variable.
      "members": [ # Members contained or pointed to by the variable.
        # Object with schema name: Variable
      ],
      "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
    },
  ],
  "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
  "labels": { # A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
    "a_key": "A String",
  },
  "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
  "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
  "stackFrames": [ # The stack at breakpoint time.
    { # Represents a stack frame context.
      "function": "A String", # Demangled function name at the call site.
      "location": { # Represents a location in the source code. # Source location of the call site.
        "path": "A String", # Path to the source file within the source context of the target binary.
        "line": 42, # Line inside the file. The first line in the file has the value `1`.
      },
      "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
    },
  ],
  "location": { # Represents a location in the source code. # Breakpoint source location.
    "path": "A String", # Path to the source file within the source context of the target binary.
    "line": 42, # Line inside the file. The first line in the file has the value `1`.
  },
  "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
  "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
    "A String",
  ],
  "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
  "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
    { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
        # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "name": "A String", # Name of the variable, if any.
      "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
      "value": "A String", # Simple value of the variable.
      "members": [ # Members contained or pointed to by the variable.
        # Object with schema name: Variable
      ],
      "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
    },
  ],
  "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
  "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
}

  clientVersion: string, The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for setting a breakpoint.
    "breakpoint": { # Represents the breakpoint specification, status and results. # Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds).
      "userEmail": "A String", # E-mail address of the user that created this breakpoint
      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
        "isError": True or False, # Distinguishes errors from informational messages.
        "refersTo": "A String", # Reference to which the message applies.
        "description": { # Represents a message with parameters. # Status message text.
          "parameters": [ # Optional parameters to be embedded into the message.
            "A String",
          ],
          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
        },
      },
      "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
      "variableTable": [ # The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
      "labels": { # A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
        "a_key": "A String",
      },
      "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
      "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
      "stackFrames": [ # The stack at breakpoint time.
        { # Represents a stack frame context.
          "function": "A String", # Demangled function name at the call site.
          "location": { # Represents a location in the source code. # Source location of the call site.
            "path": "A String", # Path to the source file within the source context of the target binary.
            "line": 42, # Line inside the file. The first line in the file has the value `1`.
          },
          "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                "isError": True or False, # Distinguishes errors from informational messages.
                "refersTo": "A String", # Reference to which the message applies.
                "description": { # Represents a message with parameters. # Status message text.
                  "parameters": [ # Optional parameters to be embedded into the message.
                    "A String",
                  ],
                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                },
              },
              "name": "A String", # Name of the variable, if any.
              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
              "value": "A String", # Simple value of the variable.
              "members": [ # Members contained or pointed to by the variable.
                # Object with schema name: Variable
              ],
              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
            },
          ],
          "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                "isError": True or False, # Distinguishes errors from informational messages.
                "refersTo": "A String", # Reference to which the message applies.
                "description": { # Represents a message with parameters. # Status message text.
                  "parameters": [ # Optional parameters to be embedded into the message.
                    "A String",
                  ],
                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                },
              },
              "name": "A String", # Name of the variable, if any.
              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
              "value": "A String", # Simple value of the variable.
              "members": [ # Members contained or pointed to by the variable.
                # Object with schema name: Variable
              ],
              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
            },
          ],
        },
      ],
      "location": { # Represents a location in the source code. # Breakpoint source location.
        "path": "A String", # Path to the source file within the source context of the target binary.
        "line": 42, # Line inside the file. The first line in the file has the value `1`.
      },
      "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
      "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
        "A String",
      ],
      "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
      "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
            "isError": True or False, # Distinguishes errors from informational messages.
            "refersTo": "A String", # Reference to which the message applies.
            "description": { # Represents a message with parameters. # Status message text.
              "parameters": [ # Optional parameters to be embedded into the message.
                "A String",
              ],
              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
            },
          },
          "name": "A String", # Name of the variable, if any.
          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
          "value": "A String", # Simple value of the variable.
          "members": [ # Members contained or pointed to by the variable.
            # Object with schema name: Variable
          ],
          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
        },
      ],
      "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
      "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
    },
  }
google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.debugger.debuggees.html000066400000000000000000000333151300622755700277220ustar00rootroot00000000000000

Stackdriver Debugger API . debugger . debuggees

Instance Methods

breakpoints()

Returns the breakpoints Resource.

list(clientVersion=None, includeInactive=None, project=None, x__xgafv=None)

Lists all the debuggees that the user can set breakpoints to.

Method Details

list(clientVersion=None, includeInactive=None, project=None, x__xgafv=None) 
Lists all the debuggees that the user can set breakpoints to.

Args:
  clientVersion: string, The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
  includeInactive: boolean, When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
  project: string, Project number of a Google Cloud project whose debuggees to list.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for listing debuggees.
    "debuggees": [ # List of debuggees accessible to the calling user. Note that the `description` field is the only human readable field that should be displayed to the user. The fields `debuggee.id` and `description` fields are guaranteed to be set on each debuggee.
      { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering.
        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
          "isError": True or False, # Distinguishes errors from informational messages.
          "refersTo": "A String", # Reference to which the message applies.
          "description": { # Represents a message with parameters. # Status message text.
            "parameters": [ # Optional parameters to be embedded into the message.
              "A String",
            ],
            "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
          },
        },
        "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
        "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
        "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
          "a_key": "A String",
        },
        "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
        "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
        "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.
          { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
            "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
              "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
              "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace.
                "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
                  "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                    "projectId": "A String", # The ID of the project.
                    "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                  },
                  "uid": "A String", # A server-assigned, globally unique identifier.
                },
                "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
              },
            },
            "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo.
              "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                "kind": "A String", # The alias kind.
                "name": "A String", # The alias name.
              },
              "revisionId": "A String", # A revision ID.
              "aliasName": "A String", # The name of an alias (branch, tag, etc.).
              "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
                "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                  "projectId": "A String", # The ID of the project.
                  "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                },
                "uid": "A String", # A server-assigned, globally unique identifier.
              },
            },
            "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub).
              "url": "A String", # Git repository URL.
              "revisionId": "A String", # Git commit hash. required.
            },
            "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
              "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                "kind": "A String", # The alias kind.
                "name": "A String", # The alias name.
              },
              "revisionId": "A String", # A revision (commit) ID.
              "hostUri": "A String", # The URI of a running Gerrit instance.
              "aliasName": "A String", # The name of an alias (branch, tag, etc.).
              "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
            },
          },
        ],
        "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`.
          { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
            "labels": { # Labels with user defined metadata.
              "a_key": "A String",
            },
            "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # Any source context.
              "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
                "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
                "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace.
                  "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
                    "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                      "projectId": "A String", # The ID of the project.
                      "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                    },
                    "uid": "A String", # A server-assigned, globally unique identifier.
                  },
                  "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
                },
              },
              "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo.
                "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                  "kind": "A String", # The alias kind.
                  "name": "A String", # The alias name.
                },
                "revisionId": "A String", # A revision ID.
                "aliasName": "A String", # The name of an alias (branch, tag, etc.).
                "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
                  "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
                    "projectId": "A String", # The ID of the project.
                    "repoName": "A String", # The name of the repo. Leave empty for the default repo.
                  },
                  "uid": "A String", # A server-assigned, globally unique identifier.
                },
              },
              "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub).
                "url": "A String", # Git repository URL.
                "revisionId": "A String", # Git commit hash. required.
              },
              "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
                "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
                  "kind": "A String", # The alias kind.
                  "name": "A String", # The alias name.
                },
                "revisionId": "A String", # A revision (commit) ID.
                "hostUri": "A String", # The URI of a running Gerrit instance.
                "aliasName": "A String", # The name of an alias (branch, tag, etc.).
                "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
              },
            },
          },
        ],
        "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`).
        "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service.
        "id": "A String", # Unique identifier for the debuggee generated by the controller service.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.debugger.html000066400000000000000000000023701300622755700257660ustar00rootroot00000000000000

Stackdriver Debugger API . debugger

Instance Methods

debuggees()

Returns the debuggees Resource.

google-api-python-client-1.5.5/docs/dyn/clouddebugger_v2.html000066400000000000000000000044061300622755700242050ustar00rootroot00000000000000

Stackdriver Debugger API

Instance Methods

controller()

Returns the controller Resource.

debugger()

Returns the debugger Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/clouderrorreporting_v1beta1.html000066400000000000000000000042001300622755700264100ustar00rootroot00000000000000

Stackdriver Error Reporting API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/clouderrorreporting_v1beta1.projects.events.html000066400000000000000000000343711300622755700315570ustar00rootroot00000000000000

Stackdriver Error Reporting API . projects . events

Instance Methods

list(projectName=None, pageSize=None, x__xgafv=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None)

Lists the specified events.

list_next(previous_request, previous_response)

Retrieves the next page of results.

report(projectName=None, body, x__xgafv=None)

Report an individual error event.

Method Details

list(projectName=None, pageSize=None, x__xgafv=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None) 
Lists the specified events.

Args:
  projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
as `projects/` plus the
[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).
Example: `projects/my-project-123`. (required)
  pageSize: integer, [Optional] The maximum number of results to return per response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  timeRange_period: string, Restricts the query to the specified time range.
  pageToken: string, [Optional] A `next_page_token` provided by a previous response.
  serviceFilter_version: string, [Optional] The exact value to match against
[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
  serviceFilter_service: string, [Optional] The exact value to match against
[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
  groupId: string, [Required] The group for which events shall be returned.

Returns:
  An object of the form:

    { # Contains a set of requested error events.
    "nextPageToken": "A String", # If non-empty, more results are available.
        # Pass this token, along with the same query parameters as the first
        # request, to view the next page of results.
    "errorEvents": [ # The error events which match the given request.
      { # An error event which is returned by the Error Reporting system.
        "serviceContext": { # Describes a running service that sends errors. # The `ServiceContext` for which this error was reported.
            # Its version changes over time and multiple versions can run in parallel.
          "version": "A String", # Represents the source code version that the developer provided,
              # which could represent a version label or a Git SHA-1 hash, for example.
          "service": "A String", # An identifier of the service, such as the name of the
              # executable, job, or Google App Engine service name. This field is expected
              # to have a low number of values that are relatively stable over time, as
              # opposed to `version`, which can be changed whenever new code is deployed.
              #
              # Contains the service name for error reports extracted from Google
              # App Engine logs or `default` if the App Engine default service is used.
        },
        "eventTime": "A String", # Time when the event occurred as provided in the error report.
            # If the report did not contain a timestamp, the time the error was received
            # by the Error Reporting system is used.
        "message": "A String", # The stack trace that was reported or logged by the service.
        "context": { # A description of the context in which an error occurred. # Data about the context in which the error occurred.
            # This data should be provided by the application when reporting an error,
            # unless the
            # error report has been generated automatically from Google App Engine logs.
          "httpRequest": { # HTTP request data that is related to a reported error. # The HTTP request which was processed when the error was
              # triggered.
              # This data should be provided by the application when reporting an error,
              # unless the
              # error report has been generated automatically from Google App Engine logs.
            "responseStatusCode": 42, # The HTTP response status code for the request.
            "url": "A String", # The URL of the request.
            "referrer": "A String", # The referrer information that is provided with the request.
            "remoteIp": "A String", # The IP address from which the request originated.
                # This can be IPv4, IPv6, or a token which is derived from the
                # IP address, depending on the data that has been provided
                # in the error report.
            "userAgent": "A String", # The user agent information that is provided with the request.
            "method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
          },
          "reportLocation": { # Indicates a location in the source code of the service for which # The location in the source code where the decision was made to
              # report the error, usually the place where it was logged.
              # For a logged exception this would be the source line where the
              # exception is logged, usually close to the place where it was
              # caught. This value is in contrast to `Exception.cause_location`,
              # which describes the source line where the exception was thrown.
              # errors are reported.
              # This data should be provided by the application when reporting an error,
              # unless the error report has been generated automatically from Google App
              # Engine logs. All fields are optional.
            "lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
            "functionName": "A String", # Human-readable name of a function or method.
                # The value can include optional context like the class or package name.
                # For example, `my.package.MyClass.method` in case of Java.
            "filePath": "A String", # The source code filename, which can include a truncated relative
                # path, or a full path from a production machine.
          },
          "user": "A String", # The user who caused or was affected by the crash.
              # This can be a user ID, an email address, or an arbitrary token that
              # uniquely identifies the user.
              # When sending an error report, leave this field empty if the user was not
              # logged in. In this case the
              # Error Reporting system will use other data, such as remote IP address, to
              # distinguish affected users. See `affected_users_count` in
              # `ErrorGroupStats`.
        },
      },
    ],
  }
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.
report(projectName=None, body, x__xgafv=None) 
Report an individual error event.

This endpoint accepts either an OAuth token,
or an
API key
for authentication. To use an API key, append it to the URL as the value of
a `key` parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456


Args:
  projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
as `projects/` plus the
[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).
Example: `projects/my-project-123`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An error event which is reported to the Error Reporting system.
    "serviceContext": { # Describes a running service that sends errors. # [Required] The service context in which this error has occurred.
        # Its version changes over time and multiple versions can run in parallel.
      "version": "A String", # Represents the source code version that the developer provided,
          # which could represent a version label or a Git SHA-1 hash, for example.
      "service": "A String", # An identifier of the service, such as the name of the
          # executable, job, or Google App Engine service name. This field is expected
          # to have a low number of values that are relatively stable over time, as
          # opposed to `version`, which can be changed whenever new code is deployed.
          #
          # Contains the service name for error reports extracted from Google
          # App Engine logs or `default` if the App Engine default service is used.
    },
    "eventTime": "A String", # [Optional] Time when the event occurred.
        # If not provided, the time when the event was received by the
        # Error Reporting system will be used.
    "message": "A String", # [Required] A message describing the error. The message can contain an
        # exception stack in one of the supported programming languages and formats.
        # In that case, the message is parsed and detailed exception information
        # is returned when retrieving the error event again.
    "context": { # A description of the context in which an error occurred. # [Optional] A description of the context in which the error occurred.
        # This data should be provided by the application when reporting an error,
        # unless the
        # error report has been generated automatically from Google App Engine logs.
      "httpRequest": { # HTTP request data that is related to a reported error. # The HTTP request which was processed when the error was
          # triggered.
          # This data should be provided by the application when reporting an error,
          # unless the
          # error report has been generated automatically from Google App Engine logs.
        "responseStatusCode": 42, # The HTTP response status code for the request.
        "url": "A String", # The URL of the request.
        "referrer": "A String", # The referrer information that is provided with the request.
        "remoteIp": "A String", # The IP address from which the request originated.
            # This can be IPv4, IPv6, or a token which is derived from the
            # IP address, depending on the data that has been provided
            # in the error report.
        "userAgent": "A String", # The user agent information that is provided with the request.
        "method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
      },
      "reportLocation": { # Indicates a location in the source code of the service for which # The location in the source code where the decision was made to
          # report the error, usually the place where it was logged.
          # For a logged exception this would be the source line where the
          # exception is logged, usually close to the place where it was
          # caught. This value is in contrast to `Exception.cause_location`,
          # which describes the source line where the exception was thrown.
          # errors are reported.
          # This data should be provided by the application when reporting an error,
          # unless the error report has been generated automatically from Google App
          # Engine logs. All fields are optional.
        "lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
        "functionName": "A String", # Human-readable name of a function or method.
            # The value can include optional context like the class or package name.
            # For example, `my.package.MyClass.method` in case of Java.
        "filePath": "A String", # The source code filename, which can include a truncated relative
            # path, or a full path from a production machine.
      },
      "user": "A String", # The user who caused or was affected by the crash.
          # This can be a user ID, an email address, or an arbitrary token that
          # uniquely identifies the user.
          # When sending an error report, leave this field empty if the user was not
          # logged in. In this case the
          # Error Reporting system will use other data, such as remote IP address, to
          # distinguish affected users. See `affected_users_count` in
          # `ErrorGroupStats`.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for reporting an individual error event.
      # Data may be added to this message in the future.
  }
google-api-python-client-1.5.5/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html000066400000000000000000000341241300622755700324220ustar00rootroot00000000000000

Stackdriver Error Reporting API . projects . groupStats

Instance Methods

list(projectName=None, alignmentTime=None, pageSize=None, x__xgafv=None, alignment=None, timedCountDuration=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None, order=None)

Lists the specified groups.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(projectName=None, alignmentTime=None, pageSize=None, x__xgafv=None, alignment=None, timedCountDuration=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None, order=None) 
Lists the specified groups.

Args:
  projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
as projects/ plus the
Google Cloud
Platform project ID.

Example: projects/my-project-123. (required)
  alignmentTime: string, [Optional] Time where the timed counts shall be aligned if rounded
alignment is chosen. Default is 00:00 UTC.
  pageSize: integer, [Optional] The maximum number of results to return per response.
Default is 20.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  alignment: string, [Optional] The alignment of the timed counts to be returned.
Default is `ALIGNMENT_EQUAL_AT_END`.
  timedCountDuration: string, [Optional] The preferred duration for a single returned `TimedCount`.
If not set, no timed counts are returned.
  timeRange_period: string, Restricts the query to the specified time range.
  pageToken: string, [Optional] A `next_page_token` provided by a previous response. To view
additional results, pass this token along with the identical query
parameters as the first request.
  serviceFilter_version: string, [Optional] The exact value to match against
[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
  serviceFilter_service: string, [Optional] The exact value to match against
[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
  groupId: string, [Optional] List all ErrorGroupStats with these IDs. (repeated)
  order: string, [Optional] The sort order in which the results are returned.
Default is `COUNT_DESC`.

Returns:
  An object of the form:

    { # Contains a set of requested error group stats.
    "nextPageToken": "A String", # If non-empty, more results are available.
        # Pass this token, along with the same query parameters as the first
        # request, to view the next page of results.
    "errorGroupStats": [ # The error group stats which match the given request.
      { # Data extracted for a specific group based on certain filter criteria,
          # such as a given time period and/or service filter.
        "count": "A String", # Approximate total number of events in the given group that match
            # the filter criteria.
        "firstSeenTime": "A String", # Approximate first occurrence that was ever seen for this group
            # and which matches the given filter criteria, ignoring the
            # time_range that was specified in the request.
        "affectedUsersCount": "A String", # Approximate number of affected users in the given group that
            # match the filter criteria.
            # Users are distinguished by data in the `ErrorContext` of the
            # individual error events, such as their login name or their remote
            # IP address in case of HTTP requests.
            # The number of affected users can be zero even if the number of
            # errors is non-zero if no data was provided from which the
            # affected user could be deduced.
            # Users are counted based on data in the request
            # context that was provided in the error report. If more users are
            # implicitly affected, such as due to a crash of the whole service,
            # this is not reflected here.
        "group": { # Description of a group of similar error events. # Group data that is independent of the filter criteria.
          "trackingIssues": [ # Associated tracking issues.
            { # Information related to tracking the progress on resolving the error.
              "url": "A String", # A URL pointing to a related entry in an issue tracking system.
                  # Example: https://github.com/user/project/issues/4
            },
          ],
          "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
              # occurs in different service contexts, it will receive the same group ID.
          "name": "A String", # The group resource name.
              # Example: projects/my-project-123/groups/my-groupid
        },
        "timedCounts": [ # Approximate number of occurrences over time.
            # Timed counts returned by ListGroups are guaranteed to be:
            #
            # - Inside the requested time interval
            # - Non-overlapping, and
            # - Ordered by ascending time.
          { # The number of errors in a given time period.
              # All numbers are approximate since the error events are sampled
              # before counting them.
            "count": "A String", # Approximate number of occurrences in the given time period.
            "endTime": "A String", # End of the time period to which `count` refers (excluded).
            "startTime": "A String", # Start of the time period to which `count` refers (included).
          },
        ],
        "lastSeenTime": "A String", # Approximate last occurrence that was ever seen for this group and
            # which matches the given filter criteria, ignoring the time_range
            # that was specified in the request.
        "representative": { # An error event which is returned by the Error Reporting system. # An arbitrary event that is chosen as representative for the whole group.
            # The representative event is intended to be used as a quick preview for
            # the whole group. Events in the group are usually sufficiently similar
            # to each other such that showing an arbitrary representative provides
            # insight into the characteristics of the group as a whole.
          "serviceContext": { # Describes a running service that sends errors. # The `ServiceContext` for which this error was reported.
              # Its version changes over time and multiple versions can run in parallel.
            "version": "A String", # Represents the source code version that the developer provided,
                # which could represent a version label or a Git SHA-1 hash, for example.
            "service": "A String", # An identifier of the service, such as the name of the
                # executable, job, or Google App Engine service name. This field is expected
                # to have a low number of values that are relatively stable over time, as
                # opposed to `version`, which can be changed whenever new code is deployed.
                #
                # Contains the service name for error reports extracted from Google
                # App Engine logs or `default` if the App Engine default service is used.
          },
          "eventTime": "A String", # Time when the event occurred as provided in the error report.
              # If the report did not contain a timestamp, the time the error was received
              # by the Error Reporting system is used.
          "message": "A String", # The stack trace that was reported or logged by the service.
          "context": { # A description of the context in which an error occurred. # Data about the context in which the error occurred.
              # This data should be provided by the application when reporting an error,
              # unless the
              # error report has been generated automatically from Google App Engine logs.
            "httpRequest": { # HTTP request data that is related to a reported error. # The HTTP request which was processed when the error was
                # triggered.
                # This data should be provided by the application when reporting an error,
                # unless the
                # error report has been generated automatically from Google App Engine logs.
              "responseStatusCode": 42, # The HTTP response status code for the request.
              "url": "A String", # The URL of the request.
              "referrer": "A String", # The referrer information that is provided with the request.
              "remoteIp": "A String", # The IP address from which the request originated.
                  # This can be IPv4, IPv6, or a token which is derived from the
                  # IP address, depending on the data that has been provided
                  # in the error report.
              "userAgent": "A String", # The user agent information that is provided with the request.
              "method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
            },
            "reportLocation": { # Indicates a location in the source code of the service for which # The location in the source code where the decision was made to
                # report the error, usually the place where it was logged.
                # For a logged exception this would be the source line where the
                # exception is logged, usually close to the place where it was
                # caught. This value is in contrast to `Exception.cause_location`,
                # which describes the source line where the exception was thrown.
                # errors are reported.
                # This data should be provided by the application when reporting an error,
                # unless the error report has been generated automatically from Google App
                # Engine logs. All fields are optional.
              "lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
              "functionName": "A String", # Human-readable name of a function or method.
                  # The value can include optional context like the class or package name.
                  # For example, `my.package.MyClass.method` in case of Java.
              "filePath": "A String", # The source code filename, which can include a truncated relative
                  # path, or a full path from a production machine.
            },
            "user": "A String", # The user who caused or was affected by the crash.
                # This can be a user ID, an email address, or an arbitrary token that
                # uniquely identifies the user.
                # When sending an error report, leave this field empty if the user was not
                # logged in. In this case the
                # Error Reporting system will use other data, such as remote IP address, to
                # distinguish affected users. See `affected_users_count` in
                # `ErrorGroupStats`.
          },
        },
        "numAffectedServices": 42, # The total number of services with a non-zero error count for the given
            # filter criteria.
        "affectedServices": [ # Service contexts with a non-zero error count for the given filter
            # criteria. This list can be truncated if multiple services are affected.
            # Refer to `num_affected_services` for the total count.
          { # Describes a running service that sends errors.
              # Its version changes over time and multiple versions can run in parallel.
            "version": "A String", # Represents the source code version that the developer provided,
                # which could represent a version label or a Git SHA-1 hash, for example.
            "service": "A String", # An identifier of the service, such as the name of the
                # executable, job, or Google App Engine service name. This field is expected
                # to have a low number of values that are relatively stable over time, as
                # opposed to `version`, which can be changed whenever new code is deployed.
                #
                # Contains the service name for error reports extracted from Google
                # App Engine logs or `default` if the App Engine default service is used.
          },
        ],
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/clouderrorreporting_v1beta1.projects.groups.html000066400000000000000000000112271300622755700315650ustar00rootroot00000000000000

Stackdriver Error Reporting API . projects . groups

Instance Methods

get(groupName=None, x__xgafv=None)

Get the specified group.

update(name=None, body, x__xgafv=None)

Replace the data for the specified group.

Method Details

get(groupName=None, x__xgafv=None) 
Get the specified group.

Args:
  groupName: string, [Required] The group resource name. Written as
projects/projectID/groups/group_name.
Call

groupStats.list to return a list of groups belonging to
this project.

Example: projects/my-project-123/groups/my-group (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Description of a group of similar error events.
    "trackingIssues": [ # Associated tracking issues.
      { # Information related to tracking the progress on resolving the error.
        "url": "A String", # A URL pointing to a related entry in an issue tracking system.
            # Example: https://github.com/user/project/issues/4
      },
    ],
    "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
        # occurs in different service contexts, it will receive the same group ID.
    "name": "A String", # The group resource name.
        # Example: projects/my-project-123/groups/my-groupid
  }
update(name=None, body, x__xgafv=None) 
Replace the data for the specified group.
Fails if the group does not exist.

Args:
  name: string, The group resource name.
Example: projects/my-project-123/groups/my-groupid (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Description of a group of similar error events.
  "trackingIssues": [ # Associated tracking issues.
    { # Information related to tracking the progress on resolving the error.
      "url": "A String", # A URL pointing to a related entry in an issue tracking system.
          # Example: https://github.com/user/project/issues/4
    },
  ],
  "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
      # occurs in different service contexts, it will receive the same group ID.
  "name": "A String", # The group resource name.
      # Example: projects/my-project-123/groups/my-groupid
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Description of a group of similar error events.
    "trackingIssues": [ # Associated tracking issues.
      { # Information related to tracking the progress on resolving the error.
        "url": "A String", # A URL pointing to a related entry in an issue tracking system.
            # Example: https://github.com/user/project/issues/4
      },
    ],
    "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
        # occurs in different service contexts, it will receive the same group ID.
    "name": "A String", # The group resource name.
        # Example: projects/my-project-123/groups/my-groupid
  }
google-api-python-client-1.5.5/docs/dyn/clouderrorreporting_v1beta1.projects.html000066400000000000000000000047211300622755700302500ustar00rootroot00000000000000

Stackdriver Error Reporting API . projects

Instance Methods

events()

Returns the events Resource.

groupStats()

Returns the groupStats Resource.

groups()

Returns the groups Resource.

deleteEvents(projectName=None, x__xgafv=None)

Deletes all error events of a given project.

Method Details

deleteEvents(projectName=None, x__xgafv=None) 
Deletes all error events of a given project.

Args:
  projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
as `projects/` plus the
[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).
Example: `projects/my-project-123`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for deleting error events.
  }
google-api-python-client-1.5.5/docs/dyn/cloudmonitoring_v2beta2.html000066400000000000000000000047751300622755700255350ustar00rootroot00000000000000

Cloud Monitoring API

Instance Methods

metricDescriptors()

Returns the metricDescriptors Resource.

timeseries()

Returns the timeseries Resource.

timeseriesDescriptors()

Returns the timeseriesDescriptors Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/cloudmonitoring_v2beta2.metricDescriptors.html000066400000000000000000000203161300622755700312260ustar00rootroot00000000000000

Cloud Monitoring API . metricDescriptors

Instance Methods

create(project, body)

Create a new metric.

delete(project, metric)

Delete an existing metric.

list(project, count=None, pageToken=None, query=None)

List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(project, body) 
Create a new metric.

Args:
  project: string, The project id. The value can be the numeric project ID or string-based project name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A metricDescriptor defines the name, label keys, and data type of a particular metric.
    "project": "A String", # The project ID to which the metric belongs.
    "labels": [ # Labels defined for this metric.
      { # A label in a metric is a description of this metric, including the key of this description (what the description is), and the value for this description.
        "description": "A String", # Label description.
        "key": "A String", # Label key.
      },
    ],
    "typeDescriptor": { # A type in a metric contains information about how the metric is collected and what its data points look like. # Type description for this metric.
      "valueType": "A String", # The data type of of individual points in the metric's time series. See Metric value types.
      "metricType": "A String", # The method of collecting data for the metric. See Metric types.
    },
    "description": "A String", # Description of this metric.
    "name": "A String", # The name of this metric.
  }


Returns:
  An object of the form:

    { # A metricDescriptor defines the name, label keys, and data type of a particular metric.
      "project": "A String", # The project ID to which the metric belongs.
      "labels": [ # Labels defined for this metric.
        { # A label in a metric is a description of this metric, including the key of this description (what the description is), and the value for this description.
          "description": "A String", # Label description.
          "key": "A String", # Label key.
        },
      ],
      "typeDescriptor": { # A type in a metric contains information about how the metric is collected and what its data points look like. # Type description for this metric.
        "valueType": "A String", # The data type of of individual points in the metric's time series. See Metric value types.
        "metricType": "A String", # The method of collecting data for the metric. See Metric types.
      },
      "description": "A String", # Description of this metric.
      "name": "A String", # The name of this metric.
    }
delete(project, metric) 
Delete an existing metric.

Args:
  project: string, The project ID to which the metric belongs. (required)
  metric: string, Name of the metric. (required)

Returns:
  An object of the form:

    { # The response of cloudmonitoring.metricDescriptors.delete.
    "kind": "cloudmonitoring#deleteMetricDescriptorResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#deleteMetricDescriptorResponse".
  }
list(project, count=None, pageToken=None, query=None) 
List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

Args:
  project: string, The project id. The value can be the numeric project ID or string-based project name. (required)
  count: integer, Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100.
  pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
  query: string, The query used to search against existing metrics. Separate keywords with a space; the service joins all keywords with AND, meaning that all keywords must match for a metric to be returned. If this field is omitted, all metrics are returned. If an empty string is passed with this field, no metrics are returned.

Returns:
  An object of the form:

    { # The response of cloudmonitoring.metricDescriptors.list.
    "metrics": [ # The returned metric descriptors.
      { # A metricDescriptor defines the name, label keys, and data type of a particular metric.
          "project": "A String", # The project ID to which the metric belongs.
          "labels": [ # Labels defined for this metric.
            { # A label in a metric is a description of this metric, including the key of this description (what the description is), and the value for this description.
              "description": "A String", # Label description.
              "key": "A String", # Label key.
            },
          ],
          "typeDescriptor": { # A type in a metric contains information about how the metric is collected and what its data points look like. # Type description for this metric.
            "valueType": "A String", # The data type of of individual points in the metric's time series. See Metric value types.
            "metricType": "A String", # The method of collecting data for the metric. See Metric types.
          },
          "description": "A String", # Description of this metric.
          "name": "A String", # The name of this metric.
        },
    ],
    "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, pass this value to the pageToken query parameter.
    "kind": "cloudmonitoring#listMetricDescriptorsResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listMetricDescriptorsResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/cloudmonitoring_v2beta2.timeseries.html000066400000000000000000000377021300622755700277010ustar00rootroot00000000000000

Cloud Monitoring API . timeseries

Instance Methods

list(project, metric, youngest, count=None, timespan=None, aggregator=None, labels=None, window=None, pageToken=None, oldest=None)

List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

list_next(previous_request, previous_response)

Retrieves the next page of results.

write(project, body)

Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time.

Method Details

list(project, metric, youngest, count=None, timespan=None, aggregator=None, labels=None, window=None, pageToken=None, oldest=None) 
List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

Args:
  project: string, The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name. (required)
  metric: string, Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count. (required)
  youngest: string, End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp. (required)
  count: integer, Maximum number of data points per page, which is used for pagination of results.
  timespan: string, Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units:  
- s: second 
- m: minute 
- h: hour 
- d: day 
- w: week  Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.

If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
  aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.
    Allowed values
      max - 
      mean - 
      min - 
      sum - 
  labels: string, A collection of labels for the matching time series, which are represented as:  
- key==value: key equals the value 
- key=~value: key regex matches the value 
- key!=value: key does not equal the value 
- key!~value: key regex does not match the value  For example, to list all of the time series descriptors for the region us-central1, you could specify:
label=cloud.googleapis.com%2Flocation=~us-central1.* (repeated)
  window: string, The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units:  
- m: minute 
- h: hour 
- d: day 
- w: week  Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.
  pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
  oldest: string, Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]

Returns:
  An object of the form:

    { # The response of cloudmonitoring.timeseries.list
    "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set the pageToken query parameter to this value. All of the points of a time series will be returned before returning any point of the subsequent time series.
    "youngest": "A String", # The youngest timestamp of the interval of this query as an RFC 3339 string.
    "kind": "cloudmonitoring#listTimeseriesResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesResponse".
    "oldest": "A String", # The oldest timestamp of the interval of this query as an RFC 3339 string.
    "timeseries": [ # The returned time series.
      { # The monitoring data is organized as metrics and stored as data points that are recorded over time. Each data point represents information like the CPU utilization of your virtual machine. A historical record of these data points is called a time series.
        "timeseriesDesc": { # TimeseriesDescriptor identifies a single time series. # The descriptor of this time series.
          "project": "A String", # The Developers Console project number to which this time series belongs.
          "metric": "A String", # The name of the metric.
          "labels": { # The label's name.
            "a_key": "A String", # The label's name.
          },
        },
        "points": [ # The data points of this time series. The points are listed in order of their end timestamp, from younger to older.
          { # Point is a single point in a time series. It consists of a start time, an end time, and a value.
            "end": "A String", # The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
            "doubleValue": 3.14, # The value of this data point as a double-precision floating-point number.
            "start": "A String", # The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
            "boolValue": True or False, # The value of this data point. Either "true" or "false".
            "distributionValue": { # Distribution data point value type. When writing distribution points, try to be consistent with the boundaries of your buckets. If you must modify the bucket boundaries, then do so by merging, partitioning, or appending rather than skewing them. # The value of this data point as a distribution. A distribution value can contain a list of buckets and/or an underflowBucket and an overflowBucket. The values of these points can be used to create a histogram.
              "buckets": [ # The finite buckets.
                { # The histogram's bucket. Buckets that form the histogram of a distribution value. If the upper bound of a bucket, say U1, does not equal the lower bound of the next bucket, say L2, this means that there is no event in [U1, L2).
                  "count": "A String", # The number of events whose values are in the interval defined by this bucket.
                  "lowerBound": 3.14, # The lower bound of the value interval of this bucket (inclusive).
                  "upperBound": 3.14, # The upper bound of the value interval of this bucket (exclusive).
                },
              ],
              "underflowBucket": { # The underflow bucket is a special bucket that does not have the lowerBound field; it includes all of the events that are less than its upper bound. # The underflow bucket.
                "count": "A String", # The number of events whose values are in the interval defined by this bucket.
                "upperBound": 3.14, # The upper bound of the value interval of this bucket (exclusive).
              },
              "overflowBucket": { # The overflow bucket is a special bucket that does not have the upperBound field; it includes all of the events that are no less than its lower bound. # The overflow bucket.
                "count": "A String", # The number of events whose values are in the interval defined by this bucket.
                "lowerBound": 3.14, # The lower bound of the value interval of this bucket (inclusive).
              },
            },
            "stringValue": "A String", # The value of this data point in string format.
            "int64Value": "A String", # The value of this data point as a 64-bit integer.
          },
        ],
      },
    ],
  }
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.
write(project, body) 
Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time.

Args:
  project: string, The project ID. The value can be the numeric project ID or string-based project name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request of cloudmonitoring.timeseries.write
    "timeseries": [ # Provide time series specific labels and the data points for each time series. The labels in timeseries and the common_labels should form a complete list of labels that required by the metric.
      { # When writing time series, TimeseriesPoint should be used instead of Timeseries, to enforce single point for each time series in the timeseries.write request.
        "timeseriesDesc": { # TimeseriesDescriptor identifies a single time series. # The descriptor of this time series.
          "project": "A String", # The Developers Console project number to which this time series belongs.
          "metric": "A String", # The name of the metric.
          "labels": { # The label's name.
            "a_key": "A String", # The label's name.
          },
        },
        "point": { # Point is a single point in a time series. It consists of a start time, an end time, and a value. # The data point in this time series snapshot.
          "end": "A String", # The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
          "doubleValue": 3.14, # The value of this data point as a double-precision floating-point number.
          "start": "A String", # The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
          "boolValue": True or False, # The value of this data point. Either "true" or "false".
          "distributionValue": { # Distribution data point value type. When writing distribution points, try to be consistent with the boundaries of your buckets. If you must modify the bucket boundaries, then do so by merging, partitioning, or appending rather than skewing them. # The value of this data point as a distribution. A distribution value can contain a list of buckets and/or an underflowBucket and an overflowBucket. The values of these points can be used to create a histogram.
            "buckets": [ # The finite buckets.
              { # The histogram's bucket. Buckets that form the histogram of a distribution value. If the upper bound of a bucket, say U1, does not equal the lower bound of the next bucket, say L2, this means that there is no event in [U1, L2).
                "count": "A String", # The number of events whose values are in the interval defined by this bucket.
                "lowerBound": 3.14, # The lower bound of the value interval of this bucket (inclusive).
                "upperBound": 3.14, # The upper bound of the value interval of this bucket (exclusive).
              },
            ],
            "underflowBucket": { # The underflow bucket is a special bucket that does not have the lowerBound field; it includes all of the events that are less than its upper bound. # The underflow bucket.
              "count": "A String", # The number of events whose values are in the interval defined by this bucket.
              "upperBound": 3.14, # The upper bound of the value interval of this bucket (exclusive).
            },
            "overflowBucket": { # The overflow bucket is a special bucket that does not have the upperBound field; it includes all of the events that are no less than its lower bound. # The overflow bucket.
              "count": "A String", # The number of events whose values are in the interval defined by this bucket.
              "lowerBound": 3.14, # The lower bound of the value interval of this bucket (inclusive).
            },
          },
          "stringValue": "A String", # The value of this data point in string format.
          "int64Value": "A String", # The value of this data point as a 64-bit integer.
        },
      },
    ],
    "commonLabels": { # The label's name.
      "a_key": "A String", # The label's name.
    },
  }


Returns:
  An object of the form:

    { # The response of cloudmonitoring.timeseries.write
    "kind": "cloudmonitoring#writeTimeseriesResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#writeTimeseriesResponse".
  }
google-api-python-client-1.5.5/docs/dyn/cloudmonitoring_v2beta2.timeseriesDescriptors.html000066400000000000000000000146221300622755700321170ustar00rootroot00000000000000

Cloud Monitoring API . timeseriesDescriptors

Instance Methods

list(project, metric, youngest, count=None, timespan=None, aggregator=None, labels=None, window=None, pageToken=None, oldest=None)

List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(project, metric, youngest, count=None, timespan=None, aggregator=None, labels=None, window=None, pageToken=None, oldest=None) 
List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

Args:
  project: string, The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name. (required)
  metric: string, Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count. (required)
  youngest: string, End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp. (required)
  count: integer, Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100.
  timespan: string, Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units:  
- s: second 
- m: minute 
- h: hour 
- d: day 
- w: week  Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.

If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
  aggregator: string, The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.
    Allowed values
      max - 
      mean - 
      min - 
      sum - 
  labels: string, A collection of labels for the matching time series, which are represented as:  
- key==value: key equals the value 
- key=~value: key regex matches the value 
- key!=value: key does not equal the value 
- key!~value: key regex does not match the value  For example, to list all of the time series descriptors for the region us-central1, you could specify:
label=cloud.googleapis.com%2Flocation=~us-central1.* (repeated)
  window: string, The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units:  
- m: minute 
- h: hour 
- d: day 
- w: week  Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.
  pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
  oldest: string, Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]

Returns:
  An object of the form:

    { # The response of cloudmonitoring.timeseriesDescriptors.list
    "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter.
    "youngest": "A String", # The youngest timestamp of the interval of this query, as an RFC 3339 string.
    "kind": "cloudmonitoring#listTimeseriesDescriptorsResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesDescriptorsResponse".
    "oldest": "A String", # The oldest timestamp of the interval of this query, as an RFC 3339 string.
    "timeseries": [ # The returned time series descriptors.
      { # TimeseriesDescriptor identifies a single time series.
        "project": "A String", # The Developers Console project number to which this time series belongs.
        "metric": "A String", # The name of the metric.
        "labels": { # The label's name.
          "a_key": "A String", # The label's name.
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1.html000066400000000000000000000047271300622755700256100ustar00rootroot00000000000000

Google Cloud Resource Manager API

Instance Methods

operations()

Returns the operations Resource.

organizations()

Returns the organizations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1.operations.html000066400000000000000000000143441300622755700277660ustar00rootroot00000000000000

Google Cloud Resource Manager API . operations

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Method Details

get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1.organizations.html000066400000000000000000000446701300622755700304770ustar00rootroot00000000000000

Google Cloud Resource Manager API . organizations

Instance Methods

get(name, x__xgafv=None)

Fetches an Organization resource identified by the specified resource name.

getIamPolicy(resource, body, x__xgafv=None)

Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".

search(body, x__xgafv=None)

Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Method Details

get(name, x__xgafv=None) 
Fetches an Organization resource identified by the specified resource name.

Args:
  name: string, The resource name of the Organization to fetch, e.g. "organizations/1234". (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
    "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
      "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
    },
    "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
    "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
    "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
    "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
  }
getIamPolicy(resource, body, x__xgafv=None) 
Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
search(body, x__xgafv=None) 
Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The request sent to the `SearchOrganizations` method.
    "filter": "A String", # An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
    "pageToken": "A String", # A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue. This field is optional.
    "pageSize": 42, # The maximum number of Organizations to return in the response. This field is optional.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response returned from the `SearchOrganizations` method.
    "nextPageToken": "A String", # A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.
    "organizations": [ # The list of Organizations that matched the search query, possibly paginated.
      { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
        "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
          "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
        },
        "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
        "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
        "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
        "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
      },
    ],
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1.projects.html000066400000000000000000001221051300622755700274270ustar00rootroot00000000000000

Google Cloud Resource Manager API . projects

Instance Methods

create(body, x__xgafv=None)

Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff.

delete(projectId, x__xgafv=None)

Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.

get(projectId, x__xgafv=None)

Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

getIamPolicy(resource, body, x__xgafv=None)

Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.

list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource, body, x__xgafv=None)

Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified Project.

undelete(projectId, body, x__xgafv=None)

Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.

update(projectId, body, x__xgafv=None)

Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.

Method Details

create(body, x__xgafv=None) 
Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
  "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
  "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
    "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
    "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
  },
  "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
  "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
    "a_key": "A String",
  },
  "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
  "lifecycleState": "A String", # The Project lifecycle state. Read-only.
  "createTime": "A String", # Creation time. Read-only.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
delete(projectId, x__xgafv=None) 
Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.

Args:
  projectId: string, The Project ID (for example, `foo-bar-123`). Required. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(projectId, x__xgafv=None) 
Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

Args:
  projectId: string, The Project ID (for example, `my-project-123`). Required. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
    "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
    "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
      "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
      "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
    },
    "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
    "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
      "a_key": "A String",
    },
    "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
    "lifecycleState": "A String", # The Project lifecycle state. Read-only.
    "createTime": "A String", # Creation time. Read-only.
  }
getIamPolicy(resource, body, x__xgafv=None) 
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.

Args:
  pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.
  filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.
  pageToken: string, A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
    "nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.
    "projects": [ # The list of Projects that matched the list filter. This list can be paginated.
      { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
        "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
        "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
          "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
          "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
        },
        "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
        "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
          "a_key": "A String",
        },
        "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
        "lifecycleState": "A String", # The Project lifecycle state. Read-only.
        "createTime": "A String", # Creation time. Read-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.
setIamPolicy(resource, body, x__xgafv=None) 
Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified Project.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
undelete(projectId, body, x__xgafv=None) 
Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.

Args:
  projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request sent to the UndeleteProject method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
update(projectId, body, x__xgafv=None) 
Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.

Args:
  projectId: string, The project ID (for example, `my-project-123`). Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
  "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
  "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
    "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
    "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
  },
  "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
  "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
    "a_key": "A String",
  },
  "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
  "lifecycleState": "A String", # The Project lifecycle state. Read-only.
  "createTime": "A String", # Creation time. Read-only.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
    "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
    "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
      "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
      "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
    },
    "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
    "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
      "a_key": "A String",
    },
    "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
    "lifecycleState": "A String", # The Project lifecycle state. Read-only.
    "createTime": "A String", # Creation time. Read-only.
  }
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1beta1.html000066400000000000000000000044741300622755700265240ustar00rootroot00000000000000

Google Cloud Resource Manager API

Instance Methods

organizations()

Returns the organizations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1beta1.organizations.html000066400000000000000000000566031300622755700314130ustar00rootroot00000000000000

Google Cloud Resource Manager API . organizations

Instance Methods

get(name, organizationId=None, x__xgafv=None)

Fetches an Organization resource identified by the specified resource name.

getIamPolicy(resource, body, x__xgafv=None)

Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".

list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".

update(name, body, x__xgafv=None)

Updates an Organization resource identified by the specified resource name.

Method Details

get(name, organizationId=None, x__xgafv=None) 
Fetches an Organization resource identified by the specified resource name.

Args:
  name: string, The resource name of the Organization to fetch, e.g. "organizations/1234". (required)
  organizationId: string, The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
    "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
    "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
    "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
    "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
    "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
    "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
      "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
    },
  }
getIamPolicy(resource, body, x__xgafv=None) 
Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.

Args:
  pageSize: integer, The maximum number of Organizations to return in the response. This field is optional.
  filter: string, An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
  pageToken: string, A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response returned from the `ListOrganizations` method.
    "nextPageToken": "A String", # A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.
    "organizations": [ # The list of Organizations that matched the list query, possibly paginated.
      { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
        "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
        "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
        "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
        "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
        "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
        "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
          "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
        },
      },
    ],
  }
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.
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(name, body, x__xgafv=None) 
Updates an Organization resource identified by the specified resource name.

Args:
  name: string, Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
  "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
  "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
  "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
  "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
  "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
  "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
    "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
  },
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
    "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
    "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
    "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
    "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
    "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
    "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
      "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
    },
  }
google-api-python-client-1.5.5/docs/dyn/cloudresourcemanager_v1beta1.projects.html000066400000000000000000001210431300622755700303440ustar00rootroot00000000000000

Google Cloud Resource Manager API . projects

Instance Methods

create(body, useLegacyStack=None, x__xgafv=None)

Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.

delete(projectId, x__xgafv=None)

Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.

get(projectId, x__xgafv=None)

Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

getAncestry(projectId, body, x__xgafv=None)

Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

getIamPolicy(resource, body, x__xgafv=None)

Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.

list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource, body, x__xgafv=None)

Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified Project.

undelete(projectId, body, x__xgafv=None)

Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.

update(projectId, body, x__xgafv=None)

Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.

Method Details

create(body, useLegacyStack=None, x__xgafv=None) 
Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
  "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
  "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
    "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
    "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
  },
  "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
  "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
    "a_key": "A String",
  },
  "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
  "lifecycleState": "A String", # The Project lifecycle state. Read-only.
  "createTime": "A String", # Creation time. Read-only.
}

  useLegacyStack: boolean, A safety hatch to opt out of the new reliable project creation process.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
    "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
    "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
      "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
      "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
    },
    "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
    "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
      "a_key": "A String",
    },
    "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
    "lifecycleState": "A String", # The Project lifecycle state. Read-only.
    "createTime": "A String", # Creation time. Read-only.
  }
delete(projectId, x__xgafv=None) 
Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.

Args:
  projectId: string, The Project ID (for example, `foo-bar-123`). Required. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(projectId, x__xgafv=None) 
Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

Args:
  projectId: string, The Project ID (for example, `my-project-123`). Required. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
    "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
    "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
      "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
      "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
    },
    "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
    "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
      "a_key": "A String",
    },
    "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
    "lifecycleState": "A String", # The Project lifecycle state. Read-only.
    "createTime": "A String", # Creation time. Read-only.
  }
getAncestry(projectId, body, x__xgafv=None) 
Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

Args:
  projectId: string, The Project ID (for example, `my-project-123`). Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request sent to the GetAncestry method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response from the GetAncestry method.
    "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The first ancestor is the project itself, followed by the project's parent, etc.
      { # Identifying information for a single ancestor of a project.
        "resourceId": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # Resource id of the ancestor.
          "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
          "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
        },
      },
    ],
  }
getIamPolicy(resource, body, x__xgafv=None) 
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.

Args:
  pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.
  filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.
  pageToken: string, A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
    "nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.
    "projects": [ # The list of Projects that matched the list filter. This list can be paginated.
      { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
        "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
        "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
          "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
          "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
        },
        "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
        "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
          "a_key": "A String",
        },
        "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
        "lifecycleState": "A String", # The Project lifecycle state. Read-only.
        "createTime": "A String", # Creation time. Read-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.
setIamPolicy(resource, body, x__xgafv=None) 
Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified Project.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
undelete(projectId, body, x__xgafv=None) 
Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.

Args:
  projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request sent to the UndeleteProject method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
update(projectId, body, x__xgafv=None) 
Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.

Args:
  projectId: string, The project ID (for example, `my-project-123`). Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
  "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
  "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
    "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
    "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
  },
  "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
  "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
    "a_key": "A String",
  },
  "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
  "lifecycleState": "A String", # The Project lifecycle state. Read-only.
  "createTime": "A String", # Creation time. Read-only.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
    "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
    "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
      "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
      "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
    },
    "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
    "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
      "a_key": "A String",
    },
    "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
    "lifecycleState": "A String", # The Project lifecycle state. Read-only.
    "createTime": "A String", # Creation time. Read-only.
  }
google-api-python-client-1.5.5/docs/dyn/cloudtrace_v1.html000066400000000000000000000041331300622755700235130ustar00rootroot00000000000000

Google Cloud Trace API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/cloudtrace_v1.projects.html000066400000000000000000000115121300622755700253420ustar00rootroot00000000000000

Google Cloud Trace API . projects

Instance Methods

traces()

Returns the traces Resource.

patchTraces(projectId, body, x__xgafv=None)

Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.

Method Details

patchTraces(projectId, body, x__xgafv=None) 
Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.

Args:
  projectId: string, ID of the Cloud project where the trace data is stored. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # List of new or updated traces.
    "traces": [ # List of traces.
      { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.
        "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
        "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
        "spans": [ # Collection of spans in the trace.
          { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
            "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.
            "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the {% dynamic print site_values.console_name %}. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
            "labels": { # Collection of labels associated with the span.
              "a_key": "A String",
            },
            "parentSpanId": "A String", # ID of the parent span, if any. Optional.
            "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
            "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
            "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
          },
        ],
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/cloudtrace_v1.projects.traces.html000066400000000000000000000206421300622755700266260ustar00rootroot00000000000000

Google Cloud Trace API . projects . traces

Instance Methods

get(projectId, traceId, x__xgafv=None)

Gets a single trace by its ID.

list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None)

Returns of a list of traces that match the specified filter conditions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(projectId, traceId, x__xgafv=None) 
Gets a single trace by its ID.

Args:
  projectId: string, ID of the Cloud project where the trace data is stored. (required)
  traceId: string, ID of the trace to return. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.
    "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
    "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
    "spans": [ # Collection of spans in the trace.
      { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
        "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.
        "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the {% dynamic print site_values.console_name %}. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
        "labels": { # Collection of labels associated with the span.
          "a_key": "A String",
        },
        "parentSpanId": "A String", # ID of the parent span, if any. Optional.
        "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
        "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
        "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
      },
    ],
  }
list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None) 
Returns of a list of traces that match the specified filter conditions.

Args:
  projectId: string, ID of the Cloud project where the trace data is stored. (required)
  orderBy: string, Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted.
  startTime: string, End of the time interval (inclusive) during which the trace data was collected from the application.
  pageSize: integer, Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
  x__xgafv: string, V1 error format.
  pageToken: string, Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional.
  filter: string, An optional filter for the request.
  endTime: string, Start of the time interval (inclusive) during which the trace data was collected from the application.
  view: string, Type of data returned for traces in the list. Optional. Default is `MINIMAL`.

Returns:
  An object of the form:

    { # The response message for the `ListTraces` method.
    "nextPageToken": "A String", # If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.
    "traces": [ # List of trace records returned.
      { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.
        "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
        "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
        "spans": [ # Collection of spans in the trace.
          { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
            "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.
            "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the {% dynamic print site_values.console_name %}. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
            "labels": { # Collection of labels associated with the span.
              "a_key": "A String",
            },
            "parentSpanId": "A String", # ID of the parent span, if any. Optional.
            "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
            "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
            "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
          },
        ],
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_alpha.globalAccountsOperations.html000066400000000000000000000373111300622755700327010ustar00rootroot00000000000000

Cloud User Accounts API . globalAccountsOperations

Instance Methods

delete(project, operation)

Deletes the specified operation resource.

get(project, operation)

Retrieves the specified operation resource.

list(project, orderBy=None, 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, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified operation resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
      },
    ],
    "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_alpha.groups.html000066400000000000000000001422121300622755700272110ustar00rootroot00000000000000

Cloud User Accounts API . groups

Instance Methods

addMember(project, groupName, body)

Adds users to the specified group.

delete(project, groupName)

Deletes the specified Group resource.

get(project, groupName)

Returns the specified Group resource.

getIamPolicy(project, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body)

Creates a Group resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of groups contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeMember(project, groupName, body)

Removes users from the specified group.

setIamPolicy(project, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addMember(project, groupName, body) 
Adds users to the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to add.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, groupName) 
Deletes the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, groupName) 
Returns the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to return. (required)

Returns:
  An object of the form:

    { # A Group resource.
      "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
getIamPolicy(project, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, body) 
Creates a Group resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Group resource.
    "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of groups contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of Group resources.
      { # A Group resource.
          "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removeMember(project, groupName, body) 
Removes users from the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to remove.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
setIamPolicy(project, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
        "A String",
      ],
      "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # The object of the condition. Exactly one of these must be set.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_alpha.html000066400000000000000000000051641300622755700256770ustar00rootroot00000000000000

Cloud User Accounts API

Instance Methods

globalAccountsOperations()

Returns the globalAccountsOperations Resource.

groups()

Returns the groups Resource.

linux()

Returns the linux Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_alpha.linux.html000066400000000000000000000161641300622755700270370ustar00rootroot00000000000000

Cloud User Accounts API . linux

Instance Methods

getAuthorizedKeysView(project, zone, user, instance, login=None)

Returns a list of authorized public keys for a specific user account.

getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)

Retrieves a list of user accounts for an instance within a specific project.

Method Details

getAuthorizedKeysView(project, zone, user, instance, login=None) 
Returns a list of authorized public keys for a specific user account.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  user: string, The user account for which you want to get a list of authorized public keys. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
  login: boolean, Whether the view was requested as part of a user-initiated login.

Returns:
  An object of the form:

    {
    "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
      "keys": [ # [Output Only] The list of authorized public keys in SSH format.
        "A String",
      ],
      "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
    },
  }
getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None) 
Retrieves a list of user accounts for an instance within a specific project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Returns:
  An object of the form:

    {
    "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
      "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
      "userViews": [ # [Output Only] A list of all users within a project.
        { # A detailed view of a Linux user account.
          "username": "A String", # [Output Only] The username of the account.
          "shell": "A String", # [Output Only] The path to the login shell for this account.
          "uid": 42, # [Output Only] User ID.
          "gid": 42, # [Output Only] User's default group ID.
          "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
          "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
        },
      ],
      "groupViews": [ # [Output Only] A list of all groups within a project.
        { # A detailed view of a Linux group.
          "groupName": "A String", # [Output Only] Group name.
          "gid": 42, # [Output Only] The Group ID.
          "members": [ # [Output Only] List of user accounts that belong to the group.
            "A String",
          ],
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_alpha.users.html000066400000000000000000001514001300622755700270320ustar00rootroot00000000000000

Cloud User Accounts API . users

Instance Methods

addPublicKey(project, user, body)

Adds a public key to the specified User resource with the data included in the request.

delete(project, user)

Deletes the specified User resource.

get(project, user)

Returns the specified User resource.

getIamPolicy(project, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body)

Creates a User resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of users contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removePublicKey(project, user, fingerprint)

Removes the specified public key from the user.

setIamPolicy(project, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addPublicKey(project, user, body) 
Adds a public key to the specified User resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A public key for authenticating to guests.
  "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
  "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, user) 
Deletes the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, user) 
Returns the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to return. (required)

Returns:
  An object of the form:

    { # A User resource.
      "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "publicKeys": [ # [Output Only] Public keys that this user may use to login.
        { # A public key for authenticating to guests.
          "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
          "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
        },
      ],
      "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
        "A String",
      ],
      "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
getIamPolicy(project, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, body) 
Creates a User resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A User resource.
    "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "publicKeys": [ # [Output Only] Public keys that this user may use to login.
      { # A public key for authenticating to guests.
        "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
        "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
      },
    ],
    "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
      "A String",
    ],
    "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of users contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of User resources.
      { # A User resource.
          "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "publicKeys": [ # [Output Only] Public keys that this user may use to login.
            { # A public key for authenticating to guests.
              "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
              "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
              "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
            },
          ],
          "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
            "A String",
          ],
          "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removePublicKey(project, user, fingerprint) 
Removes the specified public key from the user.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
setIamPolicy(project, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
        "A String",
      ],
      "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # The object of the condition. Exactly one of these must be set.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_beta.globalAccountsOperations.html000066400000000000000000000373071300622755700325340ustar00rootroot00000000000000

Cloud User Accounts API . globalAccountsOperations

Instance Methods

delete(project, operation)

Deletes the specified operation resource.

get(project, operation)

Retrieves the specified operation resource.

list(project, orderBy=None, 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, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified operation resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
      },
    ],
    "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_beta.groups.html000066400000000000000000000711741300622755700270470ustar00rootroot00000000000000

Cloud User Accounts API . groups

Instance Methods

addMember(project, groupName, body)

Adds users to the specified group.

delete(project, groupName)

Deletes the specified Group resource.

get(project, groupName)

Returns the specified Group resource.

insert(project, body)

Creates a Group resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of groups contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeMember(project, groupName, body)

Removes users from the specified group.

Method Details

addMember(project, groupName, body) 
Adds users to the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to add.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, groupName) 
Deletes the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, groupName) 
Returns the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to return. (required)

Returns:
  An object of the form:

    { # A Group resource.
      "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
insert(project, body) 
Creates a Group resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Group resource.
    "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of groups contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of Group resources.
      { # A Group resource.
          "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removeMember(project, groupName, body) 
Removes users from the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to remove.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_beta.html000066400000000000000000000051571300622755700255270ustar00rootroot00000000000000

Cloud User Accounts API

Instance Methods

globalAccountsOperations()

Returns the globalAccountsOperations Resource.

groups()

Returns the groups Resource.

linux()

Returns the linux Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_beta.linux.html000066400000000000000000000161621300622755700266630ustar00rootroot00000000000000

Cloud User Accounts API . linux

Instance Methods

getAuthorizedKeysView(project, zone, user, instance, login=None)

Returns a list of authorized public keys for a specific user account.

getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)

Retrieves a list of user accounts for an instance within a specific project.

Method Details

getAuthorizedKeysView(project, zone, user, instance, login=None) 
Returns a list of authorized public keys for a specific user account.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  user: string, The user account for which you want to get a list of authorized public keys. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
  login: boolean, Whether the view was requested as part of a user-initiated login.

Returns:
  An object of the form:

    {
    "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
      "keys": [ # [Output Only] The list of authorized public keys in SSH format.
        "A String",
      ],
      "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
    },
  }
getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None) 
Retrieves a list of user accounts for an instance within a specific project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Returns:
  An object of the form:

    {
    "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
      "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
      "userViews": [ # [Output Only] A list of all users within a project.
        { # A detailed view of a Linux user account.
          "username": "A String", # [Output Only] The username of the account.
          "shell": "A String", # [Output Only] The path to the login shell for this account.
          "uid": 42, # [Output Only] User ID.
          "gid": 42, # [Output Only] User's default group ID.
          "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
          "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
        },
      ],
      "groupViews": [ # [Output Only] A list of all groups within a project.
        { # A detailed view of a Linux group.
          "groupName": "A String", # [Output Only] Group name.
          "gid": 42, # [Output Only] The Group ID.
          "members": [ # [Output Only] List of user accounts that belong to the group.
            "A String",
          ],
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_beta.users.html000066400000000000000000001003621300622755700266610ustar00rootroot00000000000000

Cloud User Accounts API . users

Instance Methods

addPublicKey(project, user, body)

Adds a public key to the specified User resource with the data included in the request.

delete(project, user)

Deletes the specified User resource.

get(project, user)

Returns the specified User resource.

insert(project, body)

Creates a User resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of users contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removePublicKey(project, user, fingerprint)

Removes the specified public key from the user.

Method Details

addPublicKey(project, user, body) 
Adds a public key to the specified User resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A public key for authenticating to guests.
  "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
  "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, user) 
Deletes the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, user) 
Returns the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to return. (required)

Returns:
  An object of the form:

    { # A User resource.
      "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "publicKeys": [ # [Output Only] Public keys that this user may use to login.
        { # A public key for authenticating to guests.
          "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
          "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
        },
      ],
      "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
        "A String",
      ],
      "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
insert(project, body) 
Creates a User resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A User resource.
    "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "publicKeys": [ # [Output Only] Public keys that this user may use to login.
      { # A public key for authenticating to guests.
        "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
        "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
      },
    ],
    "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
      "A String",
    ],
    "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of users contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of User resources.
      { # A User resource.
          "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "publicKeys": [ # [Output Only] Public keys that this user may use to login.
            { # A public key for authenticating to guests.
              "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
              "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
              "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
            },
          ],
          "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
            "A String",
          ],
          "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removePublicKey(project, user, fingerprint) 
Removes the specified public key from the user.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_alpha.globalAccountsOperations.html000066400000000000000000000373171300622755700334110ustar00rootroot00000000000000

Cloud User Accounts API . globalAccountsOperations

Instance Methods

delete(project, operation)

Deletes the specified operation resource.

get(project, operation)

Retrieves the specified operation resource.

list(project, orderBy=None, 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, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified operation resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
      },
    ],
    "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_alpha.groups.html000066400000000000000000001422201300622755700277120ustar00rootroot00000000000000

Cloud User Accounts API . groups

Instance Methods

addMember(project, groupName, body)

Adds users to the specified group.

delete(project, groupName)

Deletes the specified Group resource.

get(project, groupName)

Returns the specified Group resource.

getIamPolicy(project, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body)

Creates a Group resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of groups contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeMember(project, groupName, body)

Removes users from the specified group.

setIamPolicy(project, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addMember(project, groupName, body) 
Adds users to the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to add.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, groupName) 
Deletes the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, groupName) 
Returns the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to return. (required)

Returns:
  An object of the form:

    { # A Group resource.
      "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
getIamPolicy(project, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, body) 
Creates a Group resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Group resource.
    "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of groups contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of Group resources.
      { # A Group resource.
          "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removeMember(project, groupName, body) 
Removes users from the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to remove.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
setIamPolicy(project, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
        "A String",
      ],
      "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # The object of the condition. Exactly one of these must be set.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_alpha.html000066400000000000000000000052031300622755700263730ustar00rootroot00000000000000

Cloud User Accounts API

Instance Methods

globalAccountsOperations()

Returns the globalAccountsOperations Resource.

groups()

Returns the groups Resource.

linux()

Returns the linux Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_alpha.linux.html000066400000000000000000000161721300622755700275400ustar00rootroot00000000000000

Cloud User Accounts API . linux

Instance Methods

getAuthorizedKeysView(project, zone, user, instance, login=None)

Returns a list of authorized public keys for a specific user account.

getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)

Retrieves a list of user accounts for an instance within a specific project.

Method Details

getAuthorizedKeysView(project, zone, user, instance, login=None) 
Returns a list of authorized public keys for a specific user account.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  user: string, The user account for which you want to get a list of authorized public keys. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
  login: boolean, Whether the view was requested as part of a user-initiated login.

Returns:
  An object of the form:

    {
    "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
      "keys": [ # [Output Only] The list of authorized public keys in SSH format.
        "A String",
      ],
      "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
    },
  }
getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None) 
Retrieves a list of user accounts for an instance within a specific project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Returns:
  An object of the form:

    {
    "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
      "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
      "userViews": [ # [Output Only] A list of all users within a project.
        { # A detailed view of a Linux user account.
          "username": "A String", # [Output Only] The username of the account.
          "shell": "A String", # [Output Only] The path to the login shell for this account.
          "uid": 42, # [Output Only] User ID.
          "gid": 42, # [Output Only] User's default group ID.
          "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
          "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
        },
      ],
      "groupViews": [ # [Output Only] A list of all groups within a project.
        { # A detailed view of a Linux group.
          "groupName": "A String", # [Output Only] Group name.
          "gid": 42, # [Output Only] The Group ID.
          "members": [ # [Output Only] List of user accounts that belong to the group.
            "A String",
          ],
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_alpha.users.html000066400000000000000000001514061300622755700275420ustar00rootroot00000000000000

Cloud User Accounts API . users

Instance Methods

addPublicKey(project, user, body)

Adds a public key to the specified User resource with the data included in the request.

delete(project, user)

Deletes the specified User resource.

get(project, user)

Returns the specified User resource.

getIamPolicy(project, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body)

Creates a User resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of users contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removePublicKey(project, user, fingerprint)

Removes the specified public key from the user.

setIamPolicy(project, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addPublicKey(project, user, body) 
Adds a public key to the specified User resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A public key for authenticating to guests.
  "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
  "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, user) 
Deletes the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, user) 
Returns the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to return. (required)

Returns:
  An object of the form:

    { # A User resource.
      "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "publicKeys": [ # [Output Only] Public keys that this user may use to login.
        { # A public key for authenticating to guests.
          "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
          "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
        },
      ],
      "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
        "A String",
      ],
      "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
getIamPolicy(project, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, body) 
Creates a User resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A User resource.
    "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "publicKeys": [ # [Output Only] Public keys that this user may use to login.
      { # A public key for authenticating to guests.
        "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
        "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
      },
    ],
    "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
      "A String",
    ],
    "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of users contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of User resources.
      { # A User resource.
          "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "publicKeys": [ # [Output Only] Public keys that this user may use to login.
            { # A public key for authenticating to guests.
              "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
              "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
              "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
            },
          ],
          "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
            "A String",
          ],
          "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removePublicKey(project, user, fingerprint) 
Removes the specified public key from the user.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
setIamPolicy(project, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
        "A String",
      ],
      "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # The object of the condition. Exactly one of these must be set.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
          "A String",
        ],
        "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # The object of the condition. Exactly one of these must be set.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_beta.globalAccountsOperations.html000066400000000000000000000373151300622755700332350ustar00rootroot00000000000000

Cloud User Accounts API . globalAccountsOperations

Instance Methods

delete(project, operation)

Deletes the specified operation resource.

get(project, operation)

Retrieves the specified operation resource.

list(project, orderBy=None, 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, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified operation resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
      },
    ],
    "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_beta.groups.html000066400000000000000000000712021300622755700275410ustar00rootroot00000000000000

Cloud User Accounts API . groups

Instance Methods

addMember(project, groupName, body)

Adds users to the specified group.

delete(project, groupName)

Deletes the specified Group resource.

get(project, groupName)

Returns the specified Group resource.

insert(project, body)

Creates a Group resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of groups contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeMember(project, groupName, body)

Removes users from the specified group.

Method Details

addMember(project, groupName, body) 
Adds users to the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to add.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, groupName) 
Deletes the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, groupName) 
Returns the specified Group resource.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the Group resource to return. (required)

Returns:
  An object of the form:

    { # A Group resource.
      "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
insert(project, body) 
Creates a Group resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Group resource.
    "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of groups contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of Group resources.
      { # A Group resource.
          "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removeMember(project, groupName, body) 
Removes users from the specified group.

Args:
  project: string, Project ID for this request. (required)
  groupName: string, Name of the group for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "users": [ # Fully-qualified URLs of the User resources to remove.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_beta.html000066400000000000000000000051761300622755700262320ustar00rootroot00000000000000

Cloud User Accounts API

Instance Methods

globalAccountsOperations()

Returns the globalAccountsOperations Resource.

groups()

Returns the groups Resource.

linux()

Returns the linux Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_beta.linux.html000066400000000000000000000161701300622755700273640ustar00rootroot00000000000000

Cloud User Accounts API . linux

Instance Methods

getAuthorizedKeysView(project, zone, user, instance, login=None)

Returns a list of authorized public keys for a specific user account.

getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)

Retrieves a list of user accounts for an instance within a specific project.

Method Details

getAuthorizedKeysView(project, zone, user, instance, login=None) 
Returns a list of authorized public keys for a specific user account.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  user: string, The user account for which you want to get a list of authorized public keys. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
  login: boolean, Whether the view was requested as part of a user-initiated login.

Returns:
  An object of the form:

    {
    "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
      "keys": [ # [Output Only] The list of authorized public keys in SSH format.
        "A String",
      ],
      "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
    },
  }
getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None) 
Retrieves a list of user accounts for an instance within a specific project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Returns:
  An object of the form:

    {
    "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
      "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
      "userViews": [ # [Output Only] A list of all users within a project.
        { # A detailed view of a Linux user account.
          "username": "A String", # [Output Only] The username of the account.
          "shell": "A String", # [Output Only] The path to the login shell for this account.
          "uid": 42, # [Output Only] User ID.
          "gid": 42, # [Output Only] User's default group ID.
          "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
          "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
        },
      ],
      "groupViews": [ # [Output Only] A list of all groups within a project.
        { # A detailed view of a Linux group.
          "groupName": "A String", # [Output Only] Group name.
          "gid": 42, # [Output Only] The Group ID.
          "members": [ # [Output Only] List of user accounts that belong to the group.
            "A String",
          ],
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/clouduseraccounts_vm_beta.users.html000066400000000000000000001003701300622755700273620ustar00rootroot00000000000000

Cloud User Accounts API . users

Instance Methods

addPublicKey(project, user, body)

Adds a public key to the specified User resource with the data included in the request.

delete(project, user)

Deletes the specified User resource.

get(project, user)

Returns the specified User resource.

insert(project, body)

Creates a User resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of users contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removePublicKey(project, user, fingerprint)

Removes the specified public key from the user.

Method Details

addPublicKey(project, user, body) 
Adds a public key to the specified User resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A public key for authenticating to guests.
  "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
  "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
delete(project, user) 
Deletes the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
get(project, user) 
Returns the specified User resource.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user resource to return. (required)

Returns:
  An object of the form:

    { # A User resource.
      "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
      "name": "A String", # Name of the resource; provided by the client when the resource is created.
      "publicKeys": [ # [Output Only] Public keys that this user may use to login.
        { # A public key for authenticating to guests.
          "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
          "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
        },
      ],
      "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
        "A String",
      ],
      "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    }
insert(project, body) 
Creates a User resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A User resource.
    "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
    "name": "A String", # Name of the resource; provided by the client when the resource is created.
    "publicKeys": [ # [Output Only] Public keys that this user may use to login.
      { # A public key for authenticating to guests.
        "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
        "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
      },
    ],
    "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
      "A String",
    ],
    "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of users contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # [Output Only] A list of User resources.
      { # A User resource.
          "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
          "name": "A String", # Name of the resource; provided by the client when the resource is created.
          "publicKeys": [ # [Output Only] Public keys that this user may use to login.
            { # A public key for authenticating to guests.
              "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
              "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
              "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
            },
          ],
          "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
            "A String",
          ],
          "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        },
    ],
    "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for 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.
removePublicKey(project, user, fingerprint) 
Removes the specified public key from the user.

Args:
  project: string, Project ID for this request. (required)
  user: string, Name of the user for this request. (required)
  fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.addresses.html000066400000000000000000001027041300622755700255600ustar00rootroot00000000000000

Compute Engine API . addresses

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of addresses.

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, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of addresses contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of addresses.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped address lists.
      "a_key": { # [Output Only] Name of the scope containing this set of addresses.
        "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "addresses": [ # [Output Only] List of addresses contained in this scope.
          { # A reserved address resource.
              "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
              "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
                  #
                  # To see the latest fingerprint, make a get() request to retrieve an Address.
              "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
                "a_key": "A String",
              },
              "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
              "address": "A String", # The static external IP address represented by this resource.
              "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
              "users": [ # [Output Only] The URLs of the resources that are using this address.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, Project ID for this request. (required)
  region: string, Name of the region for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, address) 
Returns the specified address resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve an Address.
      "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
      "address": "A String", # The static external IP address represented by this resource.
      "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
      "users": [ # [Output Only] The URLs of the resources that are using this address.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates an address resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A reserved address resource.
    "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve an Address.
    "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
    "address": "A String", # The static external IP address represented by this resource.
    "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
    "users": [ # [Output Only] The URLs of the resources that are using this address.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of addresses contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of addresses.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of addresses.
      { # A reserved address resource.
          "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve an Address.
          "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
          "address": "A String", # The static external IP address represented by this resource.
          "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
          "users": [ # [Output Only] The URLs of the resources that are using this address.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.autoscalers.html000066400000000000000000002373501300622755700261360ustar00rootroot00000000000000

Compute Engine API . autoscalers

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of autoscalers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, autoscaler)

Deletes the specified autoscaler.

get(project, zone, autoscaler)

Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

insert(project, zone, body)

Creates an autoscaler in the specified project using the data included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of autoscalers contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, zone, autoscaler, body)

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, zone, body, autoscaler=None)

Updates an autoscaler in the specified project using the data included in the request.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of autoscalers.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped autoscaler lists.
      "a_key": { # [Output Only] Name of the scope containing this set of autoscalers.
        "warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "autoscalers": [ # [Output Only] List of autoscalers contained in this scope.
          { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
              "status": "A String", # [Output Only] The status of the autoscaler configuration.
              "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
              "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
              "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
                  #
                  # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
                "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
                "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                    #
                    # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
                "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
                  "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
                },
                "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
                  "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
                  "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
                  "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
                    "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
                    "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
                  },
                },
                "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
                  { # Custom utilization metric policy.
                    "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                        #
                        # For example, the following is a valid metric:
                        # compute.googleapis.com/instance/network/received_bytes_count
                        # The following is not a valid metric because it does not increase or decrease based on usage:
                        # compute.googleapis.com/instance/cpu/reserved_cores
                    "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                    "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
                  },
                ],
                "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
                  "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                      #
                      # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                      #
                      # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
                },
                "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
              },
              "target": "A String", # URL of the managed instance group that this autoscaler will scale.
              "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
                {
                  "message": "A String", # The status message.
                  "type": "A String", # The type of error returned.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, zone, autoscaler) 
Deletes the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, autoscaler) 
Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to return. (required)

Returns:
  An object of the form:

    { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
      "status": "A String", # [Output Only] The status of the autoscaler configuration.
      "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
      "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
      "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
          #
          # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
        "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
            #
            # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
        "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
          "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
        },
        "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
          "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
          "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
          "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
            "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
            "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
          },
        },
        "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
          { # Custom utilization metric policy.
            "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                #
                # For example, the following is a valid metric:
                # compute.googleapis.com/instance/network/received_bytes_count
                # The following is not a valid metric because it does not increase or decrease based on usage:
                # compute.googleapis.com/instance/cpu/reserved_cores
            "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
            "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
          },
        ],
        "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
          "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
              #
              # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
              #
              # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
        },
        "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
      },
      "target": "A String", # URL of the managed instance group that this autoscaler will scale.
      "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        {
          "message": "A String", # The status message.
          "type": "A String", # The type of error returned.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, zone, body) 
Creates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
        "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
        "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
        "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
          "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
          "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
        },
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of autoscalers contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Autoscaler resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of Autoscaler resources.
      { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
          "status": "A String", # [Output Only] The status of the autoscaler configuration.
          "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
          "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
          "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
              #
              # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
            "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
            "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                #
                # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
            "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
              "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
            },
            "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
              "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
              "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
              "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
                "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
                "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
              },
            },
            "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
              { # Custom utilization metric policy.
                "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                    #
                    # For example, the following is a valid metric:
                    # compute.googleapis.com/instance/network/received_bytes_count
                    # The following is not a valid metric because it does not increase or decrease based on usage:
                    # compute.googleapis.com/instance/cpu/reserved_cores
                "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
              },
            ],
            "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
              "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                  #
                  # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                  #
                  # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
            },
            "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
          },
          "target": "A String", # URL of the managed instance group that this autoscaler will scale.
          "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
            {
              "message": "A String", # The status message.
              "type": "A String", # The type of error returned.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, zone, autoscaler, body) 
Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
        "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
        "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
        "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
          "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
          "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
        },
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, zone, body, autoscaler=None) 
Updates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
        "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
        "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
        "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
          "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
          "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
        },
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  autoscaler: string, Name of the autoscaler to update.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.backendBuckets.html000066400000000000000000001521101300622755700265070ustar00rootroot00000000000000

Compute Engine API . backendBuckets

Instance Methods

delete(project, backendBucket)

Deletes the specified BackendBucket resource.

get(project, backendBucket)

Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.

getIamPolicy(project, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body)

Creates a BackendBucket resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of BackendBucket resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, backendBucket, body)

Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.

setIamPolicy(project, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, backendBucket, body)

Updates the specified BackendBucket resource with the data included in the request.

Method Details

delete(project, backendBucket) 
Deletes the specified BackendBucket resource.

Args:
  project: string, Project ID for this request. (required)
  backendBucket: string, Name of the BackendBucket resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, backendBucket) 
Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  backendBucket: string, Name of the BackendBucket resource to return. (required)

Returns:
  An object of the form:

    { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
      "kind": "compute#backendBucket", # Type of the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
      "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
      "bucketName": "A String", # Cloud Storage bucket name.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getIamPolicy(project, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, body) 
Creates a BackendBucket resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
    "kind": "compute#backendBucket", # Type of the resource.
    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
    "bucketName": "A String", # Cloud Storage bucket name.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of BackendBucket resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendBucket resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of BackendBucket resources.
      { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
          "kind": "compute#backendBucket", # Type of the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
          "bucketName": "A String", # Cloud Storage bucket name.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#backendBucketList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, backendBucket, body) 
Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  backendBucket: string, Name of the BackendBucket resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
    "kind": "compute#backendBucket", # Type of the resource.
    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
    "bucketName": "A String", # Cloud Storage bucket name.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setIamPolicy(project, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
        "A String",
      ],
      "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # DEPRECATED. Use 'values' instead.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, backendBucket, body) 
Updates the specified BackendBucket resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  backendBucket: string, Name of the BackendBucket resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
    "kind": "compute#backendBucket", # Type of the resource.
    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
    "bucketName": "A String", # Cloud Storage bucket name.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.backendServices.html000066400000000000000000002673571300622755700267160ustar00rootroot00000000000000

Compute Engine API . backendServices

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, backendService)

Deletes the specified BackendService resource.

get(project, backendService)

Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

getHealth(project, backendService, body)

Gets the most recent health check results for this BackendService.

insert(project, body)

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of BackendService resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, backendService, body)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, backendService, body)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Args:
  project: string, Name of the project scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendServicesScopedList.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": { # A map of scoped BackendService lists.
      "a_key": { # Name of the scope containing this set of BackendServices.
        "warning": { # Informational warning which replaces the list of backend services when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "backendServices": [ # List of BackendServices contained in this scope.
          { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
              "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
                "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
                  "A String",
                ],
              },
              "connectionDraining": { # Message containing connection draining configuration.
                "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
              },
              "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
                  #
                  # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
                  #
                  # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
              "loadBalancingScheme": "A String",
              "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
                  #
                  # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
                "A String",
              ],
              "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
                  #
                  # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
                  #
                  # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
                  #
                  # When the protocol is UDP, this field is not used.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
              "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
                  #
                  # When the load balancing scheme is INTERNAL, this field is not used.
              "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
                  #
                  # When the load balancing scheme is INTERNAL, this field is not used.
              "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
                  #
                  # This cannot be used for internal load balancing.
              "backends": [ # The list of backends that serve this BackendService.
                { # Message containing information of one individual backend.
                  "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                      #
                      # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                      #
                      # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
                  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
                  "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                      #
                      # This cannot be used for internal load balancing.
                  "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                      #
                      # This cannot be used for internal load balancing.
                  "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                      #
                      # This cannot be used for internal load balancing.
                },
              ],
              "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
                "oauth2ClientId": "A String",
                "enabled": True or False,
                "oauth2ClientSecret": "A String",
                "oauth2ClientSecretSha256": "A String",
              },
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
                "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
                  "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
                  "includeHost": True or False, # If true, requests to different hosts will be cached separately.
                  "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
                    "A String",
                  ],
                  "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
                    "A String",
                  ],
                  "includeProtocol": True or False, # If true, http and https requests will be cached separately.
                },
              },
              "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
              "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
                  #
                  # When the load balancing scheme is INTERNAL, this field is not used.
              "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            },
        ],
      },
    },
    "kind": "compute#backendServiceAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, backendService) 
Deletes the specified BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, backendService) 
Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to return. (required)

Returns:
  An object of the form:

    { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
      "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
        "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
          "A String",
        ],
      },
      "connectionDraining": { # Message containing connection draining configuration.
        "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
      },
      "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
          #
          # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
          #
          # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
      "loadBalancingScheme": "A String",
      "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
          #
          # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
        "A String",
      ],
      "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
          #
          # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
          #
          # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
          #
          # When the protocol is UDP, this field is not used.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
      "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
          #
          # This cannot be used for internal load balancing.
      "backends": [ # The list of backends that serve this BackendService.
        { # Message containing information of one individual backend.
          "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
              #
              # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
              #
              # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
              #
              # This cannot be used for internal load balancing.
        },
      ],
      "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
        "oauth2ClientId": "A String",
        "enabled": True or False,
        "oauth2ClientSecret": "A String",
        "oauth2ClientSecretSha256": "A String",
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
        "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
          "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
          "includeHost": True or False, # If true, requests to different hosts will be cached separately.
          "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
            "A String",
          ],
          "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
            "A String",
          ],
          "includeProtocol": True or False, # If true, http and https requests will be cached separately.
        },
      },
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
      "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    }
getHealth(project, backendService, body) 
Gets the most recent health check results for this BackendService.

Args:
  project: string, A parameter (required)
  backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
  }


Returns:
  An object of the form:

    {
    "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, body) 
Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
      "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
        "A String",
      ],
    },
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "loadBalancingScheme": "A String",
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
      "oauth2ClientId": "A String",
      "enabled": True or False,
      "oauth2ClientSecret": "A String",
      "oauth2ClientSecretSha256": "A String",
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
      "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
        "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
        "includeHost": True or False, # If true, requests to different hosts will be cached separately.
        "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "includeProtocol": True or False, # If true, http and https requests will be cached separately.
      },
    },
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of BackendService resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendService resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of BackendService resources.
      { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
          "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
            "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
              "A String",
            ],
          },
          "connectionDraining": { # Message containing connection draining configuration.
            "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
          },
          "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
              #
              # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
              #
              # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
          "loadBalancingScheme": "A String",
          "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
              #
              # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
            "A String",
          ],
          "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
              #
              # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
              #
              # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
              #
              # When the protocol is UDP, this field is not used.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
          "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
              #
              # This cannot be used for internal load balancing.
          "backends": [ # The list of backends that serve this BackendService.
            { # Message containing information of one individual backend.
              "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                  #
                  # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                  #
                  # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                  #
                  # This cannot be used for internal load balancing.
            },
          ],
          "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
            "oauth2ClientId": "A String",
            "enabled": True or False,
            "oauth2ClientSecret": "A String",
            "oauth2ClientSecretSha256": "A String",
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
            "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
              "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
              "includeHost": True or False, # If true, requests to different hosts will be cached separately.
              "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
                "A String",
              ],
              "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
                "A String",
              ],
              "includeProtocol": True or False, # If true, http and https requests will be cached separately.
            },
          },
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
          "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        },
    ],
    "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, backendService, body) 
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
      "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
        "A String",
      ],
    },
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "loadBalancingScheme": "A String",
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
      "oauth2ClientId": "A String",
      "enabled": True or False,
      "oauth2ClientSecret": "A String",
      "oauth2ClientSecretSha256": "A String",
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
      "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
        "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
        "includeHost": True or False, # If true, requests to different hosts will be cached separately.
        "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "includeProtocol": True or False, # If true, http and https requests will be cached separately.
      },
    },
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, backendService, body) 
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
      "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
        "A String",
      ],
    },
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "loadBalancingScheme": "A String",
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
      "oauth2ClientId": "A String",
      "enabled": True or False,
      "oauth2ClientSecret": "A String",
      "oauth2ClientSecretSha256": "A String",
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
      "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
        "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
        "includeHost": True or False, # If true, requests to different hosts will be cached separately.
        "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "includeProtocol": True or False, # If true, http and https requests will be cached separately.
      },
    },
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.clientSslPolicies.html000066400000000000000000000041071300622755700272310ustar00rootroot00000000000000

Compute Engine API . clientSslPolicies

Instance Methods

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.diskTypes.html000066400000000000000000000436531300622755700255710ustar00rootroot00000000000000

Compute Engine API . diskTypes

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of disk types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, diskType)

Returns the specified disk type. Get a list of available disk types by making a list() request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of disk types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of disk types.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped disk type lists.
      "a_key": { # [Output Only] Name of the scope containing this set of disk types.
        "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "diskTypes": [ # [Output Only] List of disk types contained in this scope.
          { # A DiskType resource.
            "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
            "description": "A String", # [Output Only] An optional description of this resource.
            "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
            "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
            "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
      },
    },
    "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, diskType) 
Returns the specified disk type. Get a list of available disk types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  diskType: string, Name of the disk type to return. (required)

Returns:
  An object of the form:

    { # A DiskType resource.
    "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
    "description": "A String", # [Output Only] An optional description of this resource.
    "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
    "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
    "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of disk types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of disk types.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Disk Type resources.
      { # A DiskType resource.
        "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
        "description": "A String", # [Output Only] An optional description of this resource.
        "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
        "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.disks.html000066400000000000000000002507741300622755700247330ustar00rootroot00000000000000

Compute Engine API . disks

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of persistent disks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

createSnapshot(project, zone, disk, body, guestFlush=None)

Creates a snapshot of a specified persistent disk.

delete(project, zone, disk)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

get(project, zone, disk)

Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

insert(project, zone, body, sourceImage=None)

Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of persistent disks contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

resize(project, zone, disk, body)

Resizes the specified persistent disk.

setLabels(project, zone, resource, body)

Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of persistent disks.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped disk lists.
      "a_key": { # [Output Only] Name of the scope containing this set of disks.
        "disks": [ # [Output Only] List of disks contained in this scope.
          { # A Disk resource.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
                "a_key": "A String",
              },
              "licenses": [ # Any applicable publicly visible licenses.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
                "A String",
              ],
              "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
                  #
                  # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
                  #
                  # Customer-supplied encryption keys do not protect access to metadata of the disk.
                  #
                  # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "zone": "A String", # [Output Only] URL of the zone where the disk resides.
              "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
              "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
              "status": "A String", # [Output Only] The status of disk creation.
              "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
                  # - projects/project/global/snapshots/snapshot
                  # - global/snapshots/snapshot
              "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
              "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
                  #
                  # To see the latest fingerprint, make a get() request to retrieve a disk.
              "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
              "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
                "A String",
              ],
              "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
              "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
                  #
                  # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
              "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
              "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "options": "A String", # Internal use only.
              "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
            },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, guestFlush=None) 
Creates a snapshot of a specified persistent disk.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to snapshot. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A persistent disk snapshot resource.
    "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
    "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
    "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
        # 
        # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a snapshot.
    "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
    "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  guestFlush: boolean, A parameter

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, zone, disk) 
Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, disk) 
Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to return. (required)

Returns:
  An object of the form:

    { # A Disk resource.
      "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "licenses": [ # Any applicable publicly visible licenses.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
        "A String",
      ],
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
          #
          # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "zone": "A String", # [Output Only] URL of the zone where the disk resides.
      "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
      "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
      "status": "A String", # [Output Only] The status of disk creation.
      "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
          # - projects/project/global/snapshots/snapshot
          # - global/snapshots/snapshot
      "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a disk.
      "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
      "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
        "A String",
      ],
      "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
      "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
          #
          # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
      "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
      "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "options": "A String", # Internal use only.
      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
      "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
          #
          # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
          #
          # projects/debian-cloud/global/images/family/debian-8
          #
          # Alternatively, use a specific version of a public operating system image:
          #
          # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
          #
          # To create a disk with a private image that you created, specify the image name in the following format:
          #
          # global/images/my-private-image
          #
          # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
          #
          # global/images/family/my-private-family
    }
insert(project, zone, body, sourceImage=None) 
Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Disk resource.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "licenses": [ # Any applicable publicly visible licenses.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
      "A String",
    ],
    "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
        # 
        # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "zone": "A String", # [Output Only] URL of the zone where the disk resides.
    "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
    "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
    "status": "A String", # [Output Only] The status of disk creation.
    "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
        # - projects/project/global/snapshots/snapshot
        # - global/snapshots/snapshot
    "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a disk.
    "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
    "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
      "A String",
    ],
    "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
    "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
        # 
        # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
    "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
    "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "options": "A String", # Internal use only.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        # 
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        # 
        # projects/debian-cloud/global/images/family/debian-8
        # 
        # Alternatively, use a specific version of a public operating system image:
        # 
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        # 
        # To create a disk with a private image that you created, specify the image name in the following format:
        # 
        # global/images/my-private-image
        # 
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        # 
        # global/images/family/my-private-family
  }

  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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of persistent disks contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of Disk resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of persistent disks.
      { # A Disk resource.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "licenses": [ # Any applicable publicly visible licenses.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
            "A String",
          ],
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
              #
              # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "zone": "A String", # [Output Only] URL of the zone where the disk resides.
          "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
          "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
          "status": "A String", # [Output Only] The status of disk creation.
          "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
              # - projects/project/global/snapshots/snapshot
              # - global/snapshots/snapshot
          "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a disk.
          "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
          "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
            "A String",
          ],
          "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
          "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
              #
              # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
          "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
          "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "options": "A String", # Internal use only.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
        },
    ],
    "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
resize(project, zone, disk, body) 
Resizes the specified persistent disk.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, The name of the persistent disk. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sizeGb": "A String", # The new size of the persistent disk, which is specified in GB.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setLabels(project, zone, resource, body) 
Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # The labels to set for this resource.
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.firewalls.html000066400000000000000000001354001300622755700255720ustar00rootroot00000000000000

Compute Engine API . firewalls

Instance Methods

delete(project, firewall)

Deletes the specified firewall.

get(project, firewall)

Returns the specified firewall.

insert(project, body)

Creates a firewall rule in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of firewall rules 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 rule with the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, firewall, body)

Updates the specified firewall rule with the data included in the request.

Method Details

delete(project, firewall) 
Deletes the specified firewall.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, firewall) 
Returns the specified firewall.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to return. (required)

Returns:
  An object of the form:

    { # Represents a Firewall resource.
      "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
        "A String",
      ],
      "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
        "A String",
      ],
      "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
          # global/networks/default
          # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
          # - projects/myproject/global/networks/my-network
          # - global/networks/default
      "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
        {
          "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
          "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
              #
              # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
            "A String",
          ],
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a firewall rule in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of firewall rules available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of firewalls.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Firewall resources.
      { # Represents a Firewall resource.
          "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
            "A String",
          ],
          "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
            "A String",
          ],
          "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
              # global/networks/default
              # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
              # - projects/myproject/global/networks/my-network
              # - global/networks/default
          "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
            {
              "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
              "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
                  #
                  # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
                "A String",
              ],
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, firewall, body) 
Updates the specified firewall rule with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, firewall, body) 
Updates the specified firewall rule with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.forwardingRules.html000066400000000000000000001601201300622755700267540ustar00rootroot00000000000000

Compute Engine API . forwardingRules

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of forwarding rules.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, forwardingRule)

Deletes the specified ForwardingRule resource.

get(project, region, forwardingRule)

Returns the specified ForwardingRule resource.

insert(project, region, body)

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of ForwardingRule resources available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, region, forwardingRule, body)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of forwarding rules.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped forwarding rule lists.
      "a_key": { # Name of the scope containing this set of addresses.
        "forwardingRules": [ # List of forwarding rules contained in this scope.
          { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
              "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
              "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
                  #
                  # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
                  #
                  # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
              "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
                  #
                  # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
              "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
                "a_key": "A String",
              },
              "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
              "ports": [ # This field is not used for external load balancing.
                  #
                  # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
                  #
                  # You may specify a maximum of up to 5 ports.
                "A String",
              ],
              "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
                  #
                  # This field is not used for internal load balancing.
              "network": "A String", # This field is not used for external load balancing.
                  #
                  # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
              "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
                  #
                  # This field is only used for internal load balancing.
              "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
                  #
                  # This field is not used for internal load balancing.
              "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
                  #
                  # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
                  #
                  # This field is only used for internal load balancing.
              "backendService": "A String", # This field is not used for external load balancing.
                  #
                  # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
              "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
                  #
                  # When the load balancing scheme is INTERNAL
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, forwardingRule) 
Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, forwardingRule) 
Returns the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)

Returns:
  An object of the form:

    { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
      "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
          #
          # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
          #
          # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
      "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
      "ports": [ # This field is not used for external load balancing.
          #
          # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
          #
          # You may specify a maximum of up to 5 ports.
        "A String",
      ],
      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
          #
          # This field is not used for internal load balancing.
      "network": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
      "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
          #
          # This field is only used for internal load balancing.
      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
          #
          # This field is not used for internal load balancing.
      "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
          #
          # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          #
          # This field is only used for internal load balancing.
      "backendService": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
      "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
          #
          # When the load balancing scheme is INTERNAL
insert(project, region, body) 
Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for 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 ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
    "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
        # 
        # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
        # 
        # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
    "ports": [ # This field is not used for external load balancing.
        # 
        # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
        # 
        # You may specify a maximum of up to 5 ports.
      "A String",
    ],
    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
        # 
        # This field is not used for internal load balancing.
    "network": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
    "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
        # 
        # This field is only used for internal load balancing.
    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
        # 
        # This field is not used for internal load balancing.
    "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
        # 
        # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        # 
        # This field is only used for internal load balancing.
    "backendService": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
    "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
        # 
        # When the load balancing scheme is INTERNAL
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of ForwardingRule resources available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of ForwardingRule resources.
      { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
          "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
              #
              # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
              #
              # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
          "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
          "ports": [ # This field is not used for external load balancing.
              #
              # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
              #
              # You may specify a maximum of up to 5 ports.
            "A String",
          ],
          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
              #
              # This field is not used for internal load balancing.
          "network": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
          "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
              #
              # This field is only used for internal load balancing.
          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
              #
              # This field is not used for internal load balancing.
          "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
              #
              # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              #
              # This field is only used for internal load balancing.
          "backendService": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
          "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
              #
              # When the load balancing scheme is INTERNAL
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.
setTarget(project, region, forwardingRule, body) 
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.globalAddresses.html000066400000000000000000000614361300622755700267070ustar00rootroot00000000000000

Compute Engine API . globalAddresses

Instance Methods

delete(project, address)

Deletes the specified address resource.

get(project, address)

Returns the specified address resource. Get a list of available addresses by making a list() request.

insert(project, body)

Creates an address resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of global addresses.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, address) 
Deletes the specified address resource.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, address) 
Returns the specified address resource. Get a list of available addresses by making a list() request.

Args:
  project: string, Project ID for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve an Address.
      "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
      "address": "A String", # The static external IP address represented by this resource.
      "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
      "users": [ # [Output Only] The URLs of the resources that are using this address.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an address resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A reserved address resource.
    "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve an Address.
    "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
    "address": "A String", # The static external IP address represented by this resource.
    "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
    "users": [ # [Output Only] The URLs of the resources that are using this address.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of global addresses.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of addresses.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of addresses.
      { # A reserved address resource.
          "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve an Address.
          "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
          "address": "A String", # The static external IP address represented by this resource.
          "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
          "users": [ # [Output Only] The URLs of the resources that are using this address.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.globalForwardingRules.html000066400000000000000000001256371300622755700301130ustar00rootroot00000000000000

Compute Engine API . globalForwardingRules

Instance Methods

delete(project, forwardingRule)

Deletes the specified ForwardingRule resource.

get(project, forwardingRule)

Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

insert(project, body)

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of ForwardingRule resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, forwardingRule, body)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, forwardingRule) 
Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, forwardingRule) 
Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)

Returns:
  An object of the form:

    { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
      "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
          #
          # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
          #
          # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
      "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
      "ports": [ # This field is not used for external load balancing.
          #
          # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
          #
          # You may specify a maximum of up to 5 ports.
        "A String",
      ],
      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
          #
          # This field is not used for internal load balancing.
      "network": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
      "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
          #
          # This field is only used for internal load balancing.
      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
          #
          # This field is not used for internal load balancing.
      "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
          #
          # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          #
          # This field is only used for internal load balancing.
      "backendService": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
      "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
          #
          # When the load balancing scheme is INTERNAL
insert(project, body) 
Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
    "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
        # 
        # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
        # 
        # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
    "ports": [ # This field is not used for external load balancing.
        # 
        # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
        # 
        # You may specify a maximum of up to 5 ports.
      "A String",
    ],
    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
        # 
        # This field is not used for internal load balancing.
    "network": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
    "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
        # 
        # This field is only used for internal load balancing.
    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
        # 
        # This field is not used for internal load balancing.
    "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
        # 
        # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        # 
        # This field is only used for internal load balancing.
    "backendService": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
    "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
        # 
        # When the load balancing scheme is INTERNAL
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of ForwardingRule resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of ForwardingRule resources.
      { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
          "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
              #
              # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
              #
              # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
          "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
          "ports": [ # This field is not used for external load balancing.
              #
              # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
              #
              # You may specify a maximum of up to 5 ports.
            "A String",
          ],
          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
              #
              # This field is not used for internal load balancing.
          "network": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
          "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
              #
              # This field is only used for internal load balancing.
          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
              #
              # This field is not used for internal load balancing.
          "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
              #
              # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              #
              # This field is only used for internal load balancing.
          "backendService": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
          "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
              #
              # When the load balancing scheme is INTERNAL
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.
setTarget(project, forwardingRule, body) 
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.globalOperations.html000066400000000000000000000647351300622755700271220ustar00rootroot00000000000000

Compute Engine API . globalOperations

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of all operations.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, operation)

Deletes the specified Operations resource.

get(project, operation)

Retrieves the specified Operations resource. Get a list of operations by making a list() request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of all operations.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped operation lists.
      "a_key": { # [Output Only] Name of the scope containing this set of operations.
        "operations": [ # [Output Only] List of operations contained in this scope.
          { # An Operation resource, used to manage asynchronous API requests.
            "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
            "clientOperationId": "A String", # [Output Only] Reserved for future use.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
            "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
            "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
            "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
            "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
            "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
            "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
            "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
            "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
            "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
              {
                "message": "A String", # [Output Only] A human-readable description of the warning code.
                "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                    # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                  {
                    "value": "A String", # [Output Only] A warning data value corresponding to the key.
                    "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                  },
                ],
              },
            ],
            "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
            "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
            "name": "A String", # [Output Only] Name of the resource.
            "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
            "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
              "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                {
                  "message": "A String", # [Output Only] An optional, human-readable error message.
                  "code": "A String", # [Output Only] The error type identifier for this error.
                  "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
                },
              ],
            },
            "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified Operations resource. Get a list of operations by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.healthChecks.html000066400000000000000000001767201300622755700262020ustar00rootroot00000000000000

Compute Engine API . healthChecks

Instance Methods

delete(project, healthCheck)

Deletes the specified HealthCheck resource.

get(project, healthCheck)

Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

insert(project, body)

Creates a HealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, healthCheck, body)

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, healthCheck, body)

Updates a HealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, healthCheck) 
Deletes the specified HealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, healthCheck) 
Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
      "kind": "compute#healthCheck", # Type of the resource.
      "udpHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
        "port": 42, # The UDP port number for the health check request.
        "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
      "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
      "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
      "tcpHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 80.
        "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
      },
      "httpHealthCheck": {
        "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 80.
        "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
      },
      "httpsHealthCheck": {
        "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
      },
      "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
      "http2HealthCheck": {
        "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
      },
      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "sslHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
      },
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "udpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
      "port": 42, # The UDP port number for the health check request.
      "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "httpsHealthCheck": {
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HealthCheck resources.
      { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
          "kind": "compute#healthCheck", # Type of the resource.
          "udpHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
            "port": 42, # The UDP port number for the health check request.
            "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
          "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
          "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
          "tcpHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 80.
            "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
          },
          "httpHealthCheck": {
            "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 80.
            "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
          },
          "httpsHealthCheck": {
            "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
          },
          "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
          "http2HealthCheck": {
            "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
          },
          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "sslHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
          },
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#healthCheckList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, healthCheck, body) 
Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "udpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
      "port": 42, # The UDP port number for the health check request.
      "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "httpsHealthCheck": {
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, healthCheck, body) 
Updates a HealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "udpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
      "port": 42, # The UDP port number for the health check request.
      "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "httpsHealthCheck": {
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.hosts.html000066400000000000000000000540241300622755700247440ustar00rootroot00000000000000

Compute Engine API . hosts

Instance Methods

getIamPolicy(project, zone, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

setIamPolicy(project, zone, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

getIamPolicy(project, zone, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
setIamPolicy(project, zone, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
        "A String",
      ],
      "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # DEPRECATED. Use 'values' instead.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.html000066400000000000000000000240261300622755700236040ustar00rootroot00000000000000

Compute Engine API

Instance Methods

addresses()

Returns the addresses Resource.

autoscalers()

Returns the autoscalers Resource.

backendBuckets()

Returns the backendBuckets Resource.

backendServices()

Returns the backendServices Resource.

clientSslPolicies()

Returns the clientSslPolicies Resource.

diskTypes()

Returns the diskTypes Resource.

disks()

Returns the disks Resource.

firewalls()

Returns the firewalls Resource.

forwardingRules()

Returns the forwardingRules Resource.

globalAddresses()

Returns the globalAddresses Resource.

globalForwardingRules()

Returns the globalForwardingRules Resource.

globalOperations()

Returns the globalOperations Resource.

healthChecks()

Returns the healthChecks Resource.

hosts()

Returns the hosts Resource.

httpHealthChecks()

Returns the httpHealthChecks Resource.

httpsHealthChecks()

Returns the httpsHealthChecks Resource.

images()

Returns the images Resource.

instanceGroupManagers()

Returns the instanceGroupManagers Resource.

instanceGroups()

Returns the instanceGroups Resource.

instanceTemplates()

Returns the instanceTemplates Resource.

instances()

Returns the instances Resource.

licenses()

Returns the licenses Resource.

machineTypes()

Returns the machineTypes Resource.

networks()

Returns the networks Resource.

projects()

Returns the projects Resource.

regionAutoscalers()

Returns the regionAutoscalers Resource.

regionBackendServices()

Returns the regionBackendServices Resource.

regionDiskTypes()

Returns the regionDiskTypes Resource.

regionDisks()

Returns the regionDisks Resource.

regionInstanceGroupManagers()

Returns the regionInstanceGroupManagers Resource.

regionInstanceGroups()

Returns the regionInstanceGroups Resource.

regionOperations()

Returns the regionOperations Resource.

regions()

Returns the regions Resource.

routers()

Returns the routers Resource.

routes()

Returns the routes Resource.

snapshots()

Returns the snapshots Resource.

sslCertificates()

Returns the sslCertificates Resource.

subnetworks()

Returns the subnetworks Resource.

targetHttpProxies()

Returns the targetHttpProxies Resource.

targetHttpsProxies()

Returns the targetHttpsProxies Resource.

targetInstances()

Returns the targetInstances Resource.

targetPools()

Returns the targetPools Resource.

targetSslProxies()

Returns the targetSslProxies Resource.

targetTcpProxies()

Returns the targetTcpProxies Resource.

targetVpnGateways()

Returns the targetVpnGateways Resource.

urlMaps()

Returns the urlMaps Resource.

vpnTunnels()

Returns the vpnTunnels Resource.

zoneOperations()

Returns the zoneOperations Resource.

zones()

Returns the zones Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.httpHealthChecks.html000066400000000000000000001151201300622755700270250ustar00rootroot00000000000000

Compute Engine API . httpHealthChecks

Instance Methods

delete(project, httpHealthCheck)

Deletes the specified HttpHealthCheck resource.

get(project, httpHealthCheck)

Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

insert(project, body)

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HttpHealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, httpHealthCheck, body)

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, httpHealthCheck, body)

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, httpHealthCheck) 
Deletes the specified HttpHealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, httpHealthCheck) 
Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
      "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
      "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HttpHealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HttpHealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HttpHealthCheck resources.
      { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
          "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
          "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#httpHealthCheckList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
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, Project ID for 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 instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, httpHealthCheck, body) 
Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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 instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.httpsHealthChecks.html000066400000000000000000001145211300622755700272140ustar00rootroot00000000000000

Compute Engine API . httpsHealthChecks

Instance Methods

delete(project, httpsHealthCheck)

Deletes the specified HttpsHealthCheck resource.

get(project, httpsHealthCheck)

Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

insert(project, body)

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HttpsHealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, httpsHealthCheck, body)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, httpsHealthCheck, body)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, httpsHealthCheck) 
Deletes the specified HttpsHealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, httpsHealthCheck) 
Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
      "kind": "compute#httpsHealthCheck", # Type of the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
      "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 HTTPS health check request. The default value is 443.
      "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HttpsHealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HttpsHealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HttpsHealthCheck resources.
      { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
          "kind": "compute#httpsHealthCheck", # Type of the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
          "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 HTTPS health check request. The default value is 443.
          "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#httpsHealthCheckList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, httpsHealthCheck, body) 
Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, httpsHealthCheck, body) 
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.images.html000066400000000000000000002004311300622755700250440ustar00rootroot00000000000000

Compute Engine API . images

Instance Methods

delete(project, image)

Deletes the specified image.

deprecate(project, image, body)

Sets the deprecation status of an image.

get(project, image)

Returns the specified image. Get a list of available images by making a list() request.

getFromFamily(project, family)

Returns the latest image that is part of an image family and is not deprecated.

insert(project, body)

Creates an image in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setLabels(project, resource, body)

Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, image) 
Deletes the specified image.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deprecate(project, image, body) 
Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Args:
  project: string, Project ID for 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, image) 
Returns the specified image. Get a list of available images by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  image: string, Name of the image resource to return. (required)

Returns:
  An object of the form:

    { # An Image resource.
      "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
          # - projects/project/zones/zone/disks/disk
          # - zones/zone/disks/disk
      "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
      "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
      "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
      },
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve an image.
      "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
      "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
      "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
        { # Guest OS features.
          "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
        },
      ],
      "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
      "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
          #
          # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "rawDisk": { # The parameters of the raw disk image.
        "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
        "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
      },
      "licenses": [ # Any applicable license URI.
        "A String",
      ],
      "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getFromFamily(project, family) 
Returns the latest image that is part of an image family and is not deprecated.

Args:
  project: string, Project ID for this request. (required)
  family: string, Name of the image family to search for. (required)

Returns:
  An object of the form:

    { # An Image resource.
      "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
          # - projects/project/zones/zone/disks/disk
          # - zones/zone/disks/disk
      "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
      "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
      "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
      },
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve an image.
      "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
      "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
      "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
        { # Guest OS features.
          "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
        },
      ],
      "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
      "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
          #
          # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "rawDisk": { # The parameters of the raw disk image.
        "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
        "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
      },
      "licenses": [ # Any applicable license URI.
        "A String",
      ],
      "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an image in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Image resource.
    "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
        # - projects/project/zones/zone/disks/disk
        # - zones/zone/disks/disk
    "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
    "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
    "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve an image.
    "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
    "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
    "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
      { # Guest OS features.
        "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
      },
    ],
    "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
    "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
        # 
        # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "rawDisk": { # The parameters of the raw disk image.
      "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
      "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
    },
    "licenses": [ # Any applicable license URI.
      "A String",
    ],
    "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of images.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Image resources.
      { # An Image resource.
          "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
              # - projects/project/zones/zone/disks/disk
              # - zones/zone/disks/disk
          "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
          "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
          "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
          "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
          },
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve an image.
          "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
          "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
          "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
            { # Guest OS features.
              "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
            },
          ],
          "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
          "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
              #
              # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "rawDisk": { # The parameters of the raw disk image.
            "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
            "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
          },
          "licenses": [ # Any applicable license URI.
            "A String",
          ],
          "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#imageList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setLabels(project, resource, body) 
Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.instanceGroupManagers.html000066400000000000000000004676311300622755700301170ustar00rootroot00000000000000

Compute Engine API . instanceGroupManagers

Instance Methods

abandonInstances(project, zone, instanceGroupManager, body)

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of managed instance groups and groups them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroupManager)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

deleteInstances(project, zone, instanceGroupManager, body)

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

get(project, zone, instanceGroupManager)

Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

insert(project, zone, body)

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

listManagedInstances(project, zone, instanceGroupManager)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, zone, instanceGroupManager, body)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

recreateInstances(project, zone, instanceGroupManager, body)

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

resize(project, zone, instanceGroupManager, size)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

resizeAdvanced(project, zone, instanceGroupManager, body)

Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.

setAutoHealingPolicies(project, zone, instanceGroupManager, body)

Modifies the autohealing policies.

setInstanceTemplate(project, zone, instanceGroupManager, body)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

setTargetPools(project, zone, instanceGroupManager, body)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, zone, instanceGroupManager, body)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Method Details

abandonInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to abandon from the managed instance group.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of managed instance groups and groups them by zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of filtered managed instance group lists.
      "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
        "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
          { # An Instance Group Manager resource.
              "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
                "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
                "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
                "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                    #
                    # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
                "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
                "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
                "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
                "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
                "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
              },
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
              "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
                {
                  "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
                    "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                    "fixed": 42, # fixed must be non-negative.
                    "percent": 42, # percent must belong to [0, 100].
                  },
                  "instanceTemplate": "A String",
                  "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
                },
              ],
              "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
                {
                  "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
                  "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
                  "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
                    "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                    "fixed": 42, # fixed must be non-negative.
                    "percent": 42, # percent must belong to [0, 100].
                  },
                },
              ],
              "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
              "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
              "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
              "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
              "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
                "A String",
              ],
              "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
              "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
                "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
                "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
                "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
                "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
              },
              "updatePolicy": { # The update policy for this managed instance group.
                "type": "A String",
                "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
                  "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                  "fixed": 42, # fixed must be non-negative.
                  "percent": 42, # percent must belong to [0, 100].
                },
                "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
                "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
                  "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                  "fixed": 42, # fixed must be non-negative.
                  "percent": 42, # percent must belong to [0, 100].
                },
                "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
              },
              "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
              "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
              "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
              "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
                { # The named port. For example: .
                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
                  "port": 42, # The port number, which can be a value between 1 and 65535.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
              "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
              "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
              "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
      },
    },
    "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
    "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
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, zone, instanceGroupManager) 
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read  Deleting an instance group for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instanceGroupManager) 
Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
        "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
            #
            # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
        "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
        "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
        "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
      "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
        {
          "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
            "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
            "fixed": 42, # fixed must be non-negative.
            "percent": 42, # percent must belong to [0, 100].
          },
          "instanceTemplate": "A String",
          "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
        },
      ],
      "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
        {
          "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
          "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
          "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
            "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
            "fixed": 42, # fixed must be non-negative.
            "percent": 42, # percent must belong to [0, 100].
          },
        },
      ],
      "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
      "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
      "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
      "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
      "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
        "A String",
      ],
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
      "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
      },
      "updatePolicy": { # The update policy for this managed instance group.
        "type": "A String",
        "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
      },
      "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
      "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
      "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
      "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
      "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
      "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, zone, body) 
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
      {
        "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "instanceTemplate": "A String",
        "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
      },
    ],
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
    },
    "updatePolicy": { # The update policy for this managed instance group.
      "type": "A String",
      "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
      "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
    },
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of managed instance groups that are contained within the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # [Output Only] A list of managed instance groups.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of managed instance groups.
      { # An Instance Group Manager resource.
          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
            "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                #
                # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
            "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
            "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
            "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
          "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
            {
              "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
                "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                "fixed": 42, # fixed must be non-negative.
                "percent": 42, # percent must belong to [0, 100].
              },
              "instanceTemplate": "A String",
              "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
            },
          ],
          "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
            {
              "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
              "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
              "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
                "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                "fixed": 42, # fixed must be non-negative.
                "percent": 42, # percent must belong to [0, 100].
              },
            },
          ],
          "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
          "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
          "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
          "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
          "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
            "A String",
          ],
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
          "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
          },
          "updatePolicy": { # The update policy for this managed instance group.
            "type": "A String",
            "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
              "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
              "fixed": 42, # fixed must be non-negative.
              "percent": 42, # percent must belong to [0, 100].
            },
            "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
            "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
              "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
              "fixed": 42, # fixed must be non-negative.
              "percent": 42, # percent must belong to [0, 100].
            },
            "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
          },
          "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
          "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
          "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
          "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
          "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
          "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
listManagedInstances(project, zone, instanceGroupManager) 
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    {
    "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
      {
        "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
        "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
          "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
        },
        "tag": "A String", # [Output Only] Tag describing the version.
        "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
        "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
        "standbyMode": "A String", # [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
        "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
            # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
            # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
            # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
            # - RECREATING The managed instance group is recreating this instance.
            # - DELETING The managed instance group is permanently deleting this instance.
            # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
            # - RESTARTING The managed instance group is restarting the instance.
            # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
        "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
      },
    ],
  }
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, zone, instanceGroupManager, body) 
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the managed instance group. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
      {
        "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "instanceTemplate": "A String",
        "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
      },
    ],
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
    },
    "updatePolicy": { # The update policy for this managed instance group.
      "type": "A String",
      "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
      "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
    },
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
recreateInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to recreate.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resize(project, zone, instanceGroupManager, size) 
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resizeAdvanced(project, zone, instanceGroupManager, body) 
Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.

If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.
        # 
        # This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.
        # 
        # This flag is applicable only to the current resize request. It does not influence other resize requests in any way.
        # 
        # You can see which instances is being creating in which mode by calling the get or listManagedInstances API.
    "targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setAutoHealingPolicies(project, zone, instanceGroupManager, body) 
Modifies the autohealing policies.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "autoHealingPolicies": [
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setInstanceTemplate(project, zone, instanceGroupManager, body) 
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTargetPools(project, zone, instanceGroupManager, body) 
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, zone, instanceGroupManager, body) 
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the managed instance group. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
      {
        "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "instanceTemplate": "A String",
        "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
      },
    ],
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
    },
    "updatePolicy": { # The update policy for this managed instance group.
      "type": "A String",
      "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
      "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
    },
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.instanceGroups.html000066400000000000000000001572451300622755700266210ustar00rootroot00000000000000

Compute Engine API . instanceGroups

Instance Methods

addInstances(project, zone, instanceGroup, body)

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance groups and sorts them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroup)

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

get(project, zone, instanceGroup)

Returns the specified instance group. Get a list of available instance groups by making a list() request.

insert(project, zone, body)

Creates an instance group in the specified project using the parameters that are included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance groups that are located in the specified project and zone.

listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)

Lists the instances in the specified instance group.

listInstances_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeInstances(project, zone, instanceGroup, body)

Removes one or more instances from the specified instance group, but does not delete those instances.

setNamedPorts(project, zone, instanceGroup, body)

Sets the named ports for the specified instance group.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addInstances(project, zone, instanceGroup, body) 
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read  Adding instances for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where you are adding instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to add to the instance group.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance groups and sorts them by zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped instance group lists.
      "a_key": { # The name of the scope that contains this set of instance groups.
        "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
          {
              "size": 42, # [Output Only] The total number of instances in the instance group.
              "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
              "region": "A String", # The URL of the region where the instance group is located (for regional resources).
              "network": "A String", # The URL of the network to which all instances in the instance group belong.
              "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
              "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
              "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
                  #
                  # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
                  #
                  # Named ports apply to all instances in this instance group.
                { # The named port. For example: .
                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
                  "port": 42, # The port number, which can be a value between 1 and 65535.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
              "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
              "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
              "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
      },
    },
    "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
    "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
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, zone, instanceGroup) 
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read  Deleting an instance group for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instanceGroup) 
Returns the specified instance group. Get a list of available instance groups by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group. (required)

Returns:
  An object of the form:

    {
      "size": 42, # [Output Only] The total number of instances in the instance group.
      "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
      "region": "A String", # The URL of the region where the instance group is located (for regional resources).
      "network": "A String", # The URL of the network to which all instances in the instance group belong.
      "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
      "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
      "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
          #
          # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
          #
          # Named ports apply to all instances in this instance group.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
      "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
      "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, zone, body) 
Creates an instance group in the specified project using the parameters that are included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "size": 42, # [Output Only] The total number of instances in the instance group.
    "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
    "region": "A String", # The URL of the region where the instance group is located (for regional resources).
    "network": "A String", # The URL of the network to which all instances in the instance group belong.
    "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
    "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
        # 
        # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
        # 
        # Named ports apply to all instances in this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
    "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
    "name": "A String", # The name of the instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance groups that are located in the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of InstanceGroup resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of instance groups.
      {
          "size": 42, # [Output Only] The total number of instances in the instance group.
          "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
          "region": "A String", # The URL of the region where the instance group is located (for regional resources).
          "network": "A String", # The URL of the network to which all instances in the instance group belong.
          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
          "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
              #
              # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
              #
              # Named ports apply to all instances in this instance group.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
          "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
    "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Lists the instances in the specified instance group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
  }

  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances.
      {
        "status": "A String", # [Output Only] The status of the instance.
        "instance": "A String", # [Output Only] The URL of the instance.
        "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
          { # The named port. For example: .
            "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
            "port": 42, # The port number, which can be a value between 1 and 65535.
          },
        ],
      },
    ],
    "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
    "id": "A String", # [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.
  }
listInstances_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.
removeInstances(project, zone, instanceGroup, body) 
Removes one or more instances from the specified instance group, but does not delete those instances.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to remove from the instance group.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setNamedPorts(project, zone, instanceGroup, body) 
Sets the named ports for the specified instance group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where the named ports are updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "namedPorts": [ # The list of named ports to set for this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.instanceTemplates.html000066400000000000000000002336101300622755700272670ustar00rootroot00000000000000

Compute Engine API . instanceTemplates

Instance Methods

delete(project, instanceTemplate)

Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

get(project, instanceTemplate)

Returns the specified instance template. Get a list of available instance templates by making a list() request.

insert(project, body)

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of instance templates that are contained within the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, instanceTemplate) 
Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

Args:
  project: string, Project ID for this request. (required)
  instanceTemplate: string, The name of the instance template to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, instanceTemplate) 
Returns the specified instance template. Get a list of available instance templates by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  instanceTemplate: string, The name of the instance template. (required)

Returns:
  An object of the form:

    { # An Instance Template resource.
      "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
      "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
          # - projects/project/zones/zone/instances/instance
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
      "properties": { # The instance properties for this instance template.
        "disks": [ # An array of disks that are associated with the instances that are created from this template.
          { # An instance-attached disk resource.
            "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                #
                # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                #
                # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                #
                # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                #
                # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                  #
                  # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                  #
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                  #
                  # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                  # - projects/project/zones/zone/diskTypes/diskType
                  # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
            },
            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
            "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
            "licenses": [ # [Output Only] Any valid publicly visible licenses.
              "A String",
            ],
            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
            "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
          },
        ],
        "machineType": "A String", # The machine type to use for instances that are created from this template.
        "description": "A String", # An optional text description for the instances that are created from this instance template.
        "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
              #
              # To see the latest fingerprint, make get() request to the instance.
        },
        "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
          "a_key": "A String",
        },
        "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
          "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
          "preemptible": True or False, # Whether the instance is preemptible.
          "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
        },
        "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
        "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
          { # 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": [ # An array of network access configurations for this interface.
          { # A network interface resource attached to an instance.
            "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
              { # An alias IP range attached to an instance's network interface.
                "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
                "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
              },
            ],
            "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
            "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                "name": "A String", # Name of this access configuration.
                "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
                "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
                "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
                "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
                "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
                "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
              },
            ],
            "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
            "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                # - regions/region/subnetworks/subnetwork
            "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                #
                # global/networks/default
                #
                # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                # - projects/project/global/networks/network
                # - global/networks/default
          },
        ],
        "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
      },
      "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Template resource.
    "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
    "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
    "properties": { # The instance properties for this instance template.
      "disks": [ # An array of disks that are associated with the instances that are created from this template.
        { # An instance-attached disk resource.
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
              #
              # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
              #
              # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
              #
              # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
              #
              # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
              #
              # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
          "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
          "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
              #
              # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              #
              # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
            "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
            "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                #
                # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                #
                # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                # - projects/project/zones/zone/diskTypes/diskType
                # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
            "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
            "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                #
                # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                #
                # projects/debian-cloud/global/images/family/debian-8
                #
                # Alternatively, use a specific version of a public operating system image:
                #
                # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                #
                # To create a disk with a private image that you created, specify the image name in the following format:
                #
                # global/images/my-private-image
                #
                # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                #
                # global/images/family/my-private-family
            "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
          },
          "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
          "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
          "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
          "licenses": [ # [Output Only] Any valid publicly visible licenses.
            "A String",
          ],
          "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
          "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
          "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
          "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
        },
      ],
      "machineType": "A String", # The machine type to use for instances that are created from this template.
      "description": "A String", # An optional text description for the instances that are created from this instance template.
      "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            #
            # To see the latest fingerprint, make get() request to the instance.
      },
      "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
        "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
        "preemptible": True or False, # Whether the instance is preemptible.
        "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
      },
      "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
      "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
        { # 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": [ # An array of network access configurations for this interface.
        { # A network interface resource attached to an instance.
          "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
            { # An alias IP range attached to an instance's network interface.
              "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
              "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
            },
          ],
          "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
          "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
              "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
              "name": "A String", # Name of this access configuration.
              "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
              "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
              "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
              "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
              "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
              "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
              "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
            },
          ],
          "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
          "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
              # - regions/region/subnetworks/subnetwork
          "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
              #
              # global/networks/default
              #
              # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
              # - projects/project/global/networks/network
              # - global/networks/default
        },
      ],
      "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
        "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      },
    },
    "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of instance templates that are contained within the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of instance templates.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] list of InstanceTemplate resources.
      { # An Instance Template resource.
          "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
          "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
              # - projects/project/zones/zone/instances/instance
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
          "properties": { # The instance properties for this instance template.
            "disks": [ # An array of disks that are associated with the instances that are created from this template.
              { # An instance-attached disk resource.
                "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                    #
                    # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                    #
                    # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                    #
                    # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                    #
                    # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
                  "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                  "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                      #
                      # The key must meet the following requirements before you can provide it to Compute Engine:
                      # - The key is wrapped using a RSA public key certificate provided by Google.
                      # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                },
                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                    #
                    # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                  "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                      #
                      # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                        #
                        # The key must meet the following requirements before you can provide it to Compute Engine:
                        # - The key is wrapped using a RSA public key certificate provided by Google.
                        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                  },
                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                      #
                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                      #
                      # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                      # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                      # - projects/project/zones/zone/diskTypes/diskType
                      # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
                  "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                      #
                      # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                      #
                      # projects/debian-cloud/global/images/family/debian-8
                      #
                      # Alternatively, use a specific version of a public operating system image:
                      #
                      # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                      #
                      # To create a disk with a private image that you created, specify the image name in the following format:
                      #
                      # global/images/my-private-image
                      #
                      # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                      #
                      # global/images/family/my-private-family
                  "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
                },
                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
                "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
                "licenses": [ # [Output Only] Any valid publicly visible licenses.
                  "A String",
                ],
                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
                "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
              },
            ],
            "machineType": "A String", # The machine type to use for instances that are created from this template.
            "description": "A String", # An optional text description for the instances that are created from this instance template.
            "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                  #
                  # To see the latest fingerprint, make get() request to the instance.
            },
            "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
              "a_key": "A String",
            },
            "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
              "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
              "preemptible": True or False, # Whether the instance is preemptible.
              "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
            },
            "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
            "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
              { # 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": [ # An array of network access configurations for this interface.
              { # A network interface resource attached to an instance.
                "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
                  { # An alias IP range attached to an instance's network interface.
                    "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
                    "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
                  },
                ],
                "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
                "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                    "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                    "name": "A String", # Name of this access configuration.
                    "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
                    "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
                    "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
                    "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
                    "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                    "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
                    "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                  },
                ],
                "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
                "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                    # - regions/region/subnetworks/subnetwork
                "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                    #
                    # global/networks/default
                    #
                    # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                    # - projects/project/global/networks/network
                    # - global/networks/default
              },
            ],
            "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
              "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            },
          },
          "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.
    "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
    "selfLink": "A String", # [Output Only] The URL for this instance template list. The server defines this URL.
  }
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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.instances.html000066400000000000000000007561431300622755700256060ustar00rootroot00000000000000

Compute Engine API . instances

Instance Methods

addAccessConfig(project, zone, instance, networkInterface, body)

Adds an access config to an instance's network interface.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves aggregated list of instances.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

attachDisk(project, zone, instance, body, forceAttach=None)

Attaches a Disk resource to an instance.

delete(project, zone, instance)

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

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. Get a list of available instances by making a list() request.

getIamPolicy(project, zone, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

getSerialPortOutput(project, zone, instance, start=None, port=None)

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, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instances 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.

setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)

Sets the auto-delete flag for a disk attached to an instance.

setIamPolicy(project, zone, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

setLabels(project, zone, instance, body)

Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.

setMachineType(project, zone, instance, body)

Changes the machine type for a stopped instance to the machine type specified in the request.

setMetadata(project, zone, instance, body)

Sets metadata for the specified instance to the data included in the request.

setScheduling(project, zone, instance, body)

Sets an instance's scheduling options.

setServiceAccount(project, zone, instance, body)

Sets the service account on the instance.

setTags(project, zone, instance, body)

Sets tags for the specified instance to the data included in the request.

start(project, zone, instance)

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

startWithEncryptionKey(project, zone, instance, body)

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

stop(project, zone, instance, discardLocalSsd=None)

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

suspend(project, zone, instance, discardLocalSsd=None)

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

updateAccessConfig(project, zone, instance, networkInterface, body)

Updates the specified access config from an instance's network interface with 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 ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  networkInterface: string, The name of the network interface to add to this instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
  "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
  "name": "A String", # Name of this access configuration.
  "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
  "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
  "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
  "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
  "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
  "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
  "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves aggregated list of instances.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped instance lists.
      "a_key": { # [Output Only] Name of the scope containing this set of instances.
        "instances": [ # [Output Only] List of instances contained in this scope.
          { # An Instance resource.
            "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
            "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
              "a_key": "A String",
            },
            "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
              "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
              "preemptible": True or False, # Whether the instance is preemptible.
              "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
            },
            "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
                #
                # zones/us-central1-f/machineTypes/n1-standard-1
                #
                # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
                #
                # zones/zone/machineTypes/custom-CPUS-MEMORY
                #
                # For example: zones/us-central1-f/machineTypes/custom-4-5120
                #
                # For a full list of restrictions, read the Specifications for custom machine types.
            "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
              { # 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.
              },
            ],
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "networkInterfaces": [ # An 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. Only one interface is supported per instance.
              { # A network interface resource attached to an instance.
                "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
                  { # An alias IP range attached to an instance's network interface.
                    "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
                    "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
                  },
                ],
                "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
                "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                    "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                    "name": "A String", # Name of this access configuration.
                    "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
                    "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
                    "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
                    "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
                    "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                    "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
                    "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                  },
                ],
                "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
                "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                    # - regions/region/subnetworks/subnetwork
                "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                    #
                    # global/networks/default
                    #
                    # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                    # - projects/project/global/networks/network
                    # - global/networks/default
              },
            ],
            "zone": "A String", # [Output Only] URL of the zone where the instance resides.
            "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
                #
                # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
                #
                # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
                #
                # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
            "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
              "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
              "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            },
            "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
            "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                  #
                  # To see the latest fingerprint, make get() request to the instance.
            },
            "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                #
                # To see the latest fingerprint, make get() request to the instance.
            "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
                #
                # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
                #
                # The request will be rejected if the private host has run out of resources.
            "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
            "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
              { # An instance-attached disk resource.
                "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                    #
                    # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                    #
                    # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                    #
                    # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                    #
                    # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
                  "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                  "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                      #
                      # The key must meet the following requirements before you can provide it to Compute Engine:
                      # - The key is wrapped using a RSA public key certificate provided by Google.
                      # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                },
                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                    #
                    # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                  "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                      #
                      # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                        #
                        # The key must meet the following requirements before you can provide it to Compute Engine:
                        # - The key is wrapped using a RSA public key certificate provided by Google.
                        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                  },
                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                      #
                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                      #
                      # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                      # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                      # - projects/project/zones/zone/diskTypes/diskType
                      # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
                  "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                      #
                      # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                      #
                      # projects/debian-cloud/global/images/family/debian-8
                      #
                      # Alternatively, use a specific version of a public operating system image:
                      #
                      # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                      #
                      # To create a disk with a private image that you created, specify the image name in the following format:
                      #
                      # global/images/my-private-image
                      #
                      # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                      #
                      # global/images/family/my-private-family
                  "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
                },
                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
                "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
                "licenses": [ # [Output Only] Any valid publicly visible licenses.
                  "A String",
                ],
                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
                "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
              },
            ],
            "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, forceAttach=None) 
Attaches a Disk resource to an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An instance-attached disk resource.
  "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
      # 
      # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
      # 
      # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
      # 
      # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      # 
      # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
        #
        # The key must meet the following requirements before you can provide it to Compute Engine:
        # - The key is wrapped using a RSA public key certificate provided by Google.
        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  },
  "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
      # 
      # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
  "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
  "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
      # 
      # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
      #
      # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        #
        # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
    "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
        #
        # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
        #
        # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
        # - projects/project/zones/zone/diskTypes/diskType
        # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
    "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        #
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        #
        # projects/debian-cloud/global/images/family/debian-8
        #
        # Alternatively, use a specific version of a public operating system image:
        #
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        #
        # To create a disk with a private image that you created, specify the image name in the following format:
        #
        # global/images/my-private-image
        #
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        #
        # global/images/family/my-private-family
    "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
  },
  "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
  "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
  "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
  "licenses": [ # [Output Only] Any valid publicly visible licenses.
    "A String",
  ],
  "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
  "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
  "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
  "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
}

  forceAttach: boolean, Whether to force attach the disk even if it's currently attached to another instance. This is only available for regional disks.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, zone, instance) 
Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteAccessConfig(project, zone, instance, accessConfig, networkInterface) 
Deletes an access config from an instance's network interface.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  accessConfig: string, The name of the access config to delete. (required)
  networkInterface: string, The name of the network interface. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
detachDisk(project, zone, instance, deviceName) 
Detaches a disk from an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instance) 
Returns the specified Instance resource. Get a list of available instances by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
    "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
      "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
      "preemptible": True or False, # Whether the instance is preemptible.
      "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
    },
    "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
        #
        # zones/us-central1-f/machineTypes/n1-standard-1
        #
        # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
        #
        # zones/zone/machineTypes/custom-CPUS-MEMORY
        #
        # For example: zones/us-central1-f/machineTypes/custom-4-5120
        #
        # For a full list of restrictions, read the Specifications for custom machine types.
    "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
      { # 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.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "networkInterfaces": [ # An 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. Only one interface is supported per instance.
      { # A network interface resource attached to an instance.
        "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
          { # An alias IP range attached to an instance's network interface.
            "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
            "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
          },
        ],
        "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
        "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
            "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
            "name": "A String", # Name of this access configuration.
            "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
            "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
            "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
            "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
            "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
            "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
            "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
          },
        ],
        "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
        "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
            # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
            # - regions/region/subnetworks/subnetwork
        "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
            #
            # global/networks/default
            #
            # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
            # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
            # - projects/project/global/networks/network
            # - global/networks/default
      },
    ],
    "zone": "A String", # [Output Only] URL of the zone where the instance resides.
    "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
        #
        # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
        #
        # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
        #
        # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
        #
        # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
    "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
      "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
    "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
    "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
          #
          # To see the latest fingerprint, make get() request to the instance.
    },
    "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        #
        # To see the latest fingerprint, make get() request to the instance.
    "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
        #
        # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
        #
        # The request will be rejected if the private host has run out of resources.
    "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
      { # An instance-attached disk resource.
        "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
            #
            # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
            #
            # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
            #
            # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
            #
            # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
        "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
        "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
            #
            # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
            #
            # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
              #
              # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
          "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
              #
              # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
              #
              # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
              # - projects/project/zones/zone/diskTypes/diskType
              # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
          "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
          "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
        },
        "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
        "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
        "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
        "licenses": [ # [Output Only] Any valid publicly visible licenses.
          "A String",
        ],
        "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
        "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
        "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
        "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
getIamPolicy(project, zone, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
getSerialPortOutput(project, zone, instance, start=None, port=None) 
Returns the specified instance's serial port output.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance scoping this request. (required)
  start: string, For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.
  port: integer, Specifies which COM or serial port to retrieve data from.

Returns:
  An object of the form:

    { # An instance's serial console output.
    "start": "A String", # [Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
    "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
    "contents": "A String", # [Output Only] The contents of the console output.
    "next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.
  }
insert(project, zone, body) 
Creates an instance resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance resource.
  "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
  "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    "a_key": "A String",
  },
  "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
    "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
    "preemptible": True or False, # Whether the instance is preemptible.
    "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
  },
  "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
      # 
      # zones/us-central1-f/machineTypes/n1-standard-1
      # 
      # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
      # 
      # zones/zone/machineTypes/custom-CPUS-MEMORY
      # 
      # For example: zones/us-central1-f/machineTypes/custom-4-5120
      # 
      # For a full list of restrictions, read the Specifications for custom machine types.
  "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
    { # 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.
    },
  ],
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  "networkInterfaces": [ # An 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. Only one interface is supported per instance.
    { # A network interface resource attached to an instance.
      "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
        { # An alias IP range attached to an instance's network interface.
          "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
          "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
        },
      ],
      "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
      "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
          "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
          "name": "A String", # Name of this access configuration.
          "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
          "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
          "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
          "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
          "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
          "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
          "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
        },
      ],
      "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
      "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
          # - regions/region/subnetworks/subnetwork
      "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
          #
          # global/networks/default
          #
          # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
          # - projects/project/global/networks/network
          # - global/networks/default
    },
  ],
  "zone": "A String", # [Output Only] URL of the zone where the instance resides.
  "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
      # 
      # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
      # 
      # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
      # 
      # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
      # 
      # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
        #
        # The key must meet the following requirements before you can provide it to Compute Engine:
        # - The key is wrapped using a RSA public key certificate provided by Google.
        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  },
  "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
  "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
    "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
    "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
  },
  "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
  "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        #
        # To see the latest fingerprint, make get() request to the instance.
  },
  "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      # 
      # To see the latest fingerprint, make get() request to the instance.
  "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
      # 
      # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
      # 
      # The request will be rejected if the private host has run out of resources.
  "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
  "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
    { # An instance-attached disk resource.
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
          #
          # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
          #
          # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
          #
          # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
          #
          # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
          #
          # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
      "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
      "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
          #
          # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
          #
          # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
        "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
        "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
            #
            # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
            #
            # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
            # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
            # - projects/project/zones/zone/diskTypes/diskType
            # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
        "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
        "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
            #
            # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
            #
            # projects/debian-cloud/global/images/family/debian-8
            #
            # Alternatively, use a specific version of a public operating system image:
            #
            # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
            #
            # To create a disk with a private image that you created, specify the image name in the following format:
            #
            # global/images/my-private-image
            #
            # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
            #
            # global/images/family/my-private-family
        "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
      },
      "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
      "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
      "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
      "licenses": [ # [Output Only] Any valid publicly visible licenses.
        "A String",
      ],
      "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
      "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
      "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
      "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
    },
  ],
  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instances contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of instances.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of instances.
      { # An Instance resource.
        "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
        "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
          "a_key": "A String",
        },
        "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
          "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
          "preemptible": True or False, # Whether the instance is preemptible.
          "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
        },
        "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
            #
            # zones/us-central1-f/machineTypes/n1-standard-1
            #
            # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
            #
            # zones/zone/machineTypes/custom-CPUS-MEMORY
            #
            # For example: zones/us-central1-f/machineTypes/custom-4-5120
            #
            # For a full list of restrictions, read the Specifications for custom machine types.
        "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
          { # 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.
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "networkInterfaces": [ # An 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. Only one interface is supported per instance.
          { # A network interface resource attached to an instance.
            "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
              { # An alias IP range attached to an instance's network interface.
                "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
                "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
              },
            ],
            "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
            "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                "name": "A String", # Name of this access configuration.
                "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
                "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
                "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
                "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
                "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
                "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
              },
            ],
            "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
            "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                # - regions/region/subnetworks/subnetwork
            "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                #
                # global/networks/default
                #
                # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                # - projects/project/global/networks/network
                # - global/networks/default
          },
        ],
        "zone": "A String", # [Output Only] URL of the zone where the instance resides.
        "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
            #
            # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
            #
            # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
            #
            # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
        "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
          "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
        "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
        "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
              #
              # To see the latest fingerprint, make get() request to the instance.
        },
        "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            #
            # To see the latest fingerprint, make get() request to the instance.
        "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
            #
            # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
            #
            # The request will be rejected if the private host has run out of resources.
        "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
        "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
          { # An instance-attached disk resource.
            "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                #
                # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                #
                # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                #
                # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                #
                # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                  #
                  # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                  #
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                  #
                  # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                  # - projects/project/zones/zone/diskTypes/diskType
                  # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
            },
            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
            "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
            "licenses": [ # [Output Only] Any valid publicly visible licenses.
              "A String",
            ],
            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
            "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
          },
        ],
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
      },
    ],
    "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
reset(project, zone, instance) 
Performs a hard reset on the instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setDiskAutoDelete(project, zone, instance, autoDelete, deviceName) 
Sets the auto-delete flag for a disk attached to an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name. (required)
  autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
  deviceName: string, The device name of the disk to modify. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setIamPolicy(project, zone, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
        "A String",
      ],
      "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # DEPRECATED. Use 'values' instead.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
setLabels(project, zone, instance, body) 
Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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:

{
    "labelFingerprint": "A String", # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.
    "labels": { # A list of labels to apply for this instance. Changing instance labels will also change the instance tags.
        # 
        # Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setMachineType(project, zone, instance, body) 
Changes the machine type for a stopped instance to the machine type specified in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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:

{
    "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setMetadata(project, zone, instance, body) 
Sets metadata for the specified instance to the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
  "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setScheduling(project, zone, instance, body) 
Sets an instance's scheduling options.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Instance name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Sets the scheduling options for an Instance.
  "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
  "preemptible": True or False, # Whether the instance is preemptible.
  "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setServiceAccount(project, zone, instance, body) 
Sets the service account on the instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "scopes": [ # The list of scopes to be made available for this service account.
      "A String",
    ],
    "email": "A String", # Email address of the service account.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTags(project, zone, instance, body) 
Sets tags for the specified instance to the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      # 
      # To see the latest fingerprint, make get() request to the instance.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
start(project, zone, instance) 
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
startWithEncryptionKey(project, zone, instance, body) 
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.
        # 
        # If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
        # 
        # In order to start the instance, the disk url and its corresponding key must be provided.
        # 
        # If the disk is not protected with a customer-supplied encryption key it should not be specified.
      {
        "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
stop(project, zone, instance, discardLocalSsd=None) 
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to stop. (required)
  discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
suspend(project, zone, instance, discardLocalSsd=None) 
This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to suspend. (required)
  discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
updateAccessConfig(project, zone, instance, networkInterface, body) 
Updates the specified access config from an instance's network interface with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  networkInterface: string, The name of the network interface where the access config is attached. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
  "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
  "name": "A String", # Name of this access configuration.
  "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
  "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
  "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
  "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
  "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
  "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
  "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.licenses.html000066400000000000000000000042371300622755700254120ustar00rootroot00000000000000

Compute Engine API . licenses

Instance Methods

get(project, license)

Returns the specified License resource. Get a list of available licenses by making a list() request.

Method Details

get(project, license) 
Returns the specified License resource. Get a list of available licenses by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  license: string, Name of the License resource to return. (required)

Returns:
  An object of the form:

    { # A license resource.
    "chargesUseFee": True or False, # [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.
    "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.
    "name": "A String", # [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.machineTypes.html000066400000000000000000000463261300622755700262430ustar00rootroot00000000000000

Compute Engine API . machineTypes

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of machine types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, machineType)

Returns the specified machine type. Get a list of available machine types by making a list() request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of machine types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of machine types.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped machine type lists.
      "a_key": { # [Output Only] Name of the scope containing this set of machine types.
        "machineTypes": [ # [Output Only] List of machine types contained in this scope.
          { # A Machine Type resource.
            "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
            "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
            "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
            "description": "A String", # [Output Only] An optional textual description of the resource.
            "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
            "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
            "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
            "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
        "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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. Get a list of available machine types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  machineType: string, Name of the machine type to return. (required)

Returns:
  An object of the form:

    { # A Machine Type resource.
    "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
    "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
    "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
    "description": "A String", # [Output Only] An optional textual description of the resource.
    "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
    "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
    "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of machine types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of machine types.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Machine Type resources.
      { # A Machine Type resource.
        "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
        "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
        "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
        "description": "A String", # [Output Only] An optional textual description of the resource.
        "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
        "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
        "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.networks.html000066400000000000000000000715671300622755700254730ustar00rootroot00000000000000

Compute Engine API . networks

Instance Methods

delete(project, network)

Deletes the specified network.

get(project, network)

Returns the specified network. Get a list of available networks by making a list() request.

insert(project, body)

Creates a network in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of networks available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

switchToCustomMode(project, network)

Switches the network mode from auto subnet mode to custom subnet mode.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, network) 
Deletes the specified network.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, network) 
Returns the specified network. Get a list of available networks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to return. (required)

Returns:
  An object of the form:

    { # Represents a Network resource. Read Networks and Firewalls for more information.
      "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network.
      "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
        "A String",
      ],
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
          #
          # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network.
    }
insert(project, body) 
Creates a network in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Network resource. Read Networks and Firewalls for more information.
    "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network.
    "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
      "A String",
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
        # 
        # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of networks available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of networks.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Network resources.
      { # Represents a Network resource. Read Networks and Firewalls for more information.
          "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network.
          "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
            "A String",
          ],
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
              #
              # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network.
        },
    ],
    "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
switchToCustomMode(project, network) 
Switches the network mode from auto subnet mode to custom subnet mode.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to be updated. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.projects.html000066400000000000000000002066621300622755700254440ustar00rootroot00000000000000

Compute Engine API . projects

Instance Methods

disableXpnHost(project)

Disable this project as an XPN host project.

disableXpnResource(project, body)

Disable an XPN resource associated with this host project.

enableXpnHost(project)

Enable this project as an XPN host project.

enableXpnResource(project, body)

Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.

get(project)

Returns the specified Project resource.

getXpnHost(project)

Get the XPN host project that this project links to. May be empty if no link exists.

getXpnResources(project)

Get XPN resources associated with this host project.

listXpnHosts(project, body)

List all XPN host projects visible to the user in an organization.

moveDisk(project, body)

Moves a persistent disk from one zone to another.

moveInstance(project, body)

Moves an instance and its attached persistent disks from one zone to another.

setCommonInstanceMetadata(project, body)

Sets metadata common to all instances within the specified project using the data included in the request.

setDefaultServiceAccount(project, body)

Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".

setUsageExportBucket(project, body)

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Method Details

disableXpnHost(project) 
Disable this project as an XPN host project.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
disableXpnResource(project, body) 
Disable an XPN resource associated with this host project.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "xpnResource": { # XpnResourceId # XPN resource ID.
      "type": "A String", # The type of the XPN resource.
      "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
enableXpnHost(project) 
Enable this project as an XPN host project.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
enableXpnResource(project, body) 
Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "xpnResource": { # XpnResourceId # XPN resource ID.
      "type": "A String", # The type of the XPN resource.
      "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project) 
Returns the specified Project resource.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
    "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
    "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
    "enabledFeatures": [ # Restricted features enabled for use on this project.
      "A String",
    ],
    "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
    "quotas": [ # [Output Only] Quotas assigned to this project.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
    "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
      "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
      "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
    },
    "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "description": "A String", # An optional textual description of the resource.
  }
getXpnHost(project) 
Get the XPN host project that this project links to. May be empty if no link exists.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
    "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
    "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
    "enabledFeatures": [ # Restricted features enabled for use on this project.
      "A String",
    ],
    "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
    "quotas": [ # [Output Only] Quotas assigned to this project.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
    "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
      "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
      "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
    },
    "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "description": "A String", # An optional textual description of the resource.
  }
getXpnResources(project) 
Get XPN resources associated with this host project.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    {
    "kind": "compute#projectsGetXpnResources", # [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of XPN resources.
    "resources": [ # XPN resources attached to this project as their XPN host.
      { # XpnResourceId
        "type": "A String", # The type of the XPN resource.
        "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
      },
    ],
  }
listXpnHosts(project, body) 
List all XPN host projects visible to the user in an organization.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "organization": "A String", # Optional organization ID managed by Cloud Resource Manager, for which to list XPN host projects. If not specified, the organization will be inferred from the project.
  }


Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of XPN host project URLs.
      { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
        "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
        "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
        "enabledFeatures": [ # Restricted features enabled for use on this project.
          "A String",
        ],
        "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
        "quotas": [ # [Output Only] Quotas assigned to this project.
          { # A quotas entry.
            "usage": 3.14, # [Output Only] Current usage of this metric.
            "metric": "A String", # [Output Only] Name of the quota metric.
            "limit": 3.14, # [Output Only] Quota limit for this metric.
          },
        ],
        "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
        "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
          "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
          "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
        },
        "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "description": "A String", # An optional textual description of the resource.
      },
    ],
    "kind": "compute#xpnHostList", # [Output Only] Type of resource. Always compute#xpnHostList for lists of XPN hosts.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
moveDisk(project, body) 
Moves a persistent disk from one zone to another.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
        # - projects/project/zones/zone/disks/disk
        # - zones/zone/disks/disk
    "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
        # - projects/project/zones/zone
        # - zones/zone
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
moveInstance(project, body) 
Moves an instance and its attached persistent disks from one zone to another.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
        # - zones/zone/instances/instance
    "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
        # - projects/project/zones/zone
        # - zones/zone
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setCommonInstanceMetadata(project, body) 
Sets metadata common to all instances within the specified project using the data included in the request.

Args:
  project: string, Project ID for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
  "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setDefaultServiceAccount(project, body) 
Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "email": "A String", # Email address of the service account.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setUsageExportBucket(project, body) 
Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
  "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
  "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionAutoscalers.html000066400000000000000000002032531300622755700272750ustar00rootroot00000000000000

Compute Engine API . regionAutoscalers

Instance Methods

delete(project, region, autoscaler)

Deletes the specified autoscaler.

get(project, region, autoscaler)

Returns the specified autoscaler.

insert(project, region, body)

Creates an autoscaler in the specified project using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of autoscalers contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, autoscaler, body)

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, body, autoscaler=None)

Updates an autoscaler in the specified project using the data included in the request.

Method Details

delete(project, region, autoscaler) 
Deletes the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  autoscaler: string, Name of the autoscaler to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, autoscaler) 
Returns the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  autoscaler: string, Name of the autoscaler to return. (required)

Returns:
  An object of the form:

    { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
      "status": "A String", # [Output Only] The status of the autoscaler configuration.
      "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
      "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
      "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
          #
          # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
        "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
            #
            # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
        "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
          "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
        },
        "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
          "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
          "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
          "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
            "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
            "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
          },
        },
        "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
          { # Custom utilization metric policy.
            "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                #
                # For example, the following is a valid metric:
                # compute.googleapis.com/instance/network/received_bytes_count
                # The following is not a valid metric because it does not increase or decrease based on usage:
                # compute.googleapis.com/instance/cpu/reserved_cores
            "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
            "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
          },
        ],
        "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
          "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
              #
              # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
              #
              # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
        },
        "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
      },
      "target": "A String", # URL of the managed instance group that this autoscaler will scale.
      "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        {
          "message": "A String", # The status message.
          "type": "A String", # The type of error returned.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
        "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
        "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
        "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
          "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
          "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
        },
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of autoscalers contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of autoscalers.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of autoscalers.
      { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
          "status": "A String", # [Output Only] The status of the autoscaler configuration.
          "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
          "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
          "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
              #
              # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
            "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
            "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                #
                # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
            "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
              "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
            },
            "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
              "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
              "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
              "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
                "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
                "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
              },
            },
            "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
              { # Custom utilization metric policy.
                "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                    #
                    # For example, the following is a valid metric:
                    # compute.googleapis.com/instance/network/received_bytes_count
                    # The following is not a valid metric because it does not increase or decrease based on usage:
                    # compute.googleapis.com/instance/cpu/reserved_cores
                "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
              },
            ],
            "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
              "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                  #
                  # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                  #
                  # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
            },
            "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
          },
          "target": "A String", # URL of the managed instance group that this autoscaler will scale.
          "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
            {
              "message": "A String", # The status message.
              "type": "A String", # The type of error returned.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#regionAutoscalerList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, autoscaler, body) 
Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  autoscaler: string, Name of the autoscaler to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
        "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
        "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
        "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
          "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
          "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
        },
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, body, autoscaler=None) 
Updates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
        "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
        "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
        "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
          "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
          "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
        },
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  autoscaler: string, Name of the autoscaler to update.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionBackendServices.html000066400000000000000000002316731300622755700300520ustar00rootroot00000000000000

Compute Engine API . regionBackendServices

Instance Methods

delete(project, region, backendService)

Deletes the specified regional BackendService resource.

get(project, region, backendService)

Returns the specified regional BackendService resource.

getHealth(project, region, backendService, body)

Gets the most recent health check results for this regional BackendService.

insert(project, region, body)

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of regional BackendService resources available to the specified project in the given region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, backendService, body)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, backendService, body)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Method Details

delete(project, region, backendService) 
Deletes the specified regional BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, backendService) 
Returns the specified regional BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to return. (required)

Returns:
  An object of the form:

    { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
      "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
        "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
          "A String",
        ],
      },
      "connectionDraining": { # Message containing connection draining configuration.
        "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
      },
      "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
          #
          # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
          #
          # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
      "loadBalancingScheme": "A String",
      "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
          #
          # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
        "A String",
      ],
      "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
          #
          # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
          #
          # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
          #
          # When the protocol is UDP, this field is not used.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
      "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
          #
          # This cannot be used for internal load balancing.
      "backends": [ # The list of backends that serve this BackendService.
        { # Message containing information of one individual backend.
          "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
              #
              # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
              #
              # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
              #
              # This cannot be used for internal load balancing.
        },
      ],
      "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
        "oauth2ClientId": "A String",
        "enabled": True or False,
        "oauth2ClientSecret": "A String",
        "oauth2ClientSecretSha256": "A String",
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
        "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
          "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
          "includeHost": True or False, # If true, requests to different hosts will be cached separately.
          "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
            "A String",
          ],
          "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
            "A String",
          ],
          "includeProtocol": True or False, # If true, http and https requests will be cached separately.
        },
      },
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
      "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    }
getHealth(project, region, backendService, body) 
Gets the most recent health check results for this regional BackendService.

Args:
  project: string, A parameter (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
  }


Returns:
  An object of the form:

    {
    "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, region, body) 
Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for 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 BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
      "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
        "A String",
      ],
    },
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "loadBalancingScheme": "A String",
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
      "oauth2ClientId": "A String",
      "enabled": True or False,
      "oauth2ClientSecret": "A String",
      "oauth2ClientSecretSha256": "A String",
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
      "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
        "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
        "includeHost": True or False, # If true, requests to different hosts will be cached separately.
        "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "includeProtocol": True or False, # If true, http and https requests will be cached separately.
      },
    },
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of regional BackendService resources available to the specified project in the given region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendService resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of BackendService resources.
      { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
          "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
            "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
              "A String",
            ],
          },
          "connectionDraining": { # Message containing connection draining configuration.
            "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
          },
          "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
              #
              # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
              #
              # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
          "loadBalancingScheme": "A String",
          "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
              #
              # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
            "A String",
          ],
          "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
              #
              # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
              #
              # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
              #
              # When the protocol is UDP, this field is not used.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
          "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
              #
              # This cannot be used for internal load balancing.
          "backends": [ # The list of backends that serve this BackendService.
            { # Message containing information of one individual backend.
              "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                  #
                  # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                  #
                  # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                  #
                  # This cannot be used for internal load balancing.
            },
          ],
          "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
            "oauth2ClientId": "A String",
            "enabled": True or False,
            "oauth2ClientSecret": "A String",
            "oauth2ClientSecretSha256": "A String",
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
            "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
              "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
              "includeHost": True or False, # If true, requests to different hosts will be cached separately.
              "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
                "A String",
              ],
              "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
                "A String",
              ],
              "includeProtocol": True or False, # If true, http and https requests will be cached separately.
            },
          },
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
          "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        },
    ],
    "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, backendService, body) 
Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
      "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
        "A String",
      ],
    },
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "loadBalancingScheme": "A String",
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
      "oauth2ClientId": "A String",
      "enabled": True or False,
      "oauth2ClientSecret": "A String",
      "oauth2ClientSecretSha256": "A String",
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
      "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
        "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
        "includeHost": True or False, # If true, requests to different hosts will be cached separately.
        "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "includeProtocol": True or False, # If true, http and https requests will be cached separately.
      },
    },
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, backendService, body) 
Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
      "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
        "A String",
      ],
    },
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "loadBalancingScheme": "A String",
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
      "oauth2ClientId": "A String",
      "enabled": True or False,
      "oauth2ClientSecret": "A String",
      "oauth2ClientSecretSha256": "A String",
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
      "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
        "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
        "includeHost": True or False, # If true, requests to different hosts will be cached separately.
        "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
          "A String",
        ],
        "includeProtocol": True or False, # If true, http and https requests will be cached separately.
      },
    },
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionDiskTypes.html000066400000000000000000000243011300622755700267220ustar00rootroot00000000000000

Compute Engine API . regionDiskTypes

Instance Methods

get(project, region, diskType)

Returns the specified regional disk type. Get a list of available disk types by making a list() request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of regional disk types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, region, diskType) 
Returns the specified regional disk type. Get a list of available disk types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  diskType: string, Name of the disk type to return. (required)

Returns:
  An object of the form:

    { # A DiskType resource.
    "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
    "description": "A String", # [Output Only] An optional description of this resource.
    "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
    "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
    "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of regional disk types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Disk Type resources.
      { # A DiskType resource.
        "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
        "description": "A String", # [Output Only] An optional description of this resource.
        "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
        "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#regionDiskTypeList", # [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionDisks.html000066400000000000000000002105241300622755700260640ustar00rootroot00000000000000

Compute Engine API . regionDisks

Instance Methods

createSnapshot(project, region, disk, body, guestFlush=None)

Creates a snapshot of this regional disk.

delete(project, region, disk)

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

get(project, region, disk)

Returns a specified regional persistent disk.

insert(project, region, body, sourceImage=None)

Creates a persistent regional disk in the specified project using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of persistent disks contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

resize(project, region, disk, body)

Resizes the specified regional persistent disk.

setLabels(project, region, resource, body)

Sets the labels on the target regional disk.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

createSnapshot(project, region, disk, body, guestFlush=None) 
Creates a snapshot of this regional disk.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  disk: string, Name of the regional persistent disk to snapshot. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A persistent disk snapshot resource.
    "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
    "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
    "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
        # 
        # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a snapshot.
    "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
    "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  guestFlush: boolean, A parameter

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, region, disk) 
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  disk: string, Name of the regional persistent disk to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, disk) 
Returns a specified regional persistent disk.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  disk: string, Name of the regional persistent disk to return. (required)

Returns:
  An object of the form:

    { # A Disk resource.
      "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "licenses": [ # Any applicable publicly visible licenses.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
        "A String",
      ],
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
          #
          # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "zone": "A String", # [Output Only] URL of the zone where the disk resides.
      "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
      "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
      "status": "A String", # [Output Only] The status of disk creation.
      "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
          # - projects/project/global/snapshots/snapshot
          # - global/snapshots/snapshot
      "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a disk.
      "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
      "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
        "A String",
      ],
      "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
      "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
          #
          # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
      "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
      "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "options": "A String", # Internal use only.
      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
      "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
          #
          # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
          #
          # projects/debian-cloud/global/images/family/debian-8
          #
          # Alternatively, use a specific version of a public operating system image:
          #
          # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
          #
          # To create a disk with a private image that you created, specify the image name in the following format:
          #
          # global/images/my-private-image
          #
          # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
          #
          # global/images/family/my-private-family
    }
insert(project, region, body, sourceImage=None) 
Creates a persistent regional disk in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Disk resource.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "licenses": [ # Any applicable publicly visible licenses.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
      "A String",
    ],
    "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
        # 
        # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "zone": "A String", # [Output Only] URL of the zone where the disk resides.
    "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
    "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
    "status": "A String", # [Output Only] The status of disk creation.
    "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
        # - projects/project/global/snapshots/snapshot
        # - global/snapshots/snapshot
    "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a disk.
    "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
    "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
      "A String",
    ],
    "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
    "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
        # 
        # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
    "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
    "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "options": "A String", # Internal use only.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        # 
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        # 
        # projects/debian-cloud/global/images/family/debian-8
        # 
        # Alternatively, use a specific version of a public operating system image:
        # 
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        # 
        # To create a disk with a private image that you created, specify the image name in the following format:
        # 
        # global/images/my-private-image
        # 
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        # 
        # global/images/family/my-private-family
  }

  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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of persistent disks contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of persistent disks.
      { # A Disk resource.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "licenses": [ # Any applicable publicly visible licenses.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
            "A String",
          ],
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
              #
              # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "zone": "A String", # [Output Only] URL of the zone where the disk resides.
          "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
          "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
          "status": "A String", # [Output Only] The status of disk creation.
          "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
              # - projects/project/global/snapshots/snapshot
              # - global/snapshots/snapshot
          "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a disk.
          "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
          "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
            "A String",
          ],
          "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
          "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
              #
              # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
          "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
          "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "options": "A String", # Internal use only.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
        },
    ],
    "kind": "compute#regionDiskList", # [Output Only] Type of resource. Always compute#regionDiskList for lists of region disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
resize(project, region, disk, body) 
Resizes the specified regional persistent disk.

Args:
  project: string, The project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  disk: string, Name of the regional persistent disk. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sizeGb": "A String", # The new size of the regional persistent disk, which is specified in GB.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setLabels(project, region, resource, body) 
Sets the labels on the target regional disk.

Args:
  project: string, Project ID for this request. (required)
  region: string, The region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # The labels to set for this resource.
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionInstanceGroupManagers.html000066400000000000000000004025331300622755700312510ustar00rootroot00000000000000

Compute Engine API . regionInstanceGroupManagers

Instance Methods

abandonInstances(project, region, instanceGroupManager, body)

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

delete(project, region, instanceGroupManager)

Deletes the specified managed instance group and all of the instances in that group.

deleteInstances(project, region, instanceGroupManager, body)

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

get(project, region, instanceGroupManager)

Returns all of the details about the specified managed instance group.

insert(project, region, body)

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of managed instance groups that are contained within the specified region.

listManagedInstances(project, region, instanceGroupManager)

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, instanceGroupManager, body)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

recreateInstances(project, region, instanceGroupManager, body)

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

resize(project, region, instanceGroupManager, size)

Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

setAutoHealingPolicies(project, region, instanceGroupManager, body)

Modifies the autohealing policy for the instances in this managed instance group.

setInstanceTemplate(project, region, instanceGroupManager, body)

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

setTargetPools(project, region, instanceGroupManager, body)

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, instanceGroupManager, body)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Method Details

abandonInstances(project, region, instanceGroupManager, body) 
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to abandon.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, region, instanceGroupManager) 
Deletes the specified managed instance group and all of the instances in that group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteInstances(project, region, instanceGroupManager, body) 
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to delete.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, instanceGroupManager) 
Returns all of the details about the specified managed instance group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group to return. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
        "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
            #
            # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
        "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
        "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
        "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
      "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
        {
          "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
            "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
            "fixed": 42, # fixed must be non-negative.
            "percent": 42, # percent must belong to [0, 100].
          },
          "instanceTemplate": "A String",
          "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
        },
      ],
      "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
        {
          "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
          "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
          "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
            "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
            "fixed": 42, # fixed must be non-negative.
            "percent": 42, # percent must belong to [0, 100].
          },
        },
      ],
      "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
      "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
      "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
      "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
      "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
        "A String",
      ],
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
      "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
      },
      "updatePolicy": { # The update policy for this managed instance group.
        "type": "A String",
        "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
      },
      "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
      "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
      "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
      "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
      "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
      "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, region, body) 
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for 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:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
      {
        "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "instanceTemplate": "A String",
        "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
      },
    ],
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
    },
    "updatePolicy": { # The update policy for this managed instance group.
      "type": "A String",
      "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
      "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
    },
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of managed instance groups that are contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of managed instance groups.
    "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
    "items": [ # A list of managed instance groups.
      { # An Instance Group Manager resource.
          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
            "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                #
                # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
            "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
            "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
            "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
          "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
            {
              "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
                "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                "fixed": 42, # fixed must be non-negative.
                "percent": 42, # percent must belong to [0, 100].
              },
              "instanceTemplate": "A String",
              "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
            },
          ],
          "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
            {
              "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
              "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
              "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
                "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
                "fixed": 42, # fixed must be non-negative.
                "percent": 42, # percent must belong to [0, 100].
              },
            },
          ],
          "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
          "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
          "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
          "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
          "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
            "A String",
          ],
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
          "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
          },
          "updatePolicy": { # The update policy for this managed instance group.
            "type": "A String",
            "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
              "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
              "fixed": 42, # fixed must be non-negative.
              "percent": 42, # percent must belong to [0, 100].
            },
            "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
            "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
              "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
              "fixed": 42, # fixed must be non-negative.
              "percent": 42, # percent must belong to [0, 100].
            },
            "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
          },
          "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
          "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
          "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
          "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
          "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
          "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL.
  }
listManagedInstances(project, region, instanceGroupManager) 
Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    {
    "managedInstances": [ # List of managed instances.
      {
        "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
        "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
          "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
        },
        "tag": "A String", # [Output Only] Tag describing the version.
        "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
        "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
        "standbyMode": "A String", # [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
        "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
            # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
            # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
            # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
            # - RECREATING The managed instance group is recreating this instance.
            # - DELETING The managed instance group is permanently deleting this instance.
            # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
            # - RESTARTING The managed instance group is restarting the instance.
            # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
        "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
      },
    ],
  }
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, region, instanceGroupManager, body) 
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
      {
        "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "instanceTemplate": "A String",
        "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
      },
    ],
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
    },
    "updatePolicy": { # The update policy for this managed instance group.
      "type": "A String",
      "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
      "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
    },
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
recreateInstances(project, region, instanceGroupManager, body) 
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to recreate.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resize(project, region, instanceGroupManager, size) 
Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  size: integer, Number of instances that should exist in this instance group manager. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setAutoHealingPolicies(project, region, instanceGroupManager, body) 
Modifies the autohealing policy for the instances in this managed instance group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "autoHealingPolicies": [
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setInstanceTemplate(project, region, instanceGroupManager, body) 
Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTargetPools(project, region, instanceGroupManager, body) 
Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, instanceGroupManager, body) 
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
      {
        "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
        "instanceTemplate": "A String",
        "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
      },
    ],
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
          "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
          "fixed": 42, # fixed must be non-negative.
          "percent": 42, # percent must belong to [0, 100].
        },
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
    },
    "updatePolicy": { # The update policy for this managed instance group.
      "type": "A String",
      "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
      "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
        "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
        "fixed": 42, # fixed must be non-negative.
        "percent": 42, # percent must belong to [0, 100].
      },
      "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
    },
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionInstanceGroups.html000066400000000000000000000564071300622755700277630ustar00rootroot00000000000000

Compute Engine API . regionInstanceGroups

Instance Methods

get(project, region, instanceGroup)

Returns the specified instance group resource.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance group resources contained within the specified region.

listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

listInstances_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setNamedPorts(project, region, instanceGroup, body)

Sets the named ports for the specified regional instance group.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

get(project, region, instanceGroup) 
Returns the specified instance group resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroup: string, Name of the instance group resource to return. (required)

Returns:
  An object of the form:

    {
      "size": 42, # [Output Only] The total number of instances in the instance group.
      "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
      "region": "A String", # The URL of the region where the instance group is located (for regional resources).
      "network": "A String", # The URL of the network to which all instances in the instance group belong.
      "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
      "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
      "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
          #
          # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
          #
          # Named ports apply to all instances in this instance group.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
      "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
      "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance group resources contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of InstanceGroup resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of InstanceGroup resources.
      {
          "size": 42, # [Output Only] The total number of instances in the instance group.
          "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
          "region": "A String", # The URL of the region where the instance group is located (for regional resources).
          "network": "A String", # The URL of the network to which all instances in the instance group belong.
          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
          "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
              #
              # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
              #
              # Named ports apply to all instances in this instance group.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
          "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#regionInstanceGroupList", # The resource type.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroup: string, Name of the regional instance group for which we want to list the instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "portName": "A String", # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
    "instanceState": "A String", # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
  }

  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of instances and any named ports that are assigned to those instances.
      {
        "status": "A String", # [Output Only] The status of the instance.
        "instance": "A String", # [Output Only] The URL of the instance.
        "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
          { # The named port. For example: .
            "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
            "port": 42, # The port number, which can be a value between 1 and 65535.
          },
        ],
      },
    ],
    "kind": "compute#regionInstanceGroupsListInstances", # The resource type.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }
listInstances_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.
setNamedPorts(project, region, instanceGroup, body) 
Sets the named ports for the specified regional instance group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "namedPorts": [ # The list of named ports to set for this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regionOperations.html000066400000000000000000000400301300622755700271230ustar00rootroot00000000000000

Compute Engine API . regionOperations

Instance Methods

delete(project, region, operation)

Deletes the specified region-specific Operations resource.

get(project, region, operation)

Retrieves the specified region-specific Operations resource.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, region, operation) 
Retrieves the specified region-specific Operations resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.regions.html000066400000000000000000000247001300622755700252500ustar00rootroot00000000000000

Compute Engine API . regions

Instance Methods

get(project, region)

Returns the specified Region resource. Get a list of available regions by making a list() request.

list(project, orderBy=None, 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. Get a list of available regions by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region resource to return. (required)

Returns:
  An object of the form:

    { # Region resource.
    "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
    "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
    "description": "A String", # [Output Only] Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "quotas": [ # [Output Only] Quotas assigned to this region.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of region resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of region resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Region resources.
      { # Region resource.
        "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
        "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "quotas": [ # [Output Only] Quotas assigned to this region.
          { # A quotas entry.
            "usage": 3.14, # [Output Only] Current usage of this metric.
            "metric": "A String", # [Output Only] Name of the quota metric.
            "limit": 3.14, # [Output Only] Quota limit for this metric.
          },
        ],
        "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
          "A String",
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.routers.html000066400000000000000000002175731300622755700253210ustar00rootroot00000000000000

Compute Engine API . routers

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of routers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, router)

Deletes the specified Router resource.

get(project, region, router)

Returns the specified Router resource. Get a list of available routers by making a list() request.

getRouterStatus(project, region, router)

Retrieves runtime information of the specified router.

insert(project, region, body)

Creates a Router resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of Router resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, router, body)

Updates the specified Router resource with the data included in the request. This method supports patch semantics.

preview(project, region, router, body)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, router, body)

Updates the specified Router resource with the data included in the request.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of routers.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of routers.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped router lists.
      "a_key": { # Name of the scope containing this set of routers.
        "routers": [ # List of routers contained in this scope.
          { # Router resource.
              "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
                {
                  "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
                  "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
                  "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
                },
              ],
              "bgp": { # BGP information specific to this router.
                "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
              },
              "network": "A String", # URI of the network to which this router belongs.
              "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
                {
                  "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
                  "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
                  "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
                  "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
                  "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
                  "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
                },
              ],
              "region": "A String", # [Output Only] URI of the region where the router resides.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of routers when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#routerAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, router) 
Deletes the specified Router resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, router) 
Returns the specified Router resource. Get a list of available routers by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to return. (required)

Returns:
  An object of the form:

    { # Router resource.
      "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
        {
          "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
          "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
          "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
        },
      ],
      "bgp": { # BGP information specific to this router.
        "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
      },
      "network": "A String", # URI of the network to which this router belongs.
      "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
        {
          "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
          "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
          "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
          "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
          "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
          "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
        },
      ],
      "region": "A String", # [Output Only] URI of the region where the router resides.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getRouterStatus(project, region, router) 
Retrieves runtime information of the specified router.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to query. (required)

Returns:
  An object of the form:

    {
    "kind": "compute#routerStatusResponse", # Type of resource.
    "result": {
      "bgpPeerStatus": [
        {
          "status": "A String", # Status of the BGP peer: {UP, DOWN}
          "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
          "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
          "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
          "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
          "peerIpAddress": "A String", # IP address of the remote BGP interface.
          "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
            { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
                #
                # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
                #
                # Packets that do not match any route in the sending instance's routing table are dropped.
              "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
              "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
              "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "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. You can specify this as a full or partial URL. For example:
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
              "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
              "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
              "network": "A String", # Fully-qualified URL of the network that this route applies to.
              "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
              "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
                {
                  "message": "A String", # [Output Only] A human-readable description of the warning code.
                  "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                  "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                      # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                    {
                      "value": "A String", # [Output Only] A warning data value corresponding to the key.
                      "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                    },
                  ],
                },
              ],
              "destRange": "A String", # The destination range of outgoing packets that this route applies to.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            },
          ],
          "state": "A String", # BGP state as specified in RFC1771.
          "ipAddress": "A String", # IP address of the local BGP interface.
          "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
        },
      ],
      "network": "A String", # URI of the network to which this router belongs.
      "bestRoutes": [ # Best routes for this router's network.
        { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
            #
            # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
            #
            # Packets that do not match any route in the sending instance's routing table are dropped.
          "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
          "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
          "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "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. You can specify this as a full or partial URL. For example:
              # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
          "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
          "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
          "network": "A String", # Fully-qualified URL of the network that this route applies to.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
          "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
            {
              "message": "A String", # [Output Only] A human-readable description of the warning code.
              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                  "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                },
              ],
            },
          ],
          "destRange": "A String", # The destination range of outgoing packets that this route applies to.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        },
      ],
    },
  }
insert(project, region, body) 
Creates a Router resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Router resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Router resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of Router resources.
      { # Router resource.
          "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
            {
              "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
              "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
              "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
            },
          ],
          "bgp": { # BGP information specific to this router.
            "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
          },
          "network": "A String", # URI of the network to which this router belongs.
          "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
            {
              "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
              "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
              "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
              "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
              "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
              "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
            },
          ],
          "region": "A String", # [Output Only] URI of the region where the router resides.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, router, body) 
Updates the specified Router resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
preview(project, region, router, body) 
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to query. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    {
    "resource": { # Router resource. # Preview of given router.
        "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
          {
            "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
            "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
            "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
          },
        ],
        "bgp": { # BGP information specific to this router.
          "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
        },
        "network": "A String", # URI of the network to which this router belongs.
        "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
          {
            "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
            "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
            "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
            "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
            "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
            "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
          },
        ],
        "region": "A String", # [Output Only] URI of the region where the router resides.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      },
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, router, body) 
Updates the specified Router resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.routes.html000066400000000000000000000753101300622755700251260ustar00rootroot00000000000000

Compute Engine API . routes

Instance Methods

delete(project, route)

Deletes the specified Route resource.

get(project, route)

Returns the specified Route resource. Get a list of available routes by making a list() request.

insert(project, body)

Creates a Route resource in the specified project using the data included in the request.

list(project, orderBy=None, 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.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, route) 
Deletes the specified Route resource.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, route) 
Returns the specified Route resource. Get a list of available routes by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  route: string, Name of the Route resource to return. (required)

Returns:
  An object of the form:

    { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
      #
      # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
      #
      # Packets that do not match any route in the sending instance's routing table are dropped.
    "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
    "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
    "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "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. You can specify this as a full or partial URL. For example:
        # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
    "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
    "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
    "network": "A String", # Fully-qualified URL of the network that this route applies to.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "destRange": "A String", # The destination range of outgoing packets that this route applies to.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  }
insert(project, body) 
Creates a Route resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
    # 
    # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
    # 
    # Packets that do not match any route in the sending instance's routing table are dropped.
  "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
  "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
  "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
  "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  "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. You can specify this as a full or partial URL. For example:
      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
  "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
  "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
  "network": "A String", # Fully-qualified URL of the network that this route applies to.
  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
  "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    {
      "message": "A String", # [Output Only] A human-readable description of the warning code.
      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
        {
          "value": "A String", # [Output Only] A warning data value corresponding to the key.
          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
        },
      ],
    },
  ],
  "destRange": "A String", # The destination range of outgoing packets that this route applies to.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Route resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Route resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Route resources.
      { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
          #
          # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
          #
          # Packets that do not match any route in the sending instance's routing table are dropped.
        "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
        "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
        "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
        "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "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. You can specify this as a full or partial URL. For example:
            # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
        "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
        "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
        "network": "A String", # Fully-qualified URL of the network that this route applies to.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "destRange": "A String", # The destination range of outgoing packets that this route applies to.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      },
    ],
    "kind": "compute#routeList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.snapshots.html000066400000000000000000000747701300622755700256400ustar00rootroot00000000000000

Compute Engine API . snapshots

Instance Methods

delete(project, snapshot)

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

get(project, snapshot)

Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of Snapshot resources contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setLabels(project, resource, body)

Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, snapshot) 
Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snaphots.

Args:
  project: string, Project ID for this request. (required)
  snapshot: string, Name of the Snapshot resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, snapshot) 
Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  snapshot: string, Name of the Snapshot resource to return. (required)

Returns:
  An object of the form:

    { # A persistent disk snapshot resource.
      "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
      "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
      "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
          #
          # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a snapshot.
      "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
      "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Snapshot resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Snapshot resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Snapshot resources.
      { # A persistent disk snapshot resource.
          "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
          "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
          "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
          "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
              #
              # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a snapshot.
          "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
          "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#snapshotList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setLabels(project, resource, body) 
Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.sslCertificates.html000066400000000000000000000533741300622755700267420ustar00rootroot00000000000000

Compute Engine API . sslCertificates

Instance Methods

delete(project, sslCertificate)

Deletes the specified SslCertificate resource.

get(project, sslCertificate)

Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

insert(project, body)

Creates a SslCertificate resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of SslCertificate resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, sslCertificate) 
Deletes the specified SslCertificate resource.

Args:
  project: string, Project ID for this request. (required)
  sslCertificate: string, Name of the SslCertificate resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, sslCertificate) 
Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  sslCertificate: string, Name of the SslCertificate resource to return. (required)

Returns:
  An object of the form:

    { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
      "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
      "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output only] Server-defined URL for the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    }
insert(project, body) 
Creates a SslCertificate resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
    "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
    "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output only] Server-defined URL for the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of SslCertificate resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of SslCertificate resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of SslCertificate resources.
      { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
          "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
          "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output only] Server-defined URL for the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        },
    ],
    "kind": "compute#sslCertificateList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.subnetworks.html000066400000000000000000002026551300622755700261770ustar00rootroot00000000000000

Compute Engine API . subnetworks

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of subnetworks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, subnetwork)

Deletes the specified subnetwork.

expandIpCidrRange(project, region, subnetwork, body)

Expands the IP CIDR range of the subnetwork to a specified value.

get(project, region, subnetwork)

Returns the specified subnetwork. Get a list of available subnetworks list() request.

getIamPolicy(project, region, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, region, body)

Creates a subnetwork in the specified project using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of subnetworks available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(project, region, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

setPrivateIpGoogleAccess(project, region, subnetwork, body)

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Cloudpath.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of subnetworks.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output] A map of scoped Subnetwork lists.
      "a_key": { # Name of the scope containing this set of Subnetworks.
        "subnetworks": [ # List of subnetworks contained in this scope.
          { # A Subnetwork resource.
              "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "region": "A String", # URL of the region where the Subnetwork resides.
              "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
                { # Represents a secondary IP range of a subnetwork.
                  "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
                  "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
                },
              ],
              "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
              "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
              "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
              "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # An informational warning that appears when the list of addresses is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, subnetwork) 
Deletes the specified subnetwork.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
expandIpCidrRange(project, region, subnetwork, body) 
Expands the IP CIDR range of the subnetwork to a specified value.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "ipCidrRange": "A String", # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, subnetwork) 
Returns the specified subnetwork. Get a list of available subnetworks list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to return. (required)

Returns:
  An object of the form:

    { # A Subnetwork resource.
      "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "region": "A String", # URL of the region where the Subnetwork resides.
      "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
        { # Represents a secondary IP range of a subnetwork.
          "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
          "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
        },
      ],
      "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
      "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
      "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
      "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getIamPolicy(project, region, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, region, body) 
Creates a subnetwork in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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 Subnetwork resource.
    "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "region": "A String", # URL of the region where the Subnetwork resides.
    "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
      { # Represents a secondary IP range of a subnetwork.
        "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
        "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
      },
    ],
    "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
    "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
    "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
    "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of subnetworks available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Subnetwork resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # The Subnetwork resources.
      { # A Subnetwork resource.
          "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "region": "A String", # URL of the region where the Subnetwork resides.
          "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
            { # Represents a secondary IP range of a subnetwork.
              "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
              "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
            },
          ],
          "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
          "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
          "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
          "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setIamPolicy(project, region, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
        "A String",
      ],
      "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # DEPRECATED. Use 'values' instead.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
setPrivateIpGoogleAccess(project, region, subnetwork, body) 
Set whether VMs in this subnet can access Google services without assigning external IP addresses through Cloudpath.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "privateIpGoogleAccess": True or False,
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetHttpProxies.html000066400000000000000000000643051300622755700273070ustar00rootroot00000000000000

Compute Engine API . targetHttpProxies

Instance Methods

delete(project, targetHttpProxy)

Deletes the specified TargetHttpProxy resource.

get(project, targetHttpProxy)

Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

insert(project, body)

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetHttpProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setUrlMap(project, targetHttpProxy, body)

Changes the URL map for TargetHttpProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetHttpProxy) 
Deletes the specified TargetHttpProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetHttpProxy) 
Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
      "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetHttpProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
    "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetHttpProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of TargetHttpProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetHttpProxy resources.
      { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
          "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setUrlMap(project, targetHttpProxy, body) 
Changes the URL map for TargetHttpProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "urlMap": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetHttpsProxies.html000066400000000000000000001032641300622755700274700ustar00rootroot00000000000000

Compute Engine API . targetHttpsProxies

Instance Methods

delete(project, targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

get(project, targetHttpsProxy)

Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

insert(project, body)

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetHttpsProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setSslCertificates(project, targetHttpsProxy, body)

Replaces SslCertificates for TargetHttpsProxy.

setUrlMap(project, targetHttpsProxy, body)

Changes the URL map for TargetHttpsProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetHttpsProxy) 
Deletes the specified TargetHttpsProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetHttpsProxy) 
Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
      "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
      "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
        "A String",
      ],
      "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
          # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
          # - projects/project/global/urlMaps/url-map
          # - global/urlMaps/url-map
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
    "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
    "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
      "A String",
    ],
    "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
        # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
        # - projects/project/global/urlMaps/url-map
        # - global/urlMaps/url-map
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetHttpsProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetHttpsProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetHttpsProxy resources.
      { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
          "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
          "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
            "A String",
          ],
          "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
              # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
              # - projects/project/global/urlMaps/url-map
              # - global/urlMaps/url-map
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setSslCertificates(project, targetHttpsProxy, body) 
Replaces SslCertificates for TargetHttpsProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setUrlMap(project, targetHttpsProxy, body) 
Changes the URL map for TargetHttpsProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "urlMap": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetInstances.html000066400000000000000000000753451300622755700267530ustar00rootroot00000000000000

Compute Engine API . targetInstances

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target instances.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, targetInstance)

Deletes the specified TargetInstance resource.

get(project, zone, targetInstance)

Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

insert(project, zone, body)

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of TargetInstance resources available to the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target instances.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped target instance lists.
      "a_key": { # Name of the scope containing this set of target instances.
        "targetInstances": [ # List of target instances contained in this scope.
          { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
              "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
              "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
              "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
                  # - projects/project/zones/zone/instances/instance
                  # - zones/zone/instances/instance
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#targetInstanceAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, zone, targetInstance) 
Deletes the specified TargetInstance resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  targetInstance: string, Name of the TargetInstance resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, targetInstance) 
Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  targetInstance: string, Name of the TargetInstance resource to return. (required)

Returns:
  An object of the form:

    { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
      "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
      "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
      "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
          # - projects/project/zones/zone/instances/instance
          # - zones/zone/instances/instance
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, zone, body) 
Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Args:
  project: string, Project ID for 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 TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
    "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
    "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
    "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
        # - zones/zone/instances/instance
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of TargetInstance resources available to the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetInstance resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetInstance resources.
      { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
          "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
          "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
          "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
              # - projects/project/zones/zone/instances/instance
              # - zones/zone/instances/instance
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetInstanceList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetPools.html000066400000000000000000002114421300622755700261060ustar00rootroot00000000000000

Compute Engine API . targetPools

Instance Methods

addHealthCheck(project, region, targetPool, body)

Adds health check URLs to a target pool.

addInstance(project, region, targetPool, body)

Adds an instance to a target pool.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target pools.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetPool)

Deletes the specified target pool.

get(project, region, targetPool)

Returns the specified target pool. Get a list of available target pools by making a list() request.

getHealth(project, region, targetPool, body)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

insert(project, region, body)

Creates a target pool in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of target pools available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeHealthCheck(project, region, targetPool, body)

Removes health check URL from a target pool.

removeInstance(project, region, targetPool, body)

Removes instance URL from a target pool.

setBackup(project, region, targetPool, body, failoverRatio=None)

Changes a backup target pool's configurations.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addHealthCheck(project, region, targetPool, body) 
Adds health check URLs to a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the target pool to add a health check to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
          # - projects/project-id/global/httpHealthChecks/health-check
          # - global/httpHealthChecks/health-check
        "healthCheck": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
addInstance(project, region, targetPool, body) 
Adds an instance to a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to add instances to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
        # - projects/project-id/zones/zone/instances/instance-name
        # - zones/zone/instances/instance-name
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target pools.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped target pool lists.
      "a_key": { # Name of the scope containing this set of target pools.
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "targetPools": [ # List of target pools contained in this scope.
          { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
              "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
                  #
                  # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
                  #
                  # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "region": "A String", # [Output Only] URL of the region where the target pool resides.
              "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
              "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
                  # NONE: Connections from the same client IP may go to any instance in the pool.
                  # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
                  # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
              "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
                "A String",
              ],
              "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
                  #
                  # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
                  #
                  # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
              "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, targetPool) 
Deletes the specified target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, targetPool) 
Returns the specified target pool. Get a list of available target pools by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to return. (required)

Returns:
  An object of the form:

    { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
      "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
          #
          # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
          #
          # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the target pool resides.
      "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
      "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
          # NONE: Connections from the same client IP may go to any instance in the pool.
          # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
          # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
      "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
        "A String",
      ],
      "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
          #
          # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
          #
          # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
      "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getHealth(project, region, targetPool, body) 
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "instance": "A String", # The URL for a specific instance.
}


Returns:
  An object of the form:

    {
    "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, region, body) 
Creates a target pool in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for 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 TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
    "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
        # 
        # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
        # 
        # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the target pool resides.
    "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
    "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
        # NONE: Connections from the same client IP may go to any instance in the pool.
        # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
        # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
    "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
      "A String",
    ],
    "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
        # 
        # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
        # 
        # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
    "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of target pools available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetPool resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetPool resources.
      { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
          "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
              #
              # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
              #
              # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the target pool resides.
          "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
          "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
              # NONE: Connections from the same client IP may go to any instance in the pool.
              # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
              # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
          "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
            "A String",
          ],
          "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
              #
              # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
              #
              # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
          "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
removeHealthCheck(project, region, targetPool, body) 
Removes health check URL from a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetPool: string, Name of the target pool to remove health checks from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
        # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
        # - projects/project/global/httpHealthChecks/health-check
        # - global/httpHealthChecks/health-check
      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
          # - projects/project-id/global/httpHealthChecks/health-check
          # - global/httpHealthChecks/health-check
        "healthCheck": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
removeInstance(project, region, targetPool, body) 
Removes instance URL from a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to remove instances from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # URLs of the instances to be removed from target pool.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setBackup(project, region, targetPool, body, failoverRatio=None) 
Changes a backup target pool's configurations.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }

  failoverRatio: number, New failoverRatio value for the target pool.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetSslProxies.html000066400000000000000000001147551300622755700271360ustar00rootroot00000000000000

Compute Engine API . targetSslProxies

Instance Methods

delete(project, targetSslProxy)

Deletes the specified TargetSslProxy resource.

get(project, targetSslProxy)

Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

insert(project, body)

Creates a TargetSslProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetSslProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setBackendService(project, targetSslProxy, body)

Changes the BackendService for TargetSslProxy.

setProxyHeader(project, targetSslProxy, body)

Changes the ProxyHeaderType for TargetSslProxy.

setSslCertificates(project, targetSslProxy, body)

Changes SslCertificates for TargetSslProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetSslProxy) 
Deletes the specified TargetSslProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetSslProxy) 
Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetSslProxy resource. This resource defines an SSL proxy.
      "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
      "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "service": "A String", # URL to the BackendService resource.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetSslProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetSslProxy resource. This resource defines an SSL proxy.
    "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
    "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "service": "A String", # URL to the BackendService resource.
    "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetSslProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetSslProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetSslProxy resources.
      { # A TargetSslProxy resource. This resource defines an SSL proxy.
          "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
          "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "service": "A String", # URL to the BackendService resource.
          "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetSslProxyList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setBackendService(project, targetSslProxy, body) 
Changes the BackendService for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setProxyHeader(project, targetSslProxy, body) 
Changes the ProxyHeaderType for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setSslCertificates(project, targetSslProxy, body) 
Changes SslCertificates for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetTcpProxies.html000066400000000000000000001000011300622755700270760ustar00rootroot00000000000000

Compute Engine API . targetTcpProxies

Instance Methods

delete(project, targetTcpProxy)

Deletes the specified TargetTcpProxy resource.

get(project, targetTcpProxy)

Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.

insert(project, body)

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetTcpProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setBackendService(project, targetTcpProxy, body)

Changes the BackendService for TargetTcpProxy.

setProxyHeader(project, targetTcpProxy, body)

Changes the ProxyHeaderType for TargetTcpProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetTcpProxy) 
Deletes the specified TargetTcpProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetTcpProxy) 
Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetTcpProxy resource. This resource defines a TCP proxy.
      "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "service": "A String", # URL to the BackendService resource.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetTcpProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetTcpProxy resource. This resource defines a TCP proxy.
    "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "service": "A String", # URL to the BackendService resource.
    "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetTcpProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetTcpProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetTcpProxy resources.
      { # A TargetTcpProxy resource. This resource defines a TCP proxy.
          "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "service": "A String", # URL to the BackendService resource.
          "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetTcpProxyList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setBackendService(project, targetTcpProxy, body) 
Changes the BackendService for TargetTcpProxy.

Args:
  project: string, Project ID for this request. (required)
  targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setProxyHeader(project, targetTcpProxy, body) 
Changes the ProxyHeaderType for TargetTcpProxy.

Args:
  project: string, Project ID for this request. (required)
  targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.targetVpnGateways.html000066400000000000000000000753351300622755700272730ustar00rootroot00000000000000

Compute Engine API . targetVpnGateways

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target VPN gateways.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetVpnGateway)

Deletes the specified target VPN gateway.

get(project, region, targetVpnGateway)

Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

insert(project, region, body)

Creates a target VPN gateway in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of target VPN gateways available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target VPN gateways.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped target vpn gateway lists.
      "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
        "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
          { # Represents a Target VPN gateway resource.
              "status": "A String", # [Output Only] The status of the VPN gateway.
              "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
                "A String",
              ],
              "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
              "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
                "A String",
              ],
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, targetVpnGateway) 
Deletes the specified target VPN gateway.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetVpnGateway: string, Name of the target VPN gateway to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, targetVpnGateway) 
Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetVpnGateway: string, Name of the target VPN gateway to return. (required)

Returns:
  An object of the form:

    { # Represents a Target VPN gateway resource.
      "status": "A String", # [Output Only] The status of the VPN gateway.
      "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
        "A String",
      ],
      "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
      "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
        "A String",
      ],
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a target VPN gateway in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Target VPN gateway resource.
    "status": "A String", # [Output Only] The status of the VPN gateway.
    "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
      "A String",
    ],
    "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
    "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
      "A String",
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of target VPN gateways available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetVpnGateway resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of TargetVpnGateway resources.
      { # Represents a Target VPN gateway resource.
          "status": "A String", # [Output Only] The status of the VPN gateway.
          "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
            "A String",
          ],
          "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
          "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
            "A String",
          ],
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.urlMaps.html000066400000000000000000001720171300622755700252320ustar00rootroot00000000000000

Compute Engine API . urlMaps

Instance Methods

delete(project, urlMap)

Deletes the specified UrlMap resource.

get(project, urlMap)

Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

insert(project, body)

Creates a UrlMap resource in the specified project using the data included in the request.

invalidateCache(project, urlMap, body)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of UrlMap resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, urlMap, body)

Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, urlMap, body)

Updates the specified UrlMap resource with the data included in the request.

validate(project, urlMap, body)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Method Details

delete(project, urlMap) 
Deletes the specified UrlMap resource.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, urlMap) 
Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to return. (required)

Returns:
  An object of the form:

    { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
      "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
      "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
        { # Message for the expected URL mappings.
          "path": "A String", # Path portion of the URL.
          "host": "A String", # Host portion of the URL.
          "description": "A String", # Description of this test case.
          "service": "A String", # Expected BackendService resource the given URL should be mapped to.
        },
      ],
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
      "pathMatchers": [ # The list of named PathMatchers to use against the URL.
        { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
          "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
              # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
              # - compute/v1/projects/project/global/backendServices/backendService
              # - global/backendServices/backendService
          "pathRules": [ # The list of path rules.
            { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
              "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                "A String",
              ],
              "service": "A String", # The URL of the BackendService resource if this rule is matched.
            },
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "hostRules": [ # The list of HostRules to use against the URL.
        { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
          "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
            "A String",
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
        },
      ],
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a UrlMap resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
invalidateCache(project, urlMap, body) 
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap scoping this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "path": "A String",
    "host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of UrlMap resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of UrlMap resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of UrlMap resources.
      { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
          "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
          "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
            { # Message for the expected URL mappings.
              "path": "A String", # Path portion of the URL.
              "host": "A String", # Host portion of the URL.
              "description": "A String", # Description of this test case.
              "service": "A String", # Expected BackendService resource the given URL should be mapped to.
            },
          ],
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
          "pathMatchers": [ # The list of named PathMatchers to use against the URL.
            { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
              "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
                  # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
                  # - compute/v1/projects/project/global/backendServices/backendService
                  # - global/backendServices/backendService
              "pathRules": [ # The list of path rules.
                { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
                  "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                    "A String",
                  ],
                  "service": "A String", # The URL of the BackendService resource if this rule is matched.
                },
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "hostRules": [ # The list of HostRules to use against the URL.
            { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
              "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
                "A String",
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
            },
          ],
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#urlMapList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, urlMap, body) 
Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, urlMap, body) 
Updates the specified UrlMap resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
validate(project, urlMap, body) 
Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to be validated as. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
        "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
        "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
          { # Message for the expected URL mappings.
            "path": "A String", # Path portion of the URL.
            "host": "A String", # Host portion of the URL.
            "description": "A String", # Description of this test case.
            "service": "A String", # Expected BackendService resource the given URL should be mapped to.
          },
        ],
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
        "pathMatchers": [ # The list of named PathMatchers to use against the URL.
          { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
            "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
                # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
                # - compute/v1/projects/project/global/backendServices/backendService
                # - global/backendServices/backendService
            "pathRules": [ # The list of path rules.
              { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
                "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                  "A String",
                ],
                "service": "A String", # The URL of the BackendService resource if this rule is matched.
              },
            ],
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "hostRules": [ # The list of HostRules to use against the URL.
          { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
            "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
              "A String",
            ],
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
          },
        ],
        "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      },
  }


Returns:
  An object of the form:

    {
    "result": { # Message representing the validation result for a UrlMap.
      "testFailures": [
        {
          "path": "A String",
          "actualService": "A String",
          "host": "A String",
          "expectedService": "A String",
        },
      ],
      "loadErrors": [
        "A String",
      ],
      "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
      "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
    },
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.vpnTunnels.html000066400000000000000000001077411300622755700257650ustar00rootroot00000000000000

Compute Engine API . vpnTunnels

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of VPN tunnels.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, vpnTunnel)

Deletes the specified VpnTunnel resource.

get(project, region, vpnTunnel)

Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

insert(project, region, body)

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of VPN tunnels.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped vpn tunnel lists.
      "a_key": { # Name of the scope containing this set of vpn tunnels.
        "vpnTunnels": [ # List of vpn tunnels contained in this scope.
          {
              "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
              "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
              "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
              "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
                "A String",
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "peerIp": "A String", # IP address of the peer VPN gateway.
              "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
                  #
                  # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
              "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
                "a_key": "A String",
              },
              "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
              "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
                "A String",
              ],
              "status": "A String", # [Output Only] The status of the VPN tunnel.
              "sharedSecretHash": "A String", # Hash of the shared secret.
              "router": "A String", # URL of router resource to be used for dynamic routing.
              "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
              "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, vpnTunnel) 
Deletes the specified VpnTunnel resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, vpnTunnel) 
Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  vpnTunnel: string, Name of the VpnTunnel resource to return. (required)

Returns:
  An object of the form:

    {
      "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
      "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
      "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
      "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
        "A String",
      ],
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "peerIp": "A String", # IP address of the peer VPN gateway.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
      "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
      "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
        "A String",
      ],
      "status": "A String", # [Output Only] The status of the VPN tunnel.
      "sharedSecretHash": "A String", # Hash of the shared secret.
      "router": "A String", # URL of router resource to be used for dynamic routing.
      "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
      "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
    "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
    "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
      "A String",
    ],
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "peerIp": "A String", # IP address of the peer VPN gateway.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
      "A String",
    ],
    "status": "A String", # [Output Only] The status of the VPN tunnel.
    "sharedSecretHash": "A String", # Hash of the shared secret.
    "router": "A String", # URL of router resource to be used for dynamic routing.
    "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
    "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of VpnTunnel resources contained in the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of VpnTunnel resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of VpnTunnel resources.
      {
          "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
          "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
          "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
          "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
            "A String",
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "peerIp": "A String", # IP address of the peer VPN gateway.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
          "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
          "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
            "A String",
          ],
          "status": "A String", # [Output Only] The status of the VPN tunnel.
          "sharedSecretHash": "A String", # Hash of the shared secret.
          "router": "A String", # URL of router resource to be used for dynamic routing.
          "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
          "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_alpha.zoneOperations.html000066400000000000000000000377531300622755700266350ustar00rootroot00000000000000

Compute Engine API . zoneOperations

Instance Methods

delete(project, zone, operation)

Deletes the specified zone-specific Operations resource.

get(project, zone, operation)

Retrieves the specified zone-specific Operations resource.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, zone, operation) 
Retrieves the specified zone-specific Operations resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_alpha.zones.html000066400000000000000000000231411300622755700247360ustar00rootroot00000000000000

Compute Engine API . zones

Instance Methods

get(project, zone)

Returns the specified Zone resource. Get a list of available zones by making a list() request.

list(project, orderBy=None, 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. Get a list of available zones by making a list() request.

Args:
  project: string, Project ID for 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", # [Output Only] Status of the zone, either UP or DOWN.
    "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
    "description": "A String", # [Output Only] Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Zone resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of zone resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Zone resources.
      { # A Zone resource.
        "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
        "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#zoneList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.addresses.html000066400000000000000000000733331300622755700254130ustar00rootroot00000000000000

Compute Engine API . addresses

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of addresses.

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, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of addresses contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of addresses.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped address lists.
      "a_key": { # [Output Only] Name of the scope containing this set of addresses.
        "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "addresses": [ # [Output Only] List of addresses contained in this scope.
          { # A reserved address resource.
              "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
              "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
              "address": "A String", # The static external IP address represented by this resource.
              "users": [ # [Output Only] The URLs of the resources that are using this address.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, Project ID for this request. (required)
  region: string, Name of the region for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, address) 
Returns the specified address resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
      "address": "A String", # The static external IP address represented by this resource.
      "users": [ # [Output Only] The URLs of the resources that are using this address.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates an address resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A reserved address resource.
    "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
    "address": "A String", # The static external IP address represented by this resource.
    "users": [ # [Output Only] The URLs of the resources that are using this address.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of addresses contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of addresses.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of addresses.
      { # A reserved address resource.
          "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
          "address": "A String", # The static external IP address represented by this resource.
          "users": [ # [Output Only] The URLs of the resources that are using this address.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.autoscalers.html000066400000000000000000002150621300622755700257600ustar00rootroot00000000000000

Compute Engine API . autoscalers

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of autoscalers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, autoscaler)

Deletes the specified autoscaler.

get(project, zone, autoscaler)

Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

insert(project, zone, body)

Creates an autoscaler in the specified project using the data included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of autoscalers contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, zone, autoscaler, body)

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, zone, body, autoscaler=None)

Updates an autoscaler in the specified project using the data included in the request.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of autoscalers.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped autoscaler lists.
      "a_key": { # [Output Only] Name of the scope containing this set of autoscalers.
        "warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "autoscalers": [ # [Output Only] List of autoscalers contained in this scope.
          { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
              "status": "A String", # [Output Only] The status of the autoscaler configuration.
              "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
              "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
              "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
                  #
                  # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
                "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
                "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                    #
                    # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
                "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
                  "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
                },
                "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
                  { # Custom utilization metric policy.
                    "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                        #
                        # For example, the following is a valid metric:
                        # compute.googleapis.com/instance/network/received_bytes_count
                        # The following is not a valid metric because it does not increase or decrease based on usage:
                        # compute.googleapis.com/instance/cpu/reserved_cores
                    "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                    "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
                  },
                ],
                "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
                  "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                      #
                      # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                      #
                      # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
                },
                "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
              },
              "target": "A String", # URL of the managed instance group that this autoscaler will scale.
              "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
                {
                  "message": "A String", # The status message.
                  "type": "A String", # The type of error returned.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, zone, autoscaler) 
Deletes the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, autoscaler) 
Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to return. (required)

Returns:
  An object of the form:

    { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
      "status": "A String", # [Output Only] The status of the autoscaler configuration.
      "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
      "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
      "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
          #
          # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
        "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
            #
            # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
        "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
          "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
        },
        "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
          { # Custom utilization metric policy.
            "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                #
                # For example, the following is a valid metric:
                # compute.googleapis.com/instance/network/received_bytes_count
                # The following is not a valid metric because it does not increase or decrease based on usage:
                # compute.googleapis.com/instance/cpu/reserved_cores
            "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
            "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
          },
        ],
        "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
          "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
              #
              # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
              #
              # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
        },
        "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
      },
      "target": "A String", # URL of the managed instance group that this autoscaler will scale.
      "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        {
          "message": "A String", # The status message.
          "type": "A String", # The type of error returned.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, zone, body) 
Creates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of autoscalers contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Autoscaler resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of Autoscaler resources.
      { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
          "status": "A String", # [Output Only] The status of the autoscaler configuration.
          "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
          "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
          "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
              #
              # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
            "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
            "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                #
                # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
            "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
              "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
            },
            "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
              { # Custom utilization metric policy.
                "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                    #
                    # For example, the following is a valid metric:
                    # compute.googleapis.com/instance/network/received_bytes_count
                    # The following is not a valid metric because it does not increase or decrease based on usage:
                    # compute.googleapis.com/instance/cpu/reserved_cores
                "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
              },
            ],
            "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
              "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                  #
                  # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                  #
                  # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
            },
            "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
          },
          "target": "A String", # URL of the managed instance group that this autoscaler will scale.
          "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
            {
              "message": "A String", # The status message.
              "type": "A String", # The type of error returned.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, zone, autoscaler, body) 
Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, zone, body, autoscaler=None) 
Updates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  autoscaler: string, Name of the autoscaler to update.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.backendServices.html000066400000000000000000002376551300622755700265420ustar00rootroot00000000000000

Compute Engine API . backendServices

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, backendService)

Deletes the specified BackendService resource.

get(project, backendService)

Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

getHealth(project, backendService, body)

Gets the most recent health check results for this BackendService.

insert(project, body)

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of BackendService resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, backendService, body)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, backendService, body)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Args:
  project: string, Name of the project scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendServicesScopedList.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": { # A map of scoped BackendService lists.
      "a_key": { # Name of the scope containing this set of BackendServices.
        "warning": { # Informational warning which replaces the list of backend services when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "backendServices": [ # List of BackendServices contained in this scope.
          { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
              "connectionDraining": { # Message containing connection draining configuration.
                "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
              },
              "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
              "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
                  #
                  # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
                  #
                  # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
              "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
                  #
                  # When the load balancing scheme is INTERNAL, this field is not used.
              "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
              "loadBalancingScheme": "A String",
              "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
                  #
                  # When the load balancing scheme is INTERNAL, this field is not used.
              "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
                  #
                  # This cannot be used for internal load balancing.
              "backends": [ # The list of backends that serve this BackendService.
                { # Message containing information of one individual backend.
                  "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                      #
                      # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                      #
                      # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
                  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
                  "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                      #
                      # This cannot be used for internal load balancing.
                  "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                      #
                      # This cannot be used for internal load balancing.
                  "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                      #
                      # This cannot be used for internal load balancing.
                  "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                      #
                      # This cannot be used for internal load balancing.
                },
              ],
              "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
              "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
                  #
                  # When the load balancing scheme is INTERNAL, this field is not used.
              "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
                  #
                  # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
                "A String",
              ],
              "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
                  #
                  # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
                  #
                  # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
                  #
                  # When the protocol is UDP, this field is not used.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#backendServiceAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, backendService) 
Deletes the specified BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, backendService) 
Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to return. (required)

Returns:
  An object of the form:

    { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
      "connectionDraining": { # Message containing connection draining configuration.
        "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
      },
      "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
      "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
          #
          # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
          #
          # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
      "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
      "loadBalancingScheme": "A String",
      "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
          #
          # This cannot be used for internal load balancing.
      "backends": [ # The list of backends that serve this BackendService.
        { # Message containing information of one individual backend.
          "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
              #
              # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
              #
              # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
              #
              # This cannot be used for internal load balancing.
        },
      ],
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
      "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
          #
          # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
        "A String",
      ],
      "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
          #
          # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
          #
          # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
          #
          # When the protocol is UDP, this field is not used.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getHealth(project, backendService, body) 
Gets the most recent health check results for this BackendService.

Args:
  project: string, A parameter (required)
  backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
  }


Returns:
  An object of the form:

    {
    "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, body) 
Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "loadBalancingScheme": "A String",
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of BackendService resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendService resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of BackendService resources.
      { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
          "connectionDraining": { # Message containing connection draining configuration.
            "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
          },
          "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
          "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
              #
              # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
              #
              # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
          "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
          "loadBalancingScheme": "A String",
          "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
              #
              # This cannot be used for internal load balancing.
          "backends": [ # The list of backends that serve this BackendService.
            { # Message containing information of one individual backend.
              "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                  #
                  # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                  #
                  # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                  #
                  # This cannot be used for internal load balancing.
            },
          ],
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
          "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
              #
              # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
            "A String",
          ],
          "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
              #
              # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
              #
              # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
              #
              # When the protocol is UDP, this field is not used.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, backendService, body) 
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "loadBalancingScheme": "A String",
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, backendService, body) 
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "loadBalancingScheme": "A String",
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.diskTypes.html000066400000000000000000000436511300622755700254150ustar00rootroot00000000000000

Compute Engine API . diskTypes

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of disk types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, diskType)

Returns the specified disk type. Get a list of available disk types by making a list() request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of disk types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of disk types.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped disk type lists.
      "a_key": { # [Output Only] Name of the scope containing this set of disk types.
        "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "diskTypes": [ # [Output Only] List of disk types contained in this scope.
          { # A DiskType resource.
            "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
            "description": "A String", # [Output Only] An optional description of this resource.
            "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
            "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
            "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
      },
    },
    "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, diskType) 
Returns the specified disk type. Get a list of available disk types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  diskType: string, Name of the disk type to return. (required)

Returns:
  An object of the form:

    { # A DiskType resource.
    "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
    "description": "A String", # [Output Only] An optional description of this resource.
    "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
    "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
    "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of disk types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of disk types.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Disk Type resources.
      { # A DiskType resource.
        "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
        "description": "A String", # [Output Only] An optional description of this resource.
        "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
        "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.disks.html000066400000000000000000002465661300622755700245650ustar00rootroot00000000000000

Compute Engine API . disks

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of persistent disks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

createSnapshot(project, zone, disk, body, guestFlush=None)

Creates a snapshot of a specified persistent disk.

delete(project, zone, disk)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

get(project, zone, disk)

Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

insert(project, zone, body, sourceImage=None)

Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of persistent disks contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

resize(project, zone, disk, body)

Resizes the specified persistent disk.

setLabels(project, zone, resource, body)

Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of persistent disks.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped disk lists.
      "a_key": { # [Output Only] Name of the scope containing this set of disks.
        "disks": [ # [Output Only] List of disks contained in this scope.
          { # A Disk resource.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
                "a_key": "A String",
              },
              "licenses": [ # Any applicable publicly visible licenses.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
                "A String",
              ],
              "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
                  #
                  # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
                  #
                  # Customer-supplied encryption keys do not protect access to metadata of the disk.
                  #
                  # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "zone": "A String", # [Output Only] URL of the zone where the disk resides.
              "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
              "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
              "status": "A String", # [Output Only] The status of disk creation.
              "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
                  # - projects/project/global/snapshots/snapshot
                  # - global/snapshots/snapshot
              "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
              "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
                  #
                  # To see the latest fingerprint, make a get() request to retrieve a disk.
              "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
              "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
                  #
                  # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
              "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "options": "A String", # Internal use only.
              "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
            },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, guestFlush=None) 
Creates a snapshot of a specified persistent disk.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to snapshot. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A persistent disk snapshot resource.
    "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
    "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
    "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
        # 
        # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a snapshot.
    "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
    "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  guestFlush: boolean, A parameter

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, zone, disk) 
Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, disk) 
Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to return. (required)

Returns:
  An object of the form:

    { # A Disk resource.
      "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "licenses": [ # Any applicable publicly visible licenses.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
        "A String",
      ],
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
          #
          # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "zone": "A String", # [Output Only] URL of the zone where the disk resides.
      "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
      "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
      "status": "A String", # [Output Only] The status of disk creation.
      "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
          # - projects/project/global/snapshots/snapshot
          # - global/snapshots/snapshot
      "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a disk.
      "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
      "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
          #
          # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
          #
          # projects/debian-cloud/global/images/family/debian-8
          #
          # Alternatively, use a specific version of a public operating system image:
          #
          # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
          #
          # To create a disk with a private image that you created, specify the image name in the following format:
          #
          # global/images/my-private-image
          #
          # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
          #
          # global/images/family/my-private-family
      "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
      "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
          #
          # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
      "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "options": "A String", # Internal use only.
      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    }
insert(project, zone, body, sourceImage=None) 
Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Disk resource.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "licenses": [ # Any applicable publicly visible licenses.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
      "A String",
    ],
    "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
        # 
        # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "zone": "A String", # [Output Only] URL of the zone where the disk resides.
    "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
    "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
    "status": "A String", # [Output Only] The status of disk creation.
    "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
        # - projects/project/global/snapshots/snapshot
        # - global/snapshots/snapshot
    "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve a disk.
    "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        # 
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        # 
        # projects/debian-cloud/global/images/family/debian-8
        # 
        # Alternatively, use a specific version of a public operating system image:
        # 
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        # 
        # To create a disk with a private image that you created, specify the image name in the following format:
        # 
        # global/images/my-private-image
        # 
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        # 
        # global/images/family/my-private-family
    "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
    "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
        # 
        # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
    "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "options": "A String", # Internal use only.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
  }

  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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of persistent disks contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of Disk resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of persistent disks.
      { # A Disk resource.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "licenses": [ # Any applicable publicly visible licenses.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
            "A String",
          ],
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
              #
              # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "zone": "A String", # [Output Only] URL of the zone where the disk resides.
          "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
          "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
          "status": "A String", # [Output Only] The status of disk creation.
          "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
              # - projects/project/global/snapshots/snapshot
              # - global/snapshots/snapshot
          "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a disk.
          "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
          "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
          "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
              #
              # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
          "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "options": "A String", # Internal use only.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        },
    ],
    "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
resize(project, zone, disk, body) 
Resizes the specified persistent disk.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, The name of the persistent disk. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sizeGb": "A String", # The new size of the persistent disk, which is specified in GB.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setLabels(project, zone, resource, body) 
Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # The labels to set for this resource.
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.firewalls.html000066400000000000000000001353761300622755700254340ustar00rootroot00000000000000

Compute Engine API . firewalls

Instance Methods

delete(project, firewall)

Deletes the specified firewall.

get(project, firewall)

Returns the specified firewall.

insert(project, body)

Creates a firewall rule in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of firewall rules 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 rule with the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, firewall, body)

Updates the specified firewall rule with the data included in the request.

Method Details

delete(project, firewall) 
Deletes the specified firewall.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, firewall) 
Returns the specified firewall.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to return. (required)

Returns:
  An object of the form:

    { # Represents a Firewall resource.
      "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
        "A String",
      ],
      "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
        "A String",
      ],
      "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
          # global/networks/default
          # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
          # - projects/myproject/global/networks/my-network
          # - global/networks/default
      "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
        {
          "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
          "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
              #
              # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
            "A String",
          ],
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a firewall rule in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of firewall rules available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of firewalls.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Firewall resources.
      { # Represents a Firewall resource.
          "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
            "A String",
          ],
          "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
            "A String",
          ],
          "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
              # global/networks/default
              # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
              # - projects/myproject/global/networks/my-network
              # - global/networks/default
          "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
            {
              "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
              "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
                  #
                  # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
                "A String",
              ],
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, firewall, body) 
Updates the specified firewall rule with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, firewall, body) 
Updates the specified firewall rule with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.forwardingRules.html000066400000000000000000001420401300622755700266030ustar00rootroot00000000000000

Compute Engine API . forwardingRules

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of forwarding rules.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, forwardingRule)

Deletes the specified ForwardingRule resource.

get(project, region, forwardingRule)

Returns the specified ForwardingRule resource.

insert(project, region, body)

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of ForwardingRule resources available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, region, forwardingRule, body)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of forwarding rules.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped forwarding rule lists.
      "a_key": { # Name of the scope containing this set of addresses.
        "forwardingRules": [ # List of forwarding rules contained in this scope.
          { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
              "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
                  #
                  # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
                  #
                  # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
              "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
              "ports": [ # This field is not used for external load balancing.
                  #
                  # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
                  #
                  # You may specify a maximum of up to 5 ports.
                "A String",
              ],
              "network": "A String", # This field is not used for external load balancing.
                  #
                  # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
              "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
              "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
                  #
                  # This field is not used for internal load balancing.
              "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
                  #
                  # This field is not used for internal load balancing.
              "backendService": "A String", # This field is not used for external load balancing.
                  #
                  # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
              "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
                  #
                  # When the load balancing scheme is INTERNAL
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, forwardingRule) 
Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, forwardingRule) 
Returns the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)

Returns:
  An object of the form:

    { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
          #
          # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
          #
          # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
      "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
      "ports": [ # This field is not used for external load balancing.
          #
          # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
          #
          # You may specify a maximum of up to 5 ports.
        "A String",
      ],
      "network": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
      "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
          #
          # This field is not used for internal load balancing.
      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
          #
          # This field is not used for internal load balancing.
      "backendService": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
      "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
          #
          # When the load balancing scheme is INTERNAL
insert(project, region, body) 
Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for 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 ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
        # 
        # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
        # 
        # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
    "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
    "ports": [ # This field is not used for external load balancing.
        # 
        # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
        # 
        # You may specify a maximum of up to 5 ports.
      "A String",
    ],
    "network": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
    "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
        # 
        # This field is not used for internal load balancing.
    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
        # 
        # This field is not used for internal load balancing.
    "backendService": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
    "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
        # 
        # When the load balancing scheme is INTERNAL
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of ForwardingRule resources available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of ForwardingRule resources.
      { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
              #
              # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
              #
              # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
          "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
          "ports": [ # This field is not used for external load balancing.
              #
              # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
              #
              # You may specify a maximum of up to 5 ports.
            "A String",
          ],
          "network": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
          "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
              #
              # This field is not used for internal load balancing.
          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
              #
              # This field is not used for internal load balancing.
          "backendService": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
          "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
              #
              # When the load balancing scheme is INTERNAL
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.
setTarget(project, region, forwardingRule, body) 
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.globalAddresses.html000066400000000000000000000540251300622755700265310ustar00rootroot00000000000000

Compute Engine API . globalAddresses

Instance Methods

delete(project, address)

Deletes the specified address resource.

get(project, address)

Returns the specified address resource. Get a list of available addresses by making a list() request.

insert(project, body)

Creates an address resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of global addresses.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, address) 
Deletes the specified address resource.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, address) 
Returns the specified address resource. Get a list of available addresses by making a list() request.

Args:
  project: string, Project ID for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
      "address": "A String", # The static external IP address represented by this resource.
      "users": [ # [Output Only] The URLs of the resources that are using this address.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an address resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A reserved address resource.
    "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
    "address": "A String", # The static external IP address represented by this resource.
    "users": [ # [Output Only] The URLs of the resources that are using this address.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of global addresses.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of addresses.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of addresses.
      { # A reserved address resource.
          "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
          "address": "A String", # The static external IP address represented by this resource.
          "users": [ # [Output Only] The URLs of the resources that are using this address.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.globalForwardingRules.html000066400000000000000000001133141300622755700277260ustar00rootroot00000000000000

Compute Engine API . globalForwardingRules

Instance Methods

delete(project, forwardingRule)

Deletes the specified ForwardingRule resource.

get(project, forwardingRule)

Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

insert(project, body)

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of ForwardingRule resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, forwardingRule, body)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, forwardingRule) 
Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, forwardingRule) 
Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)

Returns:
  An object of the form:

    { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
          #
          # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
          #
          # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
      "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
      "ports": [ # This field is not used for external load balancing.
          #
          # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
          #
          # You may specify a maximum of up to 5 ports.
        "A String",
      ],
      "network": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
      "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
          #
          # This field is not used for internal load balancing.
      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
          #
          # This field is not used for internal load balancing.
      "backendService": "A String", # This field is not used for external load balancing.
          #
          # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
      "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
          #
          # When the load balancing scheme is INTERNAL
insert(project, body) 
Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
        # 
        # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
        # 
        # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
    "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
    "ports": [ # This field is not used for external load balancing.
        # 
        # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
        # 
        # You may specify a maximum of up to 5 ports.
      "A String",
    ],
    "network": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
    "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
        # 
        # This field is not used for internal load balancing.
    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
        # 
        # This field is not used for internal load balancing.
    "backendService": "A String", # This field is not used for external load balancing.
        # 
        # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
    "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
        # 
        # When the load balancing scheme is INTERNAL
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of ForwardingRule resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of ForwardingRule resources.
      { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
              #
              # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
              #
              # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
          "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
          "ports": [ # This field is not used for external load balancing.
              #
              # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
              #
              # You may specify a maximum of up to 5 ports.
            "A String",
          ],
          "network": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
          "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
              #
              # This field is not used for internal load balancing.
          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
              #
              # This field is not used for internal load balancing.
          "backendService": "A String", # This field is not used for external load balancing.
              #
              # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
          "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
              #
              # When the load balancing scheme is INTERNAL
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.
setTarget(project, forwardingRule, body) 
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.globalOperations.html000066400000000000000000000647331300622755700267460ustar00rootroot00000000000000

Compute Engine API . globalOperations

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of all operations.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, operation)

Deletes the specified Operations resource.

get(project, operation)

Retrieves the specified Operations resource. Get a list of operations by making a list() request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of all operations.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped operation lists.
      "a_key": { # [Output Only] Name of the scope containing this set of operations.
        "operations": [ # [Output Only] List of operations contained in this scope.
          { # An Operation resource, used to manage asynchronous API requests.
            "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
            "clientOperationId": "A String", # [Output Only] Reserved for future use.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
            "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
            "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
            "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
            "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
            "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
            "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
            "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
            "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
            "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
              {
                "message": "A String", # [Output Only] A human-readable description of the warning code.
                "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                    # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                  {
                    "value": "A String", # [Output Only] A warning data value corresponding to the key.
                    "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                  },
                ],
              },
            ],
            "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
            "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
            "name": "A String", # [Output Only] Name of the resource.
            "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
            "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
              "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                {
                  "message": "A String", # [Output Only] An optional, human-readable error message.
                  "code": "A String", # [Output Only] The error type identifier for this error.
                  "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
                },
              ],
            },
            "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified Operations resource. Get a list of operations by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.healthChecks.html000066400000000000000000001627371300622755700260330ustar00rootroot00000000000000

Compute Engine API . healthChecks

Instance Methods

delete(project, healthCheck)

Deletes the specified HealthCheck resource.

get(project, healthCheck)

Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

insert(project, body)

Creates a HealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, healthCheck, body)

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, healthCheck, body)

Updates a HealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, healthCheck) 
Deletes the specified HealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, healthCheck) 
Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
      "kind": "compute#healthCheck", # Type of the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
      "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
      "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
      "tcpHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 80.
        "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
      },
      "httpHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 80.
        "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
      },
      "httpsHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
      },
      "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
      "http2HealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
      },
      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "sslHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
      },
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
    },
    "httpsHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HealthCheck resources.
      { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
          "kind": "compute#healthCheck", # Type of the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
          "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
          "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
          "tcpHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 80.
            "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
          },
          "httpHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 80.
            "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
          },
          "httpsHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
          },
          "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
          "http2HealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
          },
          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "sslHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
          },
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#healthCheckList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, healthCheck, body) 
Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
    },
    "httpsHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, healthCheck, body) 
Updates a HealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
    },
    "httpsHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.html000066400000000000000000000217641300622755700234400ustar00rootroot00000000000000

Compute Engine API

Instance Methods

addresses()

Returns the addresses Resource.

autoscalers()

Returns the autoscalers Resource.

backendServices()

Returns the backendServices Resource.

diskTypes()

Returns the diskTypes Resource.

disks()

Returns the disks Resource.

firewalls()

Returns the firewalls Resource.

forwardingRules()

Returns the forwardingRules Resource.

globalAddresses()

Returns the globalAddresses Resource.

globalForwardingRules()

Returns the globalForwardingRules Resource.

globalOperations()

Returns the globalOperations Resource.

healthChecks()

Returns the healthChecks Resource.

httpHealthChecks()

Returns the httpHealthChecks Resource.

httpsHealthChecks()

Returns the httpsHealthChecks Resource.

images()

Returns the images Resource.

instanceGroupManagers()

Returns the instanceGroupManagers Resource.

instanceGroups()

Returns the instanceGroups Resource.

instanceTemplates()

Returns the instanceTemplates Resource.

instances()

Returns the instances Resource.

licenses()

Returns the licenses Resource.

machineTypes()

Returns the machineTypes Resource.

networks()

Returns the networks Resource.

projects()

Returns the projects Resource.

regionAutoscalers()

Returns the regionAutoscalers Resource.

regionBackendServices()

Returns the regionBackendServices Resource.

regionInstanceGroupManagers()

Returns the regionInstanceGroupManagers Resource.

regionInstanceGroups()

Returns the regionInstanceGroups Resource.

regionOperations()

Returns the regionOperations Resource.

regions()

Returns the regions Resource.

routers()

Returns the routers Resource.

routes()

Returns the routes Resource.

snapshots()

Returns the snapshots Resource.

sslCertificates()

Returns the sslCertificates Resource.

subnetworks()

Returns the subnetworks Resource.

targetHttpProxies()

Returns the targetHttpProxies Resource.

targetHttpsProxies()

Returns the targetHttpsProxies Resource.

targetInstances()

Returns the targetInstances Resource.

targetPools()

Returns the targetPools Resource.

targetSslProxies()

Returns the targetSslProxies Resource.

targetVpnGateways()

Returns the targetVpnGateways Resource.

urlMaps()

Returns the urlMaps Resource.

vpnTunnels()

Returns the vpnTunnels Resource.

zoneOperations()

Returns the zoneOperations Resource.

zones()

Returns the zones Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/compute_beta.httpHealthChecks.html000066400000000000000000001151161300622755700266600ustar00rootroot00000000000000

Compute Engine API . httpHealthChecks

Instance Methods

delete(project, httpHealthCheck)

Deletes the specified HttpHealthCheck resource.

get(project, httpHealthCheck)

Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

insert(project, body)

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HttpHealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, httpHealthCheck, body)

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, httpHealthCheck, body)

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, httpHealthCheck) 
Deletes the specified HttpHealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, httpHealthCheck) 
Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
      "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
      "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HttpHealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HttpHealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HttpHealthCheck resources.
      { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
          "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
          "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#httpHealthCheckList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
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, Project ID for 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 instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, httpHealthCheck, body) 
Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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 instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.httpsHealthChecks.html000066400000000000000000001145171300622755700270470ustar00rootroot00000000000000

Compute Engine API . httpsHealthChecks

Instance Methods

delete(project, httpsHealthCheck)

Deletes the specified HttpsHealthCheck resource.

get(project, httpsHealthCheck)

Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

insert(project, body)

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HttpsHealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, httpsHealthCheck, body)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, httpsHealthCheck, body)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, httpsHealthCheck) 
Deletes the specified HttpsHealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, httpsHealthCheck) 
Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
      "kind": "compute#httpsHealthCheck", # Type of the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
      "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 HTTPS health check request. The default value is 443.
      "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HttpsHealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HttpsHealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HttpsHealthCheck resources.
      { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
          "kind": "compute#httpsHealthCheck", # Type of the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
          "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 HTTPS health check request. The default value is 443.
          "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#httpsHealthCheckList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, httpsHealthCheck, body) 
Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, httpsHealthCheck, body) 
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.images.html000066400000000000000000002004271300622755700246770ustar00rootroot00000000000000

Compute Engine API . images

Instance Methods

delete(project, image)

Deletes the specified image.

deprecate(project, image, body)

Sets the deprecation status of an image.

get(project, image)

Returns the specified image. Get a list of available images by making a list() request.

getFromFamily(project, family)

Returns the latest image that is part of an image family and is not deprecated.

insert(project, body)

Creates an image in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setLabels(project, resource, body)

Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, image) 
Deletes the specified image.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deprecate(project, image, body) 
Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Args:
  project: string, Project ID for 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, image) 
Returns the specified image. Get a list of available images by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  image: string, Name of the image resource to return. (required)

Returns:
  An object of the form:

    { # An Image resource.
      "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
          # - projects/project/zones/zone/disks/disk
          # - zones/zone/disks/disk
      "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
      "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
      "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
      },
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve an image.
      "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
      "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
      "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
        { # Guest OS features.
          "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
        },
      ],
      "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
      "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
          #
          # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "rawDisk": { # The parameters of the raw disk image.
        "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
        "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
      },
      "licenses": [ # Any applicable license URI.
        "A String",
      ],
      "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getFromFamily(project, family) 
Returns the latest image that is part of an image family and is not deprecated.

Args:
  project: string, Project ID for this request. (required)
  family: string, Name of the image family to search for. (required)

Returns:
  An object of the form:

    { # An Image resource.
      "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
          # - projects/project/zones/zone/disks/disk
          # - zones/zone/disks/disk
      "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
      "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
      "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
      },
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve an image.
      "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
      "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
      "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
        { # Guest OS features.
          "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
        },
      ],
      "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
      "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
          #
          # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "rawDisk": { # The parameters of the raw disk image.
        "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
        "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
      },
      "licenses": [ # Any applicable license URI.
        "A String",
      ],
      "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an image in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Image resource.
    "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
        # - projects/project/zones/zone/disks/disk
        # - zones/zone/disks/disk
    "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
    "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
    "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
        # 
        # To see the latest fingerprint, make a get() request to retrieve an image.
    "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
    "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
    "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
      { # Guest OS features.
        "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
      },
    ],
    "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
    "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
        # 
        # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "rawDisk": { # The parameters of the raw disk image.
      "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
      "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
    },
    "licenses": [ # Any applicable license URI.
      "A String",
    ],
    "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of images.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Image resources.
      { # An Image resource.
          "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
              # - projects/project/zones/zone/disks/disk
              # - zones/zone/disks/disk
          "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
          "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
          "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
          "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
          },
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve an image.
          "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
          "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
          "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
            { # Guest OS features.
              "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
            },
          ],
          "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
          "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
              #
              # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "rawDisk": { # The parameters of the raw disk image.
            "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
            "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
          },
          "licenses": [ # Any applicable license URI.
            "A String",
          ],
          "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#imageList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setLabels(project, resource, body) 
Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.instanceGroupManagers.html000066400000000000000000003155501300622755700277350ustar00rootroot00000000000000

Compute Engine API . instanceGroupManagers

Instance Methods

abandonInstances(project, zone, instanceGroupManager, body)

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of managed instance groups and groups them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroupManager)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

deleteInstances(project, zone, instanceGroupManager, body)

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

get(project, zone, instanceGroupManager)

Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

insert(project, zone, body)

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

listManagedInstances(project, zone, instanceGroupManager)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

list_next(previous_request, previous_response)

Retrieves the next page of results.

recreateInstances(project, zone, instanceGroupManager, body)

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

resize(project, zone, instanceGroupManager, size)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

resizeAdvanced(project, zone, instanceGroupManager, body)

Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.

setAutoHealingPolicies(project, zone, instanceGroupManager, body)

Modifies the autohealing policies.

setInstanceTemplate(project, zone, instanceGroupManager, body)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

setTargetPools(project, zone, instanceGroupManager, body)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

abandonInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to abandon from the managed instance group.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of managed instance groups and groups them by zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of filtered managed instance group lists.
      "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
        "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
          { # An Instance Group Manager resource.
              "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
                "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
                "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
                "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                    #
                    # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
                "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
                "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
                "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
                "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
                "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
              },
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
              "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
                {
                  "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
                  "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
                },
              ],
              "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
              "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
              "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
              "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
              "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
                "A String",
              ],
              "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
              "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
              "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
              "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
              "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
                { # The named port. For example: .
                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
                  "port": 42, # The port number, which can be a value between 1 and 65535.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
              "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
              "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
              "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
      },
    },
    "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
    "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
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, zone, instanceGroupManager) 
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read  Deleting an instance group for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instanceGroupManager) 
Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
        "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
            #
            # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
        "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
        "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
        "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
      "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
        {
          "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
          "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        },
      ],
      "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
      "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
      "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
      "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
      "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
        "A String",
      ],
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
      "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
      "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
      "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
      "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
      "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
      "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, zone, body) 
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of managed instance groups that are contained within the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # [Output Only] A list of managed instance groups.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of managed instance groups.
      { # An Instance Group Manager resource.
          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
            "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                #
                # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
            "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
            "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
            "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
          "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
            {
              "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
              "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
            },
          ],
          "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
          "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
          "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
          "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
          "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
            "A String",
          ],
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
          "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
          "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
          "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
          "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
          "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
          "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
listManagedInstances(project, zone, instanceGroupManager) 
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    {
    "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
      {
        "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
            # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
            # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
            # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
            # - RECREATING The managed instance group is recreating this instance.
            # - DELETING The managed instance group is permanently deleting this instance.
            # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
            # - RESTARTING The managed instance group is restarting the instance.
            # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
        "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
        "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
          "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
        },
        "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
        "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
      },
    ],
  }
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.
recreateInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to recreate.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resize(project, zone, instanceGroupManager, size) 
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resizeAdvanced(project, zone, instanceGroupManager, body) 
Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.

If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.
        # 
        # This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.
        # 
        # This flag is applicable only to the current resize request. It does not influence other resize requests in any way.
        # 
        # You can see which instances is being creating in which mode by calling the get or listManagedInstances API.
    "targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setAutoHealingPolicies(project, zone, instanceGroupManager, body) 
Modifies the autohealing policies.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "autoHealingPolicies": [
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setInstanceTemplate(project, zone, instanceGroupManager, body) 
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTargetPools(project, zone, instanceGroupManager, body) 
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.instanceGroups.html000066400000000000000000001572431300622755700264450ustar00rootroot00000000000000

Compute Engine API . instanceGroups

Instance Methods

addInstances(project, zone, instanceGroup, body)

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance groups and sorts them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroup)

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

get(project, zone, instanceGroup)

Returns the specified instance group. Get a list of available instance groups by making a list() request.

insert(project, zone, body)

Creates an instance group in the specified project using the parameters that are included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance groups that are located in the specified project and zone.

listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)

Lists the instances in the specified instance group.

listInstances_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeInstances(project, zone, instanceGroup, body)

Removes one or more instances from the specified instance group, but does not delete those instances.

setNamedPorts(project, zone, instanceGroup, body)

Sets the named ports for the specified instance group.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addInstances(project, zone, instanceGroup, body) 
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read  Adding instances for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where you are adding instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to add to the instance group.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance groups and sorts them by zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped instance group lists.
      "a_key": { # The name of the scope that contains this set of instance groups.
        "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
          {
              "size": 42, # [Output Only] The total number of instances in the instance group.
              "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
              "region": "A String", # The URL of the region where the instance group is located (for regional resources).
              "network": "A String", # The URL of the network to which all instances in the instance group belong.
              "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
              "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
              "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
                  #
                  # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
                  #
                  # Named ports apply to all instances in this instance group.
                { # The named port. For example: .
                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
                  "port": 42, # The port number, which can be a value between 1 and 65535.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
              "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
              "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
              "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
      },
    },
    "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
    "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
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, zone, instanceGroup) 
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read  Deleting an instance group for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instanceGroup) 
Returns the specified instance group. Get a list of available instance groups by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group. (required)

Returns:
  An object of the form:

    {
      "size": 42, # [Output Only] The total number of instances in the instance group.
      "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
      "region": "A String", # The URL of the region where the instance group is located (for regional resources).
      "network": "A String", # The URL of the network to which all instances in the instance group belong.
      "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
      "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
      "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
          #
          # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
          #
          # Named ports apply to all instances in this instance group.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
      "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
      "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, zone, body) 
Creates an instance group in the specified project using the parameters that are included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "size": 42, # [Output Only] The total number of instances in the instance group.
    "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
    "region": "A String", # The URL of the region where the instance group is located (for regional resources).
    "network": "A String", # The URL of the network to which all instances in the instance group belong.
    "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
    "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
        # 
        # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
        # 
        # Named ports apply to all instances in this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
    "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
    "name": "A String", # The name of the instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance groups that are located in the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of InstanceGroup resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of instance groups.
      {
          "size": 42, # [Output Only] The total number of instances in the instance group.
          "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
          "region": "A String", # The URL of the region where the instance group is located (for regional resources).
          "network": "A String", # The URL of the network to which all instances in the instance group belong.
          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
          "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
              #
              # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
              #
              # Named ports apply to all instances in this instance group.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
          "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
    "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Lists the instances in the specified instance group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
  }

  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances.
      {
        "status": "A String", # [Output Only] The status of the instance.
        "instance": "A String", # [Output Only] The URL of the instance.
        "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
          { # The named port. For example: .
            "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
            "port": 42, # The port number, which can be a value between 1 and 65535.
          },
        ],
      },
    ],
    "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
    "id": "A String", # [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.
  }
listInstances_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.
removeInstances(project, zone, instanceGroup, body) 
Removes one or more instances from the specified instance group, but does not delete those instances.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to remove from the instance group.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setNamedPorts(project, zone, instanceGroup, body) 
Sets the named ports for the specified instance group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where the named ports are updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "namedPorts": [ # The list of named ports to set for this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.instanceTemplates.html000066400000000000000000002173161300622755700271220ustar00rootroot00000000000000

Compute Engine API . instanceTemplates

Instance Methods

delete(project, instanceTemplate)

Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

get(project, instanceTemplate)

Returns the specified instance template. Get a list of available instance templates by making a list() request.

insert(project, body)

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of instance templates that are contained within the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, instanceTemplate) 
Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

Args:
  project: string, Project ID for this request. (required)
  instanceTemplate: string, The name of the instance template to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, instanceTemplate) 
Returns the specified instance template. Get a list of available instance templates by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  instanceTemplate: string, The name of the instance template. (required)

Returns:
  An object of the form:

    { # An Instance Template resource.
      "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
      "properties": { # The instance properties for this instance template.
        "disks": [ # An array of disks that are associated with the instances that are created from this template.
          { # An instance-attached disk resource.
            "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                #
                # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                #
                # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                #
                # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                #
                # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                  #
                  # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                  #
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                  #
                  # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                  # - projects/project/zones/zone/diskTypes/diskType
                  # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
            },
            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
            "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
            "licenses": [ # [Output Only] Any valid publicly visible licenses.
              "A String",
            ],
            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
            "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
          },
        ],
        "machineType": "A String", # The machine type to use for instances that are created from this template.
        "description": "A String", # An optional text description for the instances that are created from this instance template.
        "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
              #
              # To see the latest fingerprint, make get() request to the instance.
        },
        "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
          "a_key": "A String",
        },
        "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
          "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
          "preemptible": True or False, # Whether the instance is preemptible.
          "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
        },
        "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
        "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
          { # 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": [ # An array of network access configurations for this interface.
          { # A network interface resource attached to an instance.
            "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                "name": "A String", # Name of this access configuration.
                "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
              },
            ],
            "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
            "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
            "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                # - regions/region/subnetworks/subnetwork
            "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                #
                # global/networks/default
                #
                # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                # - projects/project/global/networks/network
                # - global/networks/default
          },
        ],
        "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
      },
      "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Template resource.
    "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
    "properties": { # The instance properties for this instance template.
      "disks": [ # An array of disks that are associated with the instances that are created from this template.
        { # An instance-attached disk resource.
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
              #
              # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
              #
              # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
              #
              # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
              #
              # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
              #
              # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
          "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
          "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
              #
              # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              #
              # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
            "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
            "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                #
                # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                #
                # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                # - projects/project/zones/zone/diskTypes/diskType
                # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
            "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
            "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                #
                # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                #
                # projects/debian-cloud/global/images/family/debian-8
                #
                # Alternatively, use a specific version of a public operating system image:
                #
                # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                #
                # To create a disk with a private image that you created, specify the image name in the following format:
                #
                # global/images/my-private-image
                #
                # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                #
                # global/images/family/my-private-family
            "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
          },
          "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
          "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
          "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
          "licenses": [ # [Output Only] Any valid publicly visible licenses.
            "A String",
          ],
          "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
          "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
          "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
          "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
        },
      ],
      "machineType": "A String", # The machine type to use for instances that are created from this template.
      "description": "A String", # An optional text description for the instances that are created from this instance template.
      "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            #
            # To see the latest fingerprint, make get() request to the instance.
      },
      "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
        "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
        "preemptible": True or False, # Whether the instance is preemptible.
        "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
      },
      "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
      "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
        { # 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": [ # An array of network access configurations for this interface.
        { # A network interface resource attached to an instance.
          "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
              "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
              "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
              "name": "A String", # Name of this access configuration.
              "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
            },
          ],
          "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
          "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
          "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
              # - regions/region/subnetworks/subnetwork
          "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
              #
              # global/networks/default
              #
              # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
              # - projects/project/global/networks/network
              # - global/networks/default
        },
      ],
      "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
        "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      },
    },
    "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of instance templates that are contained within the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of instance templates.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] list of InstanceTemplate resources.
      { # An Instance Template resource.
          "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
          "properties": { # The instance properties for this instance template.
            "disks": [ # An array of disks that are associated with the instances that are created from this template.
              { # An instance-attached disk resource.
                "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                    #
                    # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                    #
                    # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                    #
                    # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                    #
                    # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
                  "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                  "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                      #
                      # The key must meet the following requirements before you can provide it to Compute Engine:
                      # - The key is wrapped using a RSA public key certificate provided by Google.
                      # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                },
                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                    #
                    # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                  "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                      #
                      # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                        #
                        # The key must meet the following requirements before you can provide it to Compute Engine:
                        # - The key is wrapped using a RSA public key certificate provided by Google.
                        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                  },
                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                      #
                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                      #
                      # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                      # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                      # - projects/project/zones/zone/diskTypes/diskType
                      # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
                  "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                      #
                      # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                      #
                      # projects/debian-cloud/global/images/family/debian-8
                      #
                      # Alternatively, use a specific version of a public operating system image:
                      #
                      # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                      #
                      # To create a disk with a private image that you created, specify the image name in the following format:
                      #
                      # global/images/my-private-image
                      #
                      # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                      #
                      # global/images/family/my-private-family
                  "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
                },
                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
                "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
                "licenses": [ # [Output Only] Any valid publicly visible licenses.
                  "A String",
                ],
                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
                "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
              },
            ],
            "machineType": "A String", # The machine type to use for instances that are created from this template.
            "description": "A String", # An optional text description for the instances that are created from this instance template.
            "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                  #
                  # To see the latest fingerprint, make get() request to the instance.
            },
            "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
              "a_key": "A String",
            },
            "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
              "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
              "preemptible": True or False, # Whether the instance is preemptible.
              "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
            },
            "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
            "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
              { # 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": [ # An array of network access configurations for this interface.
              { # A network interface resource attached to an instance.
                "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                    "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                    "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                    "name": "A String", # Name of this access configuration.
                    "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                  },
                ],
                "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
                "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
                "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                    # - regions/region/subnetworks/subnetwork
                "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                    #
                    # global/networks/default
                    #
                    # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                    # - projects/project/global/networks/network
                    # - global/networks/default
              },
            ],
            "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
              "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            },
          },
          "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.
    "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
    "selfLink": "A String", # [Output Only] The URL for this instance template list. The server defines this URL.
  }
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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.instances.html000066400000000000000000005742231300622755700254310ustar00rootroot00000000000000

Compute Engine API . instances

Instance Methods

addAccessConfig(project, zone, instance, networkInterface, body)

Adds an access config to an instance's network interface.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves aggregated list of instances.

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. For more information, see Stopping or Deleting an Instance.

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. Get a list of available instances by making a list() request.

getSerialPortOutput(project, zone, instance, start=None, port=None)

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, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instances 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.

setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)

Sets the auto-delete flag for a disk attached to an instance.

setLabels(project, zone, instance, body)

Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.

setMachineType(project, zone, instance, body)

Changes the machine type for a stopped instance to the machine type specified in the request.

setMetadata(project, zone, instance, body)

Sets metadata for the specified instance to the data included in the request.

setScheduling(project, zone, instance, body)

Sets an instance's scheduling options.

setTags(project, zone, instance, body)

Sets tags for the specified instance to the data included in the request.

start(project, zone, instance)

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

startWithEncryptionKey(project, zone, instance, body)

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

stop(project, zone, instance)

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addAccessConfig(project, zone, instance, networkInterface, body) 
Adds an access config to an instance's network interface.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  networkInterface: string, The name of the network interface to add to this instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
  "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
  "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
  "name": "A String", # Name of this access configuration.
  "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves aggregated list of instances.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped instance lists.
      "a_key": { # [Output Only] Name of the scope containing this set of instances.
        "instances": [ # [Output Only] List of instances contained in this scope.
          { # An Instance resource.
            "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
            "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
            "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
            "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
              "a_key": "A String",
            },
            "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "zone": "A String", # [Output Only] URL of the zone where the instance resides.
            "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                  #
                  # To see the latest fingerprint, make get() request to the instance.
            },
            "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                #
                # To see the latest fingerprint, make get() request to the instance.
            "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
              { # An instance-attached disk resource.
                "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                    #
                    # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                    #
                    # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                    #
                    # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                    #
                    # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
                  "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                  "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                      #
                      # The key must meet the following requirements before you can provide it to Compute Engine:
                      # - The key is wrapped using a RSA public key certificate provided by Google.
                      # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                },
                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                    #
                    # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                  "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                      #
                      # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                        #
                        # The key must meet the following requirements before you can provide it to Compute Engine:
                        # - The key is wrapped using a RSA public key certificate provided by Google.
                        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
                  },
                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                      #
                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                      #
                      # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                      # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                      # - projects/project/zones/zone/diskTypes/diskType
                      # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
                  "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                      #
                      # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                      #
                      # projects/debian-cloud/global/images/family/debian-8
                      #
                      # Alternatively, use a specific version of a public operating system image:
                      #
                      # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                      #
                      # To create a disk with a private image that you created, specify the image name in the following format:
                      #
                      # global/images/my-private-image
                      #
                      # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                      #
                      # global/images/family/my-private-family
                  "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
                },
                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
                "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
                "licenses": [ # [Output Only] Any valid publicly visible licenses.
                  "A String",
                ],
                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
                "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
              },
            ],
            "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
            "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
              "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
              "preemptible": True or False, # Whether the instance is preemptible.
              "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
            },
            "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
                #
                # zones/us-central1-f/machineTypes/n1-standard-1
                #
                # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
                #
                # zones/zone/machineTypes/custom-CPUS-MEMORY
                #
                # For example: zones/us-central1-f/machineTypes/custom-4-5120
                #
                # For a full list of restrictions, read the Specifications for custom machine types.
            "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
              { # 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": [ # An 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. Only one interface is supported per instance.
              { # A network interface resource attached to an instance.
                "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                    "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                    "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                    "name": "A String", # Name of this access configuration.
                    "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                  },
                ],
                "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
                "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
                "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                    # - regions/region/subnetworks/subnetwork
                "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                    #
                    # global/networks/default
                    #
                    # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                    # - projects/project/global/networks/network
                    # - global/networks/default
              },
            ],
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
            "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
              "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
              "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            },
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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 ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An instance-attached disk resource.
  "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
      # 
      # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
      # 
      # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
      # 
      # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      # 
      # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
        #
        # The key must meet the following requirements before you can provide it to Compute Engine:
        # - The key is wrapped using a RSA public key certificate provided by Google.
        # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  },
  "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
      # 
      # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
  "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
  "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
      # 
      # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
      #
      # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        #
        # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
          #
          # The key must meet the following requirements before you can provide it to Compute Engine:
          # - The key is wrapped using a RSA public key certificate provided by Google.
          # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    },
    "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
    "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
        #
        # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
        #
        # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
        # - projects/project/zones/zone/diskTypes/diskType
        # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
    "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        #
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        #
        # projects/debian-cloud/global/images/family/debian-8
        #
        # Alternatively, use a specific version of a public operating system image:
        #
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        #
        # To create a disk with a private image that you created, specify the image name in the following format:
        #
        # global/images/my-private-image
        #
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        #
        # global/images/family/my-private-family
    "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
  },
  "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
  "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
  "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
  "licenses": [ # [Output Only] Any valid publicly visible licenses.
    "A String",
  ],
  "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
  "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
  "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
  "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, zone, instance) 
Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteAccessConfig(project, zone, instance, accessConfig, networkInterface) 
Deletes an access config from an instance's network interface.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  accessConfig: string, The name of the access config to delete. (required)
  networkInterface: string, The name of the network interface. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
detachDisk(project, zone, instance, deviceName) 
Detaches a disk from an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instance) 
Returns the specified Instance resource. Get a list of available instances by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to return. (required)

Returns:
  An object of the form:

    { # An Instance resource.
    "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
    "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
    "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
    "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
      "a_key": "A String",
    },
    "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance resides.
    "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
          #
          # To see the latest fingerprint, make get() request to the instance.
    },
    "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        #
        # To see the latest fingerprint, make get() request to the instance.
    "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
      { # An instance-attached disk resource.
        "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
            #
            # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
            #
            # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
            #
            # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
            #
            # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
        "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
        "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
            #
            # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
            #
            # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
              #
              # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
          "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
              #
              # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
              #
              # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
              # - projects/project/zones/zone/diskTypes/diskType
              # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
          "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
          "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
        },
        "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
        "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
        "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
        "licenses": [ # [Output Only] Any valid publicly visible licenses.
          "A String",
        ],
        "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
        "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
        "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
        "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
      },
    ],
    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
    "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
      "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
      "preemptible": True or False, # Whether the instance is preemptible.
      "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
    },
    "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
        #
        # zones/us-central1-f/machineTypes/n1-standard-1
        #
        # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
        #
        # zones/zone/machineTypes/custom-CPUS-MEMORY
        #
        # For example: zones/us-central1-f/machineTypes/custom-4-5120
        #
        # For a full list of restrictions, read the Specifications for custom machine types.
    "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
      { # 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": [ # An 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. Only one interface is supported per instance.
      { # A network interface resource attached to an instance.
        "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
            "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
            "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
            "name": "A String", # Name of this access configuration.
            "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
          },
        ],
        "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
        "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
        "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
            # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
            # - regions/region/subnetworks/subnetwork
        "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
            #
            # global/networks/default
            #
            # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
            # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
            # - projects/project/global/networks/network
            # - global/networks/default
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
    "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
      "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
  }
getSerialPortOutput(project, zone, instance, start=None, port=None) 
Returns the specified instance's serial port output.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance scoping this request. (required)
  start: string, For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.
  port: integer, Specifies which COM or serial port to retrieve data from.

Returns:
  An object of the form:

    { # An instance's serial console output.
    "start": "A String", # [Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
    "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
    "contents": "A String", # [Output Only] The contents of the console output.
    "next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.
  }
insert(project, zone, body) 
Creates an instance resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance resource.
  "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
  "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
  "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
  "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    "a_key": "A String",
  },
  "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  "zone": "A String", # [Output Only] URL of the zone where the instance resides.
  "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        #
        # To see the latest fingerprint, make get() request to the instance.
  },
  "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      # 
      # To see the latest fingerprint, make get() request to the instance.
  "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
    { # An instance-attached disk resource.
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
          #
          # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
          #
          # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
          #
          # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
          #
          # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
          #
          # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
      "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
      "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
          #
          # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
          #
          # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
        "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
        "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
            #
            # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
            #
            # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
            # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
            # - projects/project/zones/zone/diskTypes/diskType
            # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
        "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
        "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
            #
            # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
            #
            # projects/debian-cloud/global/images/family/debian-8
            #
            # Alternatively, use a specific version of a public operating system image:
            #
            # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
            #
            # To create a disk with a private image that you created, specify the image name in the following format:
            #
            # global/images/my-private-image
            #
            # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
            #
            # global/images/family/my-private-family
        "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
      },
      "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
      "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
      "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
      "licenses": [ # [Output Only] Any valid publicly visible licenses.
        "A String",
      ],
      "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
      "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
      "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
      "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
    },
  ],
  "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
  "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
    "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
    "preemptible": True or False, # Whether the instance is preemptible.
    "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
  },
  "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
      # 
      # zones/us-central1-f/machineTypes/n1-standard-1
      # 
      # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
      # 
      # zones/zone/machineTypes/custom-CPUS-MEMORY
      # 
      # For example: zones/us-central1-f/machineTypes/custom-4-5120
      # 
      # For a full list of restrictions, read the Specifications for custom machine types.
  "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
    { # 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": [ # An 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. Only one interface is supported per instance.
    { # A network interface resource attached to an instance.
      "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
          "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
          "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
          "name": "A String", # Name of this access configuration.
          "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
        },
      ],
      "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
      "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
      "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
          # - regions/region/subnetworks/subnetwork
      "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
          #
          # global/networks/default
          #
          # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
          # - projects/project/global/networks/network
          # - global/networks/default
    },
  ],
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
    "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
    "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
  },
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instances contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of instances.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of instances.
      { # An Instance resource.
        "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
        "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
        "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
        "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
          "a_key": "A String",
        },
        "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "zone": "A String", # [Output Only] URL of the zone where the instance resides.
        "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
              #
              # To see the latest fingerprint, make get() request to the instance.
        },
        "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            #
            # To see the latest fingerprint, make get() request to the instance.
        "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
          { # An instance-attached disk resource.
            "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                #
                # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                #
                # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                #
                # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                  #
                  # The key must meet the following requirements before you can provide it to Compute Engine:
                  # - The key is wrapped using a RSA public key certificate provided by Google.
                  # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
            },
            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                #
                # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                  #
                  # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                    #
                    # The key must meet the following requirements before you can provide it to Compute Engine:
                    # - The key is wrapped using a RSA public key certificate provided by Google.
                    # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
              },
              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                  #
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                  #
                  # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                  # - projects/project/zones/zone/diskTypes/diskType
                  # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
            },
            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
            "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
            "licenses": [ # [Output Only] Any valid publicly visible licenses.
              "A String",
            ],
            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
            "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
          },
        ],
        "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
        "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
          "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
          "preemptible": True or False, # Whether the instance is preemptible.
          "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
        },
        "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
            #
            # zones/us-central1-f/machineTypes/n1-standard-1
            #
            # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
            #
            # zones/zone/machineTypes/custom-CPUS-MEMORY
            #
            # For example: zones/us-central1-f/machineTypes/custom-4-5120
            #
            # For a full list of restrictions, read the Specifications for custom machine types.
        "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
          { # 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": [ # An 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. Only one interface is supported per instance.
          { # A network interface resource attached to an instance.
            "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                "name": "A String", # Name of this access configuration.
                "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
              },
            ],
            "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
            "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
            "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                # - regions/region/subnetworks/subnetwork
            "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                #
                # global/networks/default
                #
                # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                # - projects/project/global/networks/network
                # - global/networks/default
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
        "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
          "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
      },
    ],
    "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
reset(project, zone, instance) 
Performs a hard reset on the instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setDiskAutoDelete(project, zone, instance, autoDelete, deviceName) 
Sets the auto-delete flag for a disk attached to an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name. (required)
  autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
  deviceName: string, The device name of the disk to modify. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setLabels(project, zone, instance, body) 
Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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:

{
    "labelFingerprint": "A String", # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.
    "labels": { # A list of labels to apply for this instance. Changing instance labels will also change the instance tags.
        # 
        # Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setMachineType(project, zone, instance, body) 
Changes the machine type for a stopped instance to the machine type specified in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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:

{
    "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setMetadata(project, zone, instance, body) 
Sets metadata for the specified instance to the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
  "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setScheduling(project, zone, instance, body) 
Sets an instance's scheduling options.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Instance name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Sets the scheduling options for an Instance.
  "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
  "preemptible": True or False, # Whether the instance is preemptible.
  "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTags(project, zone, instance, body) 
Sets tags for the specified instance to the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      # 
      # To see the latest fingerprint, make get() request to the instance.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
start(project, zone, instance) 
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
startWithEncryptionKey(project, zone, instance, body) 
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
        # 
        # In order to start the instance, the disk url and its corresponding key must be provided.
        # 
        # If the disk is not protected with a customer-supplied encryption key it should not be specified.
      {
        "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
              #
              # The key must meet the following requirements before you can provide it to Compute Engine:
              # - The key is wrapped using a RSA public key certificate provided by Google.
              # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
              # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        },
        "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
stop(project, zone, instance) 
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to stop. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.licenses.html000066400000000000000000000042351300622755700252360ustar00rootroot00000000000000

Compute Engine API . licenses

Instance Methods

get(project, license)

Returns the specified License resource. Get a list of available licenses by making a list() request.

Method Details

get(project, license) 
Returns the specified License resource. Get a list of available licenses by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  license: string, Name of the License resource to return. (required)

Returns:
  An object of the form:

    { # A license resource.
    "chargesUseFee": True or False, # [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.
    "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.
    "name": "A String", # [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.machineTypes.html000066400000000000000000000463241300622755700260670ustar00rootroot00000000000000

Compute Engine API . machineTypes

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of machine types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, machineType)

Returns the specified machine type. Get a list of available machine types by making a list() request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of machine types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of machine types.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped machine type lists.
      "a_key": { # [Output Only] Name of the scope containing this set of machine types.
        "machineTypes": [ # [Output Only] List of machine types contained in this scope.
          { # A Machine Type resource.
            "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
            "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
            "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
            "description": "A String", # [Output Only] An optional textual description of the resource.
            "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
            "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
            "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
            "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
        "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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. Get a list of available machine types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  machineType: string, Name of the machine type to return. (required)

Returns:
  An object of the form:

    { # A Machine Type resource.
    "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
    "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
    "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
    "description": "A String", # [Output Only] An optional textual description of the resource.
    "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
    "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
    "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of machine types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of machine types.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Machine Type resources.
      { # A Machine Type resource.
        "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
        "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
        "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
        "description": "A String", # [Output Only] An optional textual description of the resource.
        "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
        "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
        "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.networks.html000066400000000000000000000703161300622755700253100ustar00rootroot00000000000000

Compute Engine API . networks

Instance Methods

delete(project, network)

Deletes the specified network.

get(project, network)

Returns the specified network. Get a list of available networks by making a list() request.

insert(project, body)

Creates a network in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of networks available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

switchToCustomMode(project, network)

Switches the network mode from auto subnet mode to custom subnet mode.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, network) 
Deletes the specified network.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, network) 
Returns the specified network. Get a list of available networks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to return. (required)

Returns:
  An object of the form:

    { # Represents a Network resource. Read Networks and Firewalls for more information.
      "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
        "A String",
      ],
      "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
          #
          # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
      "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a network in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Network resource. Read Networks and Firewalls for more information.
    "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
      "A String",
    ],
    "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
        # 
        # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
    "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of networks available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of networks.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Network resources.
      { # Represents a Network resource. Read Networks and Firewalls for more information.
          "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
            "A String",
          ],
          "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
              #
              # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
          "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
switchToCustomMode(project, network) 
Switches the network mode from auto subnet mode to custom subnet mode.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to be updated. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.projects.html000066400000000000000000000735211300622755700252660ustar00rootroot00000000000000

Compute Engine API . projects

Instance Methods

get(project)

Returns the specified Project resource.

moveDisk(project, body)

Moves a persistent disk from one zone to another.

moveInstance(project, body)

Moves an instance and its attached persistent disks from one zone to another.

setCommonInstanceMetadata(project, body)

Sets metadata common to all instances within the specified project using the data included in the request.

setUsageExportBucket(project, body)

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Method Details

get(project) 
Returns the specified Project resource.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
    "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
    "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
    "enabledFeatures": [ # Restricted features enabled for use on this project.
      "A String",
    ],
    "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
    "quotas": [ # [Output Only] Quotas assigned to this project.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
    "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
        "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
        "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
      },
    "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "description": "A String", # An optional textual description of the resource.
  }
moveDisk(project, body) 
Moves a persistent disk from one zone to another.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
        # - projects/project/zones/zone/disks/disk
        # - zones/zone/disks/disk
    "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
        # - projects/project/zones/zone
        # - zones/zone
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
moveInstance(project, body) 
Moves an instance and its attached persistent disks from one zone to another.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
        # - zones/zone/instances/instance
    "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
        # - projects/project/zones/zone
        # - zones/zone
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setCommonInstanceMetadata(project, body) 
Sets metadata common to all instances within the specified project using the data included in the request.

Args:
  project: string, Project ID for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
  "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setUsageExportBucket(project, body) 
Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
    "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
    "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.regionAutoscalers.html000066400000000000000000001641131300622755700271240ustar00rootroot00000000000000

Compute Engine API . regionAutoscalers

Instance Methods

delete(project, region, autoscaler)

Deletes the specified autoscaler.

get(project, region, autoscaler)

Returns the specified autoscaler.

insert(project, region, body)

Creates an autoscaler in the specified project using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of autoscalers contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, autoscaler, body)

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, body, autoscaler=None)

Updates an autoscaler in the specified project using the data included in the request.

Method Details

delete(project, region, autoscaler) 
Deletes the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  autoscaler: string, Name of the autoscaler to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, autoscaler) 
Returns the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  autoscaler: string, Name of the autoscaler to return. (required)

Returns:
  An object of the form:

    { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
      "status": "A String", # [Output Only] The status of the autoscaler configuration.
      "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
      "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
      "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
          #
          # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
        "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
            #
            # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
        "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
          "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
        },
        "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
          { # Custom utilization metric policy.
            "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                #
                # For example, the following is a valid metric:
                # compute.googleapis.com/instance/network/received_bytes_count
                # The following is not a valid metric because it does not increase or decrease based on usage:
                # compute.googleapis.com/instance/cpu/reserved_cores
            "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
            "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
          },
        ],
        "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
          "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
              #
              # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
              #
              # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
        },
        "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
      },
      "target": "A String", # URL of the managed instance group that this autoscaler will scale.
      "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        {
          "message": "A String", # The status message.
          "type": "A String", # The type of error returned.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of autoscalers contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of autoscalers.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of autoscalers.
      { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
          "status": "A String", # [Output Only] The status of the autoscaler configuration.
          "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
          "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
          "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
              #
              # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
            "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
            "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                #
                # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
            "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
              "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
            },
            "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
              { # Custom utilization metric policy.
                "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                    #
                    # For example, the following is a valid metric:
                    # compute.googleapis.com/instance/network/received_bytes_count
                    # The following is not a valid metric because it does not increase or decrease based on usage:
                    # compute.googleapis.com/instance/cpu/reserved_cores
                "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
              },
            ],
            "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
              "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                  #
                  # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                  #
                  # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
            },
            "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
          },
          "target": "A String", # URL of the managed instance group that this autoscaler will scale.
          "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
            {
              "message": "A String", # The status message.
              "type": "A String", # The type of error returned.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#regionAutoscalerList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, autoscaler, body) 
Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  autoscaler: string, Name of the autoscaler to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, body, autoscaler=None) 
Updates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "status": "A String", # [Output Only] The status of the autoscaler configuration.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
      {
        "message": "A String", # The status message.
        "type": "A String", # The type of error returned.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  autoscaler: string, Name of the autoscaler to update.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.regionBackendServices.html000066400000000000000000002064011300622755700276670ustar00rootroot00000000000000

Compute Engine API . regionBackendServices

Instance Methods

delete(project, region, backendService)

Deletes the specified regional BackendService resource.

get(project, region, backendService)

Returns the specified regional BackendService resource.

getHealth(project, region, backendService, body)

Gets the most recent health check results for this regional BackendService.

insert(project, region, body)

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of regional BackendService resources available to the specified project in the given region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, backendService, body)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, backendService, body)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Method Details

delete(project, region, backendService) 
Deletes the specified regional BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, backendService) 
Returns the specified regional BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to return. (required)

Returns:
  An object of the form:

    { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
      "connectionDraining": { # Message containing connection draining configuration.
        "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
      },
      "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
      "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
          #
          # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
          #
          # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
      "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
      "loadBalancingScheme": "A String",
      "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
          #
          # This cannot be used for internal load balancing.
      "backends": [ # The list of backends that serve this BackendService.
        { # Message containing information of one individual backend.
          "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
              #
              # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
              #
              # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
              #
              # This cannot be used for internal load balancing.
        },
      ],
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
      "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
          #
          # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
        "A String",
      ],
      "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
          #
          # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
          #
          # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
          #
          # When the protocol is UDP, this field is not used.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getHealth(project, region, backendService, body) 
Gets the most recent health check results for this regional BackendService.

Args:
  project: string, A parameter (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
  }


Returns:
  An object of the form:

    {
    "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, region, body) 
Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for 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 BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "loadBalancingScheme": "A String",
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of regional BackendService resources available to the specified project in the given region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendService resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of BackendService resources.
      { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
          "connectionDraining": { # Message containing connection draining configuration.
            "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
          },
          "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
          "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
              #
              # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
              #
              # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
          "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
          "loadBalancingScheme": "A String",
          "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
              #
              # This cannot be used for internal load balancing.
          "backends": [ # The list of backends that serve this BackendService.
            { # Message containing information of one individual backend.
              "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                  #
                  # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                  #
                  # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                  #
                  # This cannot be used for internal load balancing.
            },
          ],
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
          "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
              #
              # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
            "A String",
          ],
          "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
              #
              # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
              #
              # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
              #
              # When the protocol is UDP, this field is not used.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, backendService, body) 
Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "loadBalancingScheme": "A String",
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, backendService, body) 
Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "loadBalancingScheme": "A String",
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.regionInstanceGroupManagers.html000066400000000000000000003203061300622755700310740ustar00rootroot00000000000000

Compute Engine API . regionInstanceGroupManagers

Instance Methods

abandonInstances(project, region, instanceGroupManager, body)

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

delete(project, region, instanceGroupManager)

Deletes the specified managed instance group and all of the instances in that group.

deleteInstances(project, region, instanceGroupManager, body)

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

get(project, region, instanceGroupManager)

Returns all of the details about the specified managed instance group.

insert(project, region, body)

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of managed instance groups that are contained within the specified region.

listManagedInstances(project, region, instanceGroupManager)

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, instanceGroupManager, body)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

recreateInstances(project, region, instanceGroupManager, body)

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

resize(project, region, instanceGroupManager, size)

Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

setAutoHealingPolicies(project, region, instanceGroupManager, body)

Modifies the autohealing policy for the instances in this managed instance group.

setInstanceTemplate(project, region, instanceGroupManager, body)

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

setTargetPools(project, region, instanceGroupManager, body)

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, instanceGroupManager, body)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Method Details

abandonInstances(project, region, instanceGroupManager, body) 
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to abandon.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, region, instanceGroupManager) 
Deletes the specified managed instance group and all of the instances in that group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteInstances(project, region, instanceGroupManager, body) 
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to delete.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, instanceGroupManager) 
Returns all of the details about the specified managed instance group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group to return. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
        "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
            #
            # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
        "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
        "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
        "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
      "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
        {
          "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
          "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
        },
      ],
      "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
      "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
      "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
      "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
      "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
        "A String",
      ],
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
      "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
      "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
      "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
      "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
      "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
      "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, region, body) 
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for 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:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of managed instance groups that are contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of managed instance groups.
    "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
    "items": [ # A list of managed instance groups.
      { # An Instance Group Manager resource.
          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
            "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                #
                # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
            "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
            "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
            "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
          "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
            {
              "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
              "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
            },
          ],
          "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
          "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
          "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
          "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
          "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
            "A String",
          ],
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
          "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
          "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
          "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
          "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
          "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
          "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL.
  }
listManagedInstances(project, region, instanceGroupManager) 
Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    {
    "managedInstances": [ # List of managed instances.
      {
        "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
            # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
            # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
            # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
            # - RECREATING The managed instance group is recreating this instance.
            # - DELETING The managed instance group is permanently deleting this instance.
            # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
            # - RESTARTING The managed instance group is restarting the instance.
            # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
        "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
        "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
          "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
        },
        "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
        "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
      },
    ],
  }
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, region, instanceGroupManager, body) 
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
recreateInstances(project, region, instanceGroupManager, body) 
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to recreate.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resize(project, region, instanceGroupManager, size) 
Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  size: integer, Number of instances that should exist in this instance group manager. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setAutoHealingPolicies(project, region, instanceGroupManager, body) 
Modifies the autohealing policy for the instances in this managed instance group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "autoHealingPolicies": [
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setInstanceTemplate(project, region, instanceGroupManager, body) 
Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTargetPools(project, region, instanceGroupManager, body) 
Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, Name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, instanceGroupManager, body) 
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
      },
    ],
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.regionInstanceGroups.html000066400000000000000000000564051300622755700276070ustar00rootroot00000000000000

Compute Engine API . regionInstanceGroups

Instance Methods

get(project, region, instanceGroup)

Returns the specified instance group resource.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance group resources contained within the specified region.

listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

listInstances_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setNamedPorts(project, region, instanceGroup, body)

Sets the named ports for the specified regional instance group.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

get(project, region, instanceGroup) 
Returns the specified instance group resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroup: string, Name of the instance group resource to return. (required)

Returns:
  An object of the form:

    {
      "size": 42, # [Output Only] The total number of instances in the instance group.
      "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
      "region": "A String", # The URL of the region where the instance group is located (for regional resources).
      "network": "A String", # The URL of the network to which all instances in the instance group belong.
      "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
      "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
      "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
          #
          # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
          #
          # Named ports apply to all instances in this instance group.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
      "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
      "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance group resources contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of InstanceGroup resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of InstanceGroup resources.
      {
          "size": 42, # [Output Only] The total number of instances in the instance group.
          "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
          "region": "A String", # The URL of the region where the instance group is located (for regional resources).
          "network": "A String", # The URL of the network to which all instances in the instance group belong.
          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
          "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
              #
              # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
              #
              # Named ports apply to all instances in this instance group.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
          "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#regionInstanceGroupList", # The resource type.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroup: string, Name of the regional instance group for which we want to list the instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "portName": "A String", # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
    "instanceState": "A String", # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
  }

  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of instances and any named ports that are assigned to those instances.
      {
        "status": "A String", # [Output Only] The status of the instance.
        "instance": "A String", # [Output Only] The URL of the instance.
        "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
          { # The named port. For example: .
            "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
            "port": 42, # The port number, which can be a value between 1 and 65535.
          },
        ],
      },
    ],
    "kind": "compute#regionInstanceGroupsListInstances", # The resource type.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }
listInstances_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.
setNamedPorts(project, region, instanceGroup, body) 
Sets the named ports for the specified regional instance group.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "namedPorts": [ # The list of named ports to set for this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.regionOperations.html000066400000000000000000000400261300622755700267560ustar00rootroot00000000000000

Compute Engine API . regionOperations

Instance Methods

delete(project, region, operation)

Deletes the specified region-specific Operations resource.

get(project, region, operation)

Retrieves the specified region-specific Operations resource.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, region, operation) 
Retrieves the specified region-specific Operations resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.regions.html000066400000000000000000000246761300622755700251120ustar00rootroot00000000000000

Compute Engine API . regions

Instance Methods

get(project, region)

Returns the specified Region resource. Get a list of available regions by making a list() request.

list(project, orderBy=None, 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. Get a list of available regions by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region resource to return. (required)

Returns:
  An object of the form:

    { # Region resource.
    "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
    "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
    "description": "A String", # [Output Only] Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "quotas": [ # [Output Only] Quotas assigned to this region.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of region resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of region resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Region resources.
      { # Region resource.
        "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
        "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "quotas": [ # [Output Only] Quotas assigned to this region.
          { # A quotas entry.
            "usage": 3.14, # [Output Only] Current usage of this metric.
            "metric": "A String", # [Output Only] Name of the quota metric.
            "limit": 3.14, # [Output Only] Quota limit for this metric.
          },
        ],
        "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
          "A String",
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.routers.html000066400000000000000000002175711300622755700251450ustar00rootroot00000000000000

Compute Engine API . routers

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of routers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, router)

Deletes the specified Router resource.

get(project, region, router)

Returns the specified Router resource. Get a list of available routers by making a list() request.

getRouterStatus(project, region, router)

Retrieves runtime information of the specified router.

insert(project, region, body)

Creates a Router resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of Router resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, router, body)

Updates the specified Router resource with the data included in the request. This method supports patch semantics.

preview(project, region, router, body)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, region, router, body)

Updates the specified Router resource with the data included in the request.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of routers.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of routers.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped router lists.
      "a_key": { # Name of the scope containing this set of routers.
        "routers": [ # List of routers contained in this scope.
          { # Router resource.
              "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
                {
                  "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
                  "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
                  "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
                },
              ],
              "bgp": { # BGP information specific to this router.
                "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
              },
              "network": "A String", # URI of the network to which this router belongs.
              "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
                {
                  "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
                  "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
                  "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
                  "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
                  "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
                  "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
                },
              ],
              "region": "A String", # [Output Only] URI of the region where the router resides.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of routers when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#routerAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, router) 
Deletes the specified Router resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, router) 
Returns the specified Router resource. Get a list of available routers by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to return. (required)

Returns:
  An object of the form:

    { # Router resource.
      "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
        {
          "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
          "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
          "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
        },
      ],
      "bgp": { # BGP information specific to this router.
        "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
      },
      "network": "A String", # URI of the network to which this router belongs.
      "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
        {
          "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
          "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
          "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
          "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
          "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
          "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
        },
      ],
      "region": "A String", # [Output Only] URI of the region where the router resides.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getRouterStatus(project, region, router) 
Retrieves runtime information of the specified router.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to query. (required)

Returns:
  An object of the form:

    {
    "kind": "compute#routerStatusResponse", # Type of resource.
    "result": {
      "bgpPeerStatus": [
        {
          "status": "A String", # Status of the BGP peer: {UP, DOWN}
          "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
          "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
          "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
          "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
          "peerIpAddress": "A String", # IP address of the remote BGP interface.
          "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
            { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
                #
                # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
                #
                # Packets that do not match any route in the sending instance's routing table are dropped.
              "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
              "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
              "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "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. You can specify this as a full or partial URL. For example:
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
              "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
              "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
              "network": "A String", # Fully-qualified URL of the network that this route applies to.
              "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
              "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
                {
                  "message": "A String", # [Output Only] A human-readable description of the warning code.
                  "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                  "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                      # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                    {
                      "value": "A String", # [Output Only] A warning data value corresponding to the key.
                      "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                    },
                  ],
                },
              ],
              "destRange": "A String", # The destination range of outgoing packets that this route applies to.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            },
          ],
          "state": "A String", # BGP state as specified in RFC1771.
          "ipAddress": "A String", # IP address of the local BGP interface.
          "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
        },
      ],
      "network": "A String", # URI of the network to which this router belongs.
      "bestRoutes": [ # Best routes for this router's network.
        { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
            #
            # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
            #
            # Packets that do not match any route in the sending instance's routing table are dropped.
          "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
          "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
          "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "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. You can specify this as a full or partial URL. For example:
              # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
          "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
          "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
          "network": "A String", # Fully-qualified URL of the network that this route applies to.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
          "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
            {
              "message": "A String", # [Output Only] A human-readable description of the warning code.
              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                  "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                },
              ],
            },
          ],
          "destRange": "A String", # The destination range of outgoing packets that this route applies to.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        },
      ],
    },
  }
insert(project, region, body) 
Creates a Router resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Router resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Router resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of Router resources.
      { # Router resource.
          "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
            {
              "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
              "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
              "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
            },
          ],
          "bgp": { # BGP information specific to this router.
            "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
          },
          "network": "A String", # URI of the network to which this router belongs.
          "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
            {
              "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
              "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
              "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
              "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
              "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
              "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
            },
          ],
          "region": "A String", # [Output Only] URI of the region where the router resides.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, router, body) 
Updates the specified Router resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
preview(project, region, router, body) 
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to query. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    {
    "resource": { # Router resource. # Preview of given router.
        "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
          {
            "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
            "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
            "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
          },
        ],
        "bgp": { # BGP information specific to this router.
          "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
        },
        "network": "A String", # URI of the network to which this router belongs.
        "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
          {
            "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
            "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
            "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
            "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
            "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
            "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
          },
        ],
        "region": "A String", # [Output Only] URI of the region where the router resides.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      },
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, region, router, body) 
Updates the specified Router resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.routes.html000066400000000000000000000753061300622755700247610ustar00rootroot00000000000000

Compute Engine API . routes

Instance Methods

delete(project, route)

Deletes the specified Route resource.

get(project, route)

Returns the specified Route resource. Get a list of available routes by making a list() request.

insert(project, body)

Creates a Route resource in the specified project using the data included in the request.

list(project, orderBy=None, 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.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, route) 
Deletes the specified Route resource.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, route) 
Returns the specified Route resource. Get a list of available routes by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  route: string, Name of the Route resource to return. (required)

Returns:
  An object of the form:

    { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
      #
      # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
      #
      # Packets that do not match any route in the sending instance's routing table are dropped.
    "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
    "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
    "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "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. You can specify this as a full or partial URL. For example:
        # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
    "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
    "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
    "network": "A String", # Fully-qualified URL of the network that this route applies to.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "destRange": "A String", # The destination range of outgoing packets that this route applies to.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  }
insert(project, body) 
Creates a Route resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
    # 
    # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
    # 
    # Packets that do not match any route in the sending instance's routing table are dropped.
  "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
  "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
  "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
  "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  "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. You can specify this as a full or partial URL. For example:
      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
  "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
  "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
  "network": "A String", # Fully-qualified URL of the network that this route applies to.
  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
  "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    {
      "message": "A String", # [Output Only] A human-readable description of the warning code.
      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
        {
          "value": "A String", # [Output Only] A warning data value corresponding to the key.
          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
        },
      ],
    },
  ],
  "destRange": "A String", # The destination range of outgoing packets that this route applies to.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Route resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Route resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Route resources.
      { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
          #
          # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
          #
          # Packets that do not match any route in the sending instance's routing table are dropped.
        "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
        "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
        "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
        "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "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. You can specify this as a full or partial URL. For example:
            # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
        "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
        "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
        "network": "A String", # Fully-qualified URL of the network that this route applies to.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "destRange": "A String", # The destination range of outgoing packets that this route applies to.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      },
    ],
    "kind": "compute#routeList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.snapshots.html000066400000000000000000000747661300622755700254730ustar00rootroot00000000000000

Compute Engine API . snapshots

Instance Methods

delete(project, snapshot)

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

get(project, snapshot)

Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of Snapshot resources contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setLabels(project, resource, body)

Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, snapshot) 
Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snaphots.

Args:
  project: string, Project ID for this request. (required)
  snapshot: string, Name of the Snapshot resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, snapshot) 
Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  snapshot: string, Name of the Snapshot resource to return. (required)

Returns:
  An object of the form:

    { # A persistent disk snapshot resource.
      "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
      "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
      "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
          #
          # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
            #
            # The key must meet the following requirements before you can provide it to Compute Engine:
            # - The key is wrapped using a RSA public key certificate provided by Google.
            # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      },
      "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
          #
          # To see the latest fingerprint, make a get() request to retrieve a snapshot.
      "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
      "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Snapshot resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Snapshot resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Snapshot resources.
      { # A persistent disk snapshot resource.
          "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
          "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
          "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
          "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
              #
              # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
                #
                # The key must meet the following requirements before you can provide it to Compute Engine:
                # - The key is wrapped using a RSA public key certificate provided by Google.
                # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding.  Get the RSA public key certificate provided by Google at:
                # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
          },
          "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
              #
              # To see the latest fingerprint, make a get() request to retrieve a snapshot.
          "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
            "a_key": "A String",
          },
          "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
          "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#snapshotList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setLabels(project, resource, body) 
Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
    "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
      "a_key": "A String",
    },
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.sslCertificates.html000066400000000000000000000533721300622755700265660ustar00rootroot00000000000000

Compute Engine API . sslCertificates

Instance Methods

delete(project, sslCertificate)

Deletes the specified SslCertificate resource.

get(project, sslCertificate)

Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

insert(project, body)

Creates a SslCertificate resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of SslCertificate resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, sslCertificate) 
Deletes the specified SslCertificate resource.

Args:
  project: string, Project ID for this request. (required)
  sslCertificate: string, Name of the SslCertificate resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, sslCertificate) 
Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  sslCertificate: string, Name of the SslCertificate resource to return. (required)

Returns:
  An object of the form:

    { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
      "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
      "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output only] Server-defined URL for the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    }
insert(project, body) 
Creates a SslCertificate resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
    "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
    "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output only] Server-defined URL for the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of SslCertificate resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of SslCertificate resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of SslCertificate resources.
      { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
          "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
          "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output only] Server-defined URL for the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        },
    ],
    "kind": "compute#sslCertificateList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.subnetworks.html000066400000000000000000001076021300622755700260210ustar00rootroot00000000000000

Compute Engine API . subnetworks

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of subnetworks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, subnetwork)

Deletes the specified subnetwork.

expandIpCidrRange(project, region, subnetwork, body)

Expands the IP CIDR range of the subnetwork to a specified value.

get(project, region, subnetwork)

Returns the specified subnetwork. Get a list of available subnetworks list() request.

insert(project, region, body)

Creates a subnetwork in the specified project using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of subnetworks available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of subnetworks.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output] A map of scoped Subnetwork lists.
      "a_key": { # Name of the scope containing this set of Subnetworks.
        "subnetworks": [ # List of subnetworks contained in this scope.
          { # A Subnetwork resource.
              "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "region": "A String", # URL of the region where the Subnetwork resides.
              "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
              "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
              "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # An informational warning that appears when the list of addresses is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, subnetwork) 
Deletes the specified subnetwork.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
expandIpCidrRange(project, region, subnetwork, body) 
Expands the IP CIDR range of the subnetwork to a specified value.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "ipCidrRange": "A String", # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, subnetwork) 
Returns the specified subnetwork. Get a list of available subnetworks list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to return. (required)

Returns:
  An object of the form:

    { # A Subnetwork resource.
      "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "region": "A String", # URL of the region where the Subnetwork resides.
      "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
      "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
      "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a subnetwork in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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 Subnetwork resource.
    "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "region": "A String", # URL of the region where the Subnetwork resides.
    "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
    "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
    "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of subnetworks available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Subnetwork resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # The Subnetwork resources.
      { # A Subnetwork resource.
          "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "region": "A String", # URL of the region where the Subnetwork resides.
          "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
          "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
          "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.targetHttpProxies.html000066400000000000000000000643031300622755700271330ustar00rootroot00000000000000

Compute Engine API . targetHttpProxies

Instance Methods

delete(project, targetHttpProxy)

Deletes the specified TargetHttpProxy resource.

get(project, targetHttpProxy)

Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

insert(project, body)

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetHttpProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setUrlMap(project, targetHttpProxy, body)

Changes the URL map for TargetHttpProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetHttpProxy) 
Deletes the specified TargetHttpProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetHttpProxy) 
Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
      "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetHttpProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
    "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetHttpProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of TargetHttpProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetHttpProxy resources.
      { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
          "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setUrlMap(project, targetHttpProxy, body) 
Changes the URL map for TargetHttpProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "urlMap": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.targetHttpsProxies.html000066400000000000000000001024471300622755700273200ustar00rootroot00000000000000

Compute Engine API . targetHttpsProxies

Instance Methods

delete(project, targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

get(project, targetHttpsProxy)

Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

insert(project, body)

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetHttpsProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setSslCertificates(project, targetHttpsProxy, body)

Replaces SslCertificates for TargetHttpsProxy.

setUrlMap(project, targetHttpsProxy, body)

Changes the URL map for TargetHttpsProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetHttpsProxy) 
Deletes the specified TargetHttpsProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetHttpsProxy) 
Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
      "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
        "A String",
      ],
      "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
          # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
          # - projects/project/global/urlMaps/url-map
          # - global/urlMaps/url-map
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
    "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
      "A String",
    ],
    "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
        # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
        # - projects/project/global/urlMaps/url-map
        # - global/urlMaps/url-map
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetHttpsProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetHttpsProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetHttpsProxy resources.
      { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
          "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
            "A String",
          ],
          "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
              # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
              # - projects/project/global/urlMaps/url-map
              # - global/urlMaps/url-map
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setSslCertificates(project, targetHttpsProxy, body) 
Replaces SslCertificates for TargetHttpsProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setUrlMap(project, targetHttpsProxy, body) 
Changes the URL map for TargetHttpsProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "urlMap": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.targetInstances.html000066400000000000000000000753431300622755700265770ustar00rootroot00000000000000

Compute Engine API . targetInstances

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target instances.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, targetInstance)

Deletes the specified TargetInstance resource.

get(project, zone, targetInstance)

Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

insert(project, zone, body)

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of TargetInstance resources available to the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, zone, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target instances.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped target instance lists.
      "a_key": { # Name of the scope containing this set of target instances.
        "targetInstances": [ # List of target instances contained in this scope.
          { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
              "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
              "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
              "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
                  # - projects/project/zones/zone/instances/instance
                  # - zones/zone/instances/instance
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#targetInstanceAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, zone, targetInstance) 
Deletes the specified TargetInstance resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  targetInstance: string, Name of the TargetInstance resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, targetInstance) 
Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  targetInstance: string, Name of the TargetInstance resource to return. (required)

Returns:
  An object of the form:

    { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
      "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
      "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
      "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
          # - projects/project/zones/zone/instances/instance
          # - zones/zone/instances/instance
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, zone, body) 
Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Args:
  project: string, Project ID for 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 TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
    "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
    "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
    "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
        # - zones/zone/instances/instance
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of TargetInstance resources available to the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetInstance resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetInstance resources.
      { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
          "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
          "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
          "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
              # - projects/project/zones/zone/instances/instance
              # - zones/zone/instances/instance
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetInstanceList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, zone, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.targetPools.html000066400000000000000000002114401300622755700257320ustar00rootroot00000000000000

Compute Engine API . targetPools

Instance Methods

addHealthCheck(project, region, targetPool, body)

Adds health check URLs to a target pool.

addInstance(project, region, targetPool, body)

Adds an instance to a target pool.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target pools.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetPool)

Deletes the specified target pool.

get(project, region, targetPool)

Returns the specified target pool. Get a list of available target pools by making a list() request.

getHealth(project, region, targetPool, body)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

insert(project, region, body)

Creates a target pool in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of target pools available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeHealthCheck(project, region, targetPool, body)

Removes health check URL from a target pool.

removeInstance(project, region, targetPool, body)

Removes instance URL from a target pool.

setBackup(project, region, targetPool, body, failoverRatio=None)

Changes a backup target pool's configurations.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

addHealthCheck(project, region, targetPool, body) 
Adds health check URLs to a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the target pool to add a health check to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
          # - projects/project-id/global/httpHealthChecks/health-check
          # - global/httpHealthChecks/health-check
        "healthCheck": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
addInstance(project, region, targetPool, body) 
Adds an instance to a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to add instances to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
        # - projects/project-id/zones/zone/instances/instance-name
        # - zones/zone/instances/instance-name
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target pools.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped target pool lists.
      "a_key": { # Name of the scope containing this set of target pools.
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "targetPools": [ # List of target pools contained in this scope.
          { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
              "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
                  #
                  # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
                  #
                  # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "region": "A String", # [Output Only] URL of the region where the target pool resides.
              "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
              "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
                  # NONE: Connections from the same client IP may go to any instance in the pool.
                  # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
                  # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
              "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
                "A String",
              ],
              "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
                  #
                  # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
                  #
                  # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
              "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, targetPool) 
Deletes the specified target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, targetPool) 
Returns the specified target pool. Get a list of available target pools by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to return. (required)

Returns:
  An object of the form:

    { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
      "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
          #
          # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
          #
          # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the target pool resides.
      "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
      "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
          # NONE: Connections from the same client IP may go to any instance in the pool.
          # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
          # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
      "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
        "A String",
      ],
      "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
          #
          # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
          #
          # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
      "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getHealth(project, region, targetPool, body) 
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "instance": "A String", # The URL for a specific instance.
}


Returns:
  An object of the form:

    {
    "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, region, body) 
Creates a target pool in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for 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 TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
    "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
        # 
        # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
        # 
        # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the target pool resides.
    "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
    "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
        # NONE: Connections from the same client IP may go to any instance in the pool.
        # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
        # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
    "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
      "A String",
    ],
    "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
        # 
        # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
        # 
        # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
    "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of target pools available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetPool resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetPool resources.
      { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
          "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
              #
              # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
              #
              # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the target pool resides.
          "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
          "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
              # NONE: Connections from the same client IP may go to any instance in the pool.
              # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
              # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
          "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
            "A String",
          ],
          "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
              #
              # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
              #
              # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
          "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
removeHealthCheck(project, region, targetPool, body) 
Removes health check URL from a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetPool: string, Name of the target pool to remove health checks from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
        # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
        # - projects/project/global/httpHealthChecks/health-check
        # - global/httpHealthChecks/health-check
      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
          # - projects/project-id/global/httpHealthChecks/health-check
          # - global/httpHealthChecks/health-check
        "healthCheck": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
removeInstance(project, region, targetPool, body) 
Removes instance URL from a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to remove instances from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # URLs of the instances to be removed from target pool.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setBackup(project, region, targetPool, body, failoverRatio=None) 
Changes a backup target pool's configurations.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }

  failoverRatio: number, New failoverRatio value for the target pool.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.targetSslProxies.html000066400000000000000000001141401300622755700267500ustar00rootroot00000000000000

Compute Engine API . targetSslProxies

Instance Methods

delete(project, targetSslProxy)

Deletes the specified TargetSslProxy resource.

get(project, targetSslProxy)

Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

insert(project, body)

Creates a TargetSslProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetSslProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setBackendService(project, targetSslProxy, body)

Changes the BackendService for TargetSslProxy.

setProxyHeader(project, targetSslProxy, body)

Changes the ProxyHeaderType for TargetSslProxy.

setSslCertificates(project, targetSslProxy, body)

Changes SslCertificates for TargetSslProxy.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

delete(project, targetSslProxy) 
Deletes the specified TargetSslProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetSslProxy) 
Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetSslProxy resource. This resource defines an SSL proxy.
      "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "service": "A String", # URL to the BackendService resource.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetSslProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetSslProxy resource. This resource defines an SSL proxy.
    "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "service": "A String", # URL to the BackendService resource.
    "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetSslProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetSslProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetSslProxy resources.
      { # A TargetSslProxy resource. This resource defines an SSL proxy.
          "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "service": "A String", # URL to the BackendService resource.
          "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetSslProxyList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setBackendService(project, targetSslProxy, body) 
Changes the BackendService for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setProxyHeader(project, targetSslProxy, body) 
Changes the ProxyHeaderType for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setSslCertificates(project, targetSslProxy, body) 
Changes SslCertificates for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.targetVpnGateways.html000066400000000000000000000753331300622755700271170ustar00rootroot00000000000000

Compute Engine API . targetVpnGateways

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target VPN gateways.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetVpnGateway)

Deletes the specified target VPN gateway.

get(project, region, targetVpnGateway)

Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

insert(project, region, body)

Creates a target VPN gateway in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of target VPN gateways available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target VPN gateways.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped target vpn gateway lists.
      "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
        "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
          { # Represents a Target VPN gateway resource.
              "status": "A String", # [Output Only] The status of the VPN gateway.
              "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
                "A String",
              ],
              "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
              "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
                "A String",
              ],
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, targetVpnGateway) 
Deletes the specified target VPN gateway.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetVpnGateway: string, Name of the target VPN gateway to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, targetVpnGateway) 
Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetVpnGateway: string, Name of the target VPN gateway to return. (required)

Returns:
  An object of the form:

    { # Represents a Target VPN gateway resource.
      "status": "A String", # [Output Only] The status of the VPN gateway.
      "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
        "A String",
      ],
      "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
      "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
        "A String",
      ],
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a target VPN gateway in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Target VPN gateway resource.
    "status": "A String", # [Output Only] The status of the VPN gateway.
    "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
      "A String",
    ],
    "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
    "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
      "A String",
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of target VPN gateways available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetVpnGateway resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of TargetVpnGateway resources.
      { # Represents a Target VPN gateway resource.
          "status": "A String", # [Output Only] The status of the VPN gateway.
          "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
            "A String",
          ],
          "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
          "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
            "A String",
          ],
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.urlMaps.html000066400000000000000000001716261300622755700250650ustar00rootroot00000000000000

Compute Engine API . urlMaps

Instance Methods

delete(project, urlMap)

Deletes the specified UrlMap resource.

get(project, urlMap)

Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

insert(project, body)

Creates a UrlMap resource in the specified project using the data included in the request.

invalidateCache(project, urlMap, body)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of UrlMap resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, urlMap, body)

Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, urlMap, body)

Updates the specified UrlMap resource with the data included in the request.

validate(project, urlMap, body)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Method Details

delete(project, urlMap) 
Deletes the specified UrlMap resource.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, urlMap) 
Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to return. (required)

Returns:
  An object of the form:

    { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
      "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
      "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
        { # Message for the expected URL mappings.
          "path": "A String", # Path portion of the URL.
          "host": "A String", # Host portion of the URL.
          "description": "A String", # Description of this test case.
          "service": "A String", # Expected BackendService resource the given URL should be mapped to.
        },
      ],
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
      "pathMatchers": [ # The list of named PathMatchers to use against the URL.
        { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
          "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
              # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
              # - compute/v1/projects/project/global/backendServices/backendService
              # - global/backendServices/backendService
          "pathRules": [ # The list of path rules.
            { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
              "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                "A String",
              ],
              "service": "A String", # The URL of the BackendService resource if this rule is matched.
            },
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "hostRules": [ # The list of HostRules to use against the URL.
        { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
          "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
            "A String",
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
        },
      ],
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a UrlMap resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
invalidateCache(project, urlMap, body) 
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap scoping this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "path": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of UrlMap resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of UrlMap resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of UrlMap resources.
      { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
          "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
          "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
            { # Message for the expected URL mappings.
              "path": "A String", # Path portion of the URL.
              "host": "A String", # Host portion of the URL.
              "description": "A String", # Description of this test case.
              "service": "A String", # Expected BackendService resource the given URL should be mapped to.
            },
          ],
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
          "pathMatchers": [ # The list of named PathMatchers to use against the URL.
            { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
              "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
                  # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
                  # - compute/v1/projects/project/global/backendServices/backendService
                  # - global/backendServices/backendService
              "pathRules": [ # The list of path rules.
                { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
                  "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                    "A String",
                  ],
                  "service": "A String", # The URL of the BackendService resource if this rule is matched.
                },
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "hostRules": [ # The list of HostRules to use against the URL.
            { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
              "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
                "A String",
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
            },
          ],
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#urlMapList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, urlMap, body) 
Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, urlMap, body) 
Updates the specified UrlMap resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
validate(project, urlMap, body) 
Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to be validated as. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
        "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
        "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
          { # Message for the expected URL mappings.
            "path": "A String", # Path portion of the URL.
            "host": "A String", # Host portion of the URL.
            "description": "A String", # Description of this test case.
            "service": "A String", # Expected BackendService resource the given URL should be mapped to.
          },
        ],
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
        "pathMatchers": [ # The list of named PathMatchers to use against the URL.
          { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
            "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
                # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
                # - compute/v1/projects/project/global/backendServices/backendService
                # - global/backendServices/backendService
            "pathRules": [ # The list of path rules.
              { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
                "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                  "A String",
                ],
                "service": "A String", # The URL of the BackendService resource if this rule is matched.
              },
            ],
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "hostRules": [ # The list of HostRules to use against the URL.
          { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
            "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
              "A String",
            ],
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
          },
        ],
        "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      },
  }


Returns:
  An object of the form:

    {
    "result": { # Message representing the validation result for a UrlMap.
      "testFailures": [
        {
          "path": "A String",
          "actualService": "A String",
          "host": "A String",
          "expectedService": "A String",
        },
      ],
      "loadErrors": [
        "A String",
      ],
      "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
      "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
    },
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.vpnTunnels.html000066400000000000000000001022021300622755700255760ustar00rootroot00000000000000

Compute Engine API . vpnTunnels

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of VPN tunnels.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, vpnTunnel)

Deletes the specified VpnTunnel resource.

get(project, region, vpnTunnel)

Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

insert(project, region, body)

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

testIamPermissions(project, region, resource, body)

Returns permissions that a caller has on the specified resource.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of VPN tunnels.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped vpn tunnel lists.
      "a_key": { # Name of the scope containing this set of vpn tunnels.
        "vpnTunnels": [ # List of vpn tunnels contained in this scope.
          {
              "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
              "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
              "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
              "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
                "A String",
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "peerIp": "A String", # IP address of the peer VPN gateway.
              "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
              "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
                "A String",
              ],
              "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
              "status": "A String", # [Output Only] The status of the VPN tunnel.
              "sharedSecretHash": "A String", # Hash of the shared secret.
              "router": "A String", # URL of router resource to be used for dynamic routing.
              "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, vpnTunnel) 
Deletes the specified VpnTunnel resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, vpnTunnel) 
Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  vpnTunnel: string, Name of the VpnTunnel resource to return. (required)

Returns:
  An object of the form:

    {
      "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
      "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
      "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
      "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
        "A String",
      ],
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "peerIp": "A String", # IP address of the peer VPN gateway.
      "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
      "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
        "A String",
      ],
      "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
      "status": "A String", # [Output Only] The status of the VPN tunnel.
      "sharedSecretHash": "A String", # Hash of the shared secret.
      "router": "A String", # URL of router resource to be used for dynamic routing.
      "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
    "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
    "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
      "A String",
    ],
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "peerIp": "A String", # IP address of the peer VPN gateway.
    "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
    "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
      "A String",
    ],
    "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    "status": "A String", # [Output Only] The status of the VPN tunnel.
    "sharedSecretHash": "A String", # Hash of the shared secret.
    "router": "A String", # URL of router resource to be used for dynamic routing.
    "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of VpnTunnel resources contained in the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of VpnTunnel resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of VpnTunnel resources.
      {
          "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
          "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
          "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
          "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
            "A String",
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "peerIp": "A String", # IP address of the peer VPN gateway.
          "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
          "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
            "A String",
          ],
          "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
          "status": "A String", # [Output Only] The status of the VPN tunnel.
          "sharedSecretHash": "A String", # Hash of the shared secret.
          "router": "A String", # URL of router resource to be used for dynamic routing.
          "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
testIamPermissions(project, region, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/compute_beta.zoneOperations.html000066400000000000000000000377511300622755700264610ustar00rootroot00000000000000

Compute Engine API . zoneOperations

Instance Methods

delete(project, zone, operation)

Deletes the specified zone-specific Operations resource.

get(project, zone, operation)

Retrieves the specified zone-specific Operations resource.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, zone, operation) 
Retrieves the specified zone-specific Operations resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_beta.zones.html000066400000000000000000000231371300622755700245710ustar00rootroot00000000000000

Compute Engine API . zones

Instance Methods

get(project, zone)

Returns the specified Zone resource. Get a list of available zones by making a list() request.

list(project, orderBy=None, 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. Get a list of available zones by making a list() request.

Args:
  project: string, Project ID for 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", # [Output Only] Status of the zone, either UP or DOWN.
    "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
    "description": "A String", # [Output Only] Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Zone resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of zone resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Zone resources.
      { # A Zone resource.
        "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
        "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#zoneList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.addresses.html000066400000000000000000000712471300622755700250300ustar00rootroot00000000000000

Compute Engine API . addresses

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of addresses.

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, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of addresses contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of addresses.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped address lists.
      "a_key": { # [Output Only] Name of the scope containing this set of addresses.
        "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "addresses": [ # [Output Only] List of addresses contained in this scope.
          { # A reserved address resource.
              "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
              "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
              "address": "A String", # The static external IP address represented by this resource.
              "users": [ # [Output Only] The URLs of the resources that are using this address.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, Project ID for this request. (required)
  region: string, Name of the region for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, address) 
Returns the specified address resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
      "address": "A String", # The static external IP address represented by this resource.
      "users": [ # [Output Only] The URLs of the resources that are using this address.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates an address resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A reserved address resource.
    "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
    "address": "A String", # The static external IP address represented by this resource.
    "users": [ # [Output Only] The URLs of the resources that are using this address.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of addresses contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of addresses.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of addresses.
      { # A reserved address resource.
          "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
          "address": "A String", # The static external IP address represented by this resource.
          "users": [ # [Output Only] The URLs of the resources that are using this address.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.autoscalers.html000066400000000000000000002054701300622755700253750ustar00rootroot00000000000000

Compute Engine API . autoscalers

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of autoscalers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, autoscaler)

Deletes the specified autoscaler.

get(project, zone, autoscaler)

Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

insert(project, zone, body)

Creates an autoscaler in the specified project using the data included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of autoscalers contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, zone, autoscaler, body)

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

update(project, zone, body, autoscaler=None)

Updates an autoscaler in the specified project using the data included in the request.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of autoscalers.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped autoscaler lists.
      "a_key": { # [Output Only] Name of the scope containing this set of autoscalers.
        "warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "autoscalers": [ # [Output Only] List of autoscalers contained in this scope.
          { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
              "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
              "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
              "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
                  #
                  # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
                "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
                "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                    #
                    # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
                "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
                  "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
                },
                "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
                  { # Custom utilization metric policy.
                    "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                        #
                        # For example, the following is a valid metric:
                        # compute.googleapis.com/instance/network/received_bytes_count
                        # The following is not a valid metric because it does not increase or decrease based on usage:
                        # compute.googleapis.com/instance/cpu/reserved_cores
                    "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                    "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
                  },
                ],
                "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
                  "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                      #
                      # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                      #
                      # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
                },
                "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
              },
              "target": "A String", # URL of the managed instance group that this autoscaler will scale.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, zone, autoscaler) 
Deletes the specified autoscaler.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, autoscaler) 
Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to return. (required)

Returns:
  An object of the form:

    { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
      "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
      "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
      "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
          #
          # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
        "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
            #
            # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
        "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
          "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
        },
        "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
          { # Custom utilization metric policy.
            "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                #
                # For example, the following is a valid metric:
                # compute.googleapis.com/instance/network/received_bytes_count
                # The following is not a valid metric because it does not increase or decrease based on usage:
                # compute.googleapis.com/instance/cpu/reserved_cores
            "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
            "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
          },
        ],
        "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
          "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
              #
              # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
              #
              # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
        },
        "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
      },
      "target": "A String", # URL of the managed instance group that this autoscaler will scale.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, zone, body) 
Creates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of autoscalers contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Autoscaler resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of Autoscaler resources.
      { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
          "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
          "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
          "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
              #
              # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
            "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
            "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
                #
                # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
            "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
              "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
            },
            "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
              { # Custom utilization metric policy.
                "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
                    #
                    # For example, the following is a valid metric:
                    # compute.googleapis.com/instance/network/received_bytes_count
                    # The following is not a valid metric because it does not increase or decrease based on usage:
                    # compute.googleapis.com/instance/cpu/reserved_cores
                "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
                "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
              },
            ],
            "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
              "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
                  #
                  # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
                  #
                  # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
            },
            "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
          },
          "target": "A String", # URL of the managed instance group that this autoscaler will scale.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, zone, autoscaler, body) 
Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  autoscaler: string, Name of the autoscaler to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, zone, body, autoscaler=None) 
Updates an autoscaler in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
    "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
    "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
    "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
        # 
        # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
      "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
      "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
          #
          # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
      "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
        "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
      },
      "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
        { # Custom utilization metric policy.
          "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
              #
              # For example, the following is a valid metric:
              # compute.googleapis.com/instance/network/received_bytes_count
              # The following is not a valid metric because it does not increase or decrease based on usage:
              # compute.googleapis.com/instance/cpu/reserved_cores
          "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
          "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
        },
      ],
      "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
        "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
            #
            # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
            #
            # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
      },
      "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
    },
    "target": "A String", # URL of the managed instance group that this autoscaler will scale.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  autoscaler: string, Name of the autoscaler to update.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.backendServices.html000066400000000000000000002025561300622755700261450ustar00rootroot00000000000000

Compute Engine API . backendServices

Instance Methods

delete(project, backendService)

Deletes the specified BackendService resource.

get(project, backendService)

Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

getHealth(project, backendService, body)

Gets the most recent health check results for this BackendService.

insert(project, body)

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of BackendService resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, backendService, body)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

update(project, backendService, body)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Method Details

delete(project, backendService) 
Deletes the specified BackendService resource.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, backendService) 
Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to return. (required)

Returns:
  An object of the form:

    { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
      "connectionDraining": { # Message containing connection draining configuration.
        "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
      },
      "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
      "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
          #
          # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
          #
          # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
      "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
      "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
          #
          # This cannot be used for internal load balancing.
      "backends": [ # The list of backends that serve this BackendService.
        { # Message containing information of one individual backend.
          "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
              #
              # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
              #
              # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
              #
              # This cannot be used for internal load balancing.
          "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
              #
              # This cannot be used for internal load balancing.
          "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
              #
              # This cannot be used for internal load balancing.
        },
      ],
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
      "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
          #
          # When the load balancing scheme is INTERNAL, this field is not used.
      "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
          #
          # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
        "A String",
      ],
      "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
          #
          # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
          #
          # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
          #
          # When the protocol is UDP, this field is not used.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getHealth(project, backendService, body) 
Gets the most recent health check results for this BackendService.

Args:
  project: string, A parameter (required)
  backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
  }


Returns:
  An object of the form:

    {
    "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, body) 
Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of BackendService resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of BackendService resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": [ # A list of BackendService resources.
      { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
          "connectionDraining": { # Message containing connection draining configuration.
            "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
          },
          "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
          "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
              #
              # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
              #
              # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
          "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
          "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
              #
              # This cannot be used for internal load balancing.
          "backends": [ # The list of backends that serve this BackendService.
            { # Message containing information of one individual backend.
              "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                  #
                  # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
                  #
                  # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
                  #
                  # This cannot be used for internal load balancing.
              "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
                  #
                  # This cannot be used for internal load balancing.
              "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
                  #
                  # This cannot be used for internal load balancing.
            },
          ],
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
          "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
              #
              # When the load balancing scheme is INTERNAL, this field is not used.
          "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
              #
              # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
            "A String",
          ],
          "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
              #
              # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
              #
              # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
              #
              # When the protocol is UDP, this field is not used.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, backendService, body) 
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, backendService, body) 
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information.

Args:
  project: string, Project ID for this request. (required)
  backendService: string, Name of the BackendService resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
    "connectionDraining": { # Message containing connection draining configuration.
      "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
    },
    "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
        # 
        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
        # 
        # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
    "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
        # 
        # This cannot be used for internal load balancing.
    "backends": [ # The list of backends that serve this BackendService.
      { # Message containing information of one individual backend.
        "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
            #
            # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
            #
            # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
            #
            # This cannot be used for internal load balancing.
        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
            #
            # This cannot be used for internal load balancing.
        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
            #
            # This cannot be used for internal load balancing.
      },
    ],
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
        # 
        # When the load balancing scheme is INTERNAL, this field is not used.
    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
        # 
        # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
      "A String",
    ],
    "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
        # 
        # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
        # 
        # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
        # 
        # When the protocol is UDP, this field is not used.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.diskTypes.html000066400000000000000000000436451300622755700250330ustar00rootroot00000000000000

Compute Engine API . diskTypes

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of disk types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, diskType)

Returns the specified disk type. Get a list of available disk types by making a list() request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of disk types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of disk types.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped disk type lists.
      "a_key": { # [Output Only] Name of the scope containing this set of disk types.
        "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "diskTypes": [ # [Output Only] List of disk types contained in this scope.
          { # A DiskType resource.
            "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
            "description": "A String", # [Output Only] An optional description of this resource.
            "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
            "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
            "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
      },
    },
    "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, diskType) 
Returns the specified disk type. Get a list of available disk types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  diskType: string, Name of the disk type to return. (required)

Returns:
  An object of the form:

    { # A DiskType resource.
    "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
    "description": "A String", # [Output Only] An optional description of this resource.
    "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
    "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
    "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of disk types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of disk types.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Disk Type resources.
      { # A DiskType resource.
        "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
        "description": "A String", # [Output Only] An optional description of this resource.
        "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
        "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.disks.html000066400000000000000000001776431300622755700241770ustar00rootroot00000000000000

Compute Engine API . disks

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of persistent disks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

createSnapshot(project, zone, disk, body)

Creates a snapshot of a specified persistent disk.

delete(project, zone, disk)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

get(project, zone, disk)

Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

insert(project, zone, body, sourceImage=None)

Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of persistent disks contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

resize(project, zone, disk, body)

Resizes the specified persistent disk.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of persistent disks.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped disk lists.
      "a_key": { # [Output Only] Name of the scope containing this set of disks.
        "disks": [ # [Output Only] List of disks contained in this scope.
          { # A Disk resource.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              },
              "licenses": [ # Any applicable publicly visible licenses.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
                "A String",
              ],
              "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
                  #
                  # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
                  #
                  # Customer-supplied encryption keys do not protect access to metadata of the disk.
                  #
                  # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              },
              "zone": "A String", # [Output Only] URL of the zone where the disk resides.
              "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
              "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
              "status": "A String", # [Output Only] The status of disk creation.
              "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
                  # - projects/project/global/snapshots/snapshot
                  # - global/snapshots/snapshot
              "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
              "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
                  #
                  # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
              "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              },
              "options": "A String", # Internal use only.
              "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
            },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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) 
Creates a snapshot of a specified persistent disk.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to snapshot. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A persistent disk snapshot resource.
    "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
    "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
    "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
        # 
        # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
    "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
    "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, zone, disk) 
Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, disk) 
Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, Name of the persistent disk to return. (required)

Returns:
  An object of the form:

    { # A Disk resource.
      "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "licenses": [ # Any applicable publicly visible licenses.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
        "A String",
      ],
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
          #
          # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "zone": "A String", # [Output Only] URL of the zone where the disk resides.
      "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
      "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
      "status": "A String", # [Output Only] The status of disk creation.
      "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
          # - projects/project/global/snapshots/snapshot
          # - global/snapshots/snapshot
      "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
      "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
          #
          # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
          #
          # projects/debian-cloud/global/images/family/debian-8
          #
          # Alternatively, use a specific version of a public operating system image:
          #
          # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
          #
          # To create a disk with a private image that you created, specify the image name in the following format:
          #
          # global/images/my-private-image
          #
          # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
          #
          # global/images/family/my-private-family
      "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
      "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
          #
          # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
      "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "options": "A String", # Internal use only.
      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    }
insert(project, zone, body, sourceImage=None) 
Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Disk resource.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "licenses": [ # Any applicable publicly visible licenses.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
      "A String",
    ],
    "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
        # 
        # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "zone": "A String", # [Output Only] URL of the zone where the disk resides.
    "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
    "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
    "status": "A String", # [Output Only] The status of disk creation.
    "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
        # - projects/project/global/snapshots/snapshot
        # - global/snapshots/snapshot
    "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        # 
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        # 
        # projects/debian-cloud/global/images/family/debian-8
        # 
        # Alternatively, use a specific version of a public operating system image:
        # 
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        # 
        # To create a disk with a private image that you created, specify the image name in the following format:
        # 
        # global/images/my-private-image
        # 
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        # 
        # global/images/family/my-private-family
    "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
    "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
        # 
        # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
    "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "options": "A String", # Internal use only.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
  }

  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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of persistent disks contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of Disk resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of persistent disks.
      { # A Disk resource.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "licenses": [ # Any applicable publicly visible licenses.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
            "A String",
          ],
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
              #
              # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "zone": "A String", # [Output Only] URL of the zone where the disk resides.
          "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
          "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
          "status": "A String", # [Output Only] The status of disk creation.
          "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
              # - projects/project/global/snapshots/snapshot
              # - global/snapshots/snapshot
          "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
          "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
          "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
              #
              # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
          "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "options": "A String", # Internal use only.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        },
    ],
    "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
resize(project, zone, disk, body) 
Resizes the specified persistent disk.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  disk: string, The name of the persistent disk. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sizeGb": "A String", # The new size of the persistent disk, which is specified in GB.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.firewalls.html000066400000000000000000001334401300622755700250350ustar00rootroot00000000000000

Compute Engine API . firewalls

Instance Methods

delete(project, firewall)

Deletes the specified firewall.

get(project, firewall)

Returns the specified firewall.

insert(project, body)

Creates a firewall rule in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of firewall rules 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 rule with the data included in the request. This method supports patch semantics.

update(project, firewall, body)

Updates the specified firewall rule with the data included in the request.

Method Details

delete(project, firewall) 
Deletes the specified firewall.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, firewall) 
Returns the specified firewall.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to return. (required)

Returns:
  An object of the form:

    { # Represents a Firewall resource.
      "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
        "A String",
      ],
      "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
        "A String",
      ],
      "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
          # global/networks/default
          # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
          # - projects/myproject/global/networks/my-network
          # - global/networks/default
      "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
        {
          "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
          "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
              #
              # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
            "A String",
          ],
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a firewall rule in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of firewall rules available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of firewalls.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Firewall resources.
      { # Represents a Firewall resource.
          "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
            "A String",
          ],
          "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
            "A String",
          ],
          "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
              # global/networks/default
              # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
              # - projects/myproject/global/networks/my-network
              # - global/networks/default
          "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
            {
              "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
              "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
                  #
                  # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
                "A String",
              ],
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, firewall, body) 
Updates the specified firewall rule with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, firewall, body) 
Updates the specified firewall rule with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  firewall: string, Name of the firewall rule to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Firewall resource.
    "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
      "A String",
    ],
    "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
        # global/networks/default
        # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
        # - projects/myproject/global/networks/my-network
        # - global/networks/default
    "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
      {
        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
            # 
            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
          "A String",
        ],
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.forwardingRules.html000066400000000000000000001212441300622755700262210ustar00rootroot00000000000000

Compute Engine API . forwardingRules

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of forwarding rules.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, forwardingRule)

Deletes the specified ForwardingRule resource.

get(project, region, forwardingRule)

Returns the specified ForwardingRule resource.

insert(project, region, body)

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of ForwardingRule resources available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, region, forwardingRule, body)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of forwarding rules.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped forwarding rule lists.
      "a_key": { # Name of the scope containing this set of addresses.
        "forwardingRules": [ # List of forwarding rules contained in this scope.
          { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
              "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
                  #
                  # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
                  #
                  # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
              "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
              "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
                  #
                  # This field is not used for internal load balancing.
              "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
                  #
                  # This field is not used for internal load balancing.
              "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
                  #
                  # When the load balancing scheme is INTERNAL
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, forwardingRule) 
Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, forwardingRule) 
Returns the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)

Returns:
  An object of the form:

    { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
          #
          # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
          #
          # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
      "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
          #
          # This field is not used for internal load balancing.
      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
          #
          # This field is not used for internal load balancing.
      "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
          #
          # When the load balancing scheme is INTERNAL
insert(project, region, body) 
Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for 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 ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
        # 
        # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
        # 
        # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
    "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
        # 
        # This field is not used for internal load balancing.
    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
        # 
        # This field is not used for internal load balancing.
    "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
        # 
        # When the load balancing scheme is INTERNAL
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of ForwardingRule resources available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of ForwardingRule resources.
      { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
              #
              # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
              #
              # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
          "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
              #
              # This field is not used for internal load balancing.
          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
              #
              # This field is not used for internal load balancing.
          "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
              #
              # When the load balancing scheme is INTERNAL
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.
setTarget(project, region, forwardingRule, body) 
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.globalAddresses.html000066400000000000000000000520671300622755700261500ustar00rootroot00000000000000

Compute Engine API . globalAddresses

Instance Methods

delete(project, address)

Deletes the specified address resource.

get(project, address)

Returns the specified address resource. Get a list of available addresses by making a list() request.

insert(project, body)

Creates an address resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of global addresses.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(project, address) 
Deletes the specified address resource.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, address) 
Returns the specified address resource. Get a list of available addresses by making a list() request.

Args:
  project: string, Project ID for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
      "address": "A String", # The static external IP address represented by this resource.
      "users": [ # [Output Only] The URLs of the resources that are using this address.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an address resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A reserved address resource.
    "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
    "address": "A String", # The static external IP address represented by this resource.
    "users": [ # [Output Only] The URLs of the resources that are using this address.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of global addresses.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of addresses.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of addresses.
      { # A reserved address resource.
          "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
          "address": "A String", # The static external IP address represented by this resource.
          "users": [ # [Output Only] The URLs of the resources that are using this address.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.globalForwardingRules.html000066400000000000000000000765371300622755700273600ustar00rootroot00000000000000

Compute Engine API . globalForwardingRules

Instance Methods

delete(project, forwardingRule)

Deletes the specified ForwardingRule resource.

get(project, forwardingRule)

Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

insert(project, body)

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of ForwardingRule resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, forwardingRule, body)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Method Details

delete(project, forwardingRule) 
Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, forwardingRule) 
Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)

Returns:
  An object of the form:

    { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
          #
          # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
          #
          # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
      "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
          #
          # This field is not used for internal load balancing.
      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
          #
          # This field is not used for internal load balancing.
      "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
          #
          # When the load balancing scheme is INTERNAL
insert(project, body) 
Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
        # 
        # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
        # 
        # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
    "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
        # 
        # This field is not used for internal load balancing.
    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
        # 
        # This field is not used for internal load balancing.
    "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
        # 
        # When the load balancing scheme is INTERNAL
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of ForwardingRule resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of ForwardingRule resources.
      { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
              #
              # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
              #
              # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
          "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
              #
              # This field is not used for internal load balancing.
          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
              #
              # This field is not used for internal load balancing.
          "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
              #
              # When the load balancing scheme is INTERNAL
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.
setTarget(project, forwardingRule, body) 
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.globalOperations.html000066400000000000000000000647271300622755700263640ustar00rootroot00000000000000

Compute Engine API . globalOperations

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of all operations.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, operation)

Deletes the specified Operations resource.

get(project, operation)

Retrieves the specified Operations resource. Get a list of operations by making a list() request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of all operations.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped operation lists.
      "a_key": { # [Output Only] Name of the scope containing this set of operations.
        "operations": [ # [Output Only] List of operations contained in this scope.
          { # An Operation resource, used to manage asynchronous API requests.
            "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
            "clientOperationId": "A String", # [Output Only] Reserved for future use.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
            "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
            "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
            "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
            "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
            "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
            "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
            "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
            "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
            "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
              {
                "message": "A String", # [Output Only] A human-readable description of the warning code.
                "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                    # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                  {
                    "value": "A String", # [Output Only] A warning data value corresponding to the key.
                    "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                  },
                ],
              },
            ],
            "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
            "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
            "name": "A String", # [Output Only] Name of the resource.
            "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
            "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
              "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                {
                  "message": "A String", # [Output Only] An optional, human-readable error message.
                  "code": "A String", # [Output Only] The error type identifier for this error.
                  "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
                },
              ],
            },
            "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, operation) 
Retrieves the specified Operations resource. Get a list of operations by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.healthChecks.html000066400000000000000000001610011300622755700254250ustar00rootroot00000000000000

Compute Engine API . healthChecks

Instance Methods

delete(project, healthCheck)

Deletes the specified HealthCheck resource.

get(project, healthCheck)

Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

insert(project, body)

Creates a HealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, healthCheck, body)

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

update(project, healthCheck, body)

Updates a HealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, healthCheck) 
Deletes the specified HealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, healthCheck) 
Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
      "kind": "compute#healthCheck", # Type of the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
      "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
      "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
      "tcpHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 80.
        "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
      },
      "httpHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 80.
        "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
      },
      "httpsHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
      },
      "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
      "http2HealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
      },
      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "sslHealthCheck": {
        "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
        "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
        "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        "port": 42, # The TCP port number for the health check request. The default value is 443.
        "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
      },
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
    },
    "httpsHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HealthCheck resources.
      { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
          "kind": "compute#healthCheck", # Type of the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
          "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
          "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
          "tcpHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 80.
            "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
          },
          "httpHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 80.
            "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
          },
          "httpsHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
          },
          "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
          "http2HealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
          },
          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "sslHealthCheck": {
            "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
            "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
            "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
            "port": 42, # The TCP port number for the health check request. The default value is 443.
            "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
          },
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#healthCheckList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, healthCheck, body) 
Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
    },
    "httpsHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, healthCheck, body) 
Updates a HealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  healthCheck: string, Name of the HealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
    "kind": "compute#healthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
    "tcpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "httpHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 80.
      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
    },
    "httpsHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
    },
    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    "http2HealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
    },
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "sslHealthCheck": {
      "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
      "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "port": 42, # The TCP port number for the health check request. The default value is 443.
      "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
    },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.html000066400000000000000000000202411300622755700230400ustar00rootroot00000000000000

Compute Engine API

Instance Methods

addresses()

Returns the addresses Resource.

autoscalers()

Returns the autoscalers Resource.

backendServices()

Returns the backendServices Resource.

diskTypes()

Returns the diskTypes Resource.

disks()

Returns the disks Resource.

firewalls()

Returns the firewalls Resource.

forwardingRules()

Returns the forwardingRules Resource.

globalAddresses()

Returns the globalAddresses Resource.

globalForwardingRules()

Returns the globalForwardingRules Resource.

globalOperations()

Returns the globalOperations Resource.

healthChecks()

Returns the healthChecks Resource.

httpHealthChecks()

Returns the httpHealthChecks Resource.

httpsHealthChecks()

Returns the httpsHealthChecks Resource.

images()

Returns the images Resource.

instanceGroupManagers()

Returns the instanceGroupManagers Resource.

instanceGroups()

Returns the instanceGroups Resource.

instanceTemplates()

Returns the instanceTemplates Resource.

instances()

Returns the instances Resource.

licenses()

Returns the licenses 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.

routers()

Returns the routers Resource.

routes()

Returns the routes Resource.

snapshots()

Returns the snapshots Resource.

sslCertificates()

Returns the sslCertificates Resource.

subnetworks()

Returns the subnetworks Resource.

targetHttpProxies()

Returns the targetHttpProxies Resource.

targetHttpsProxies()

Returns the targetHttpsProxies Resource.

targetInstances()

Returns the targetInstances Resource.

targetPools()

Returns the targetPools Resource.

targetSslProxies()

Returns the targetSslProxies Resource.

targetVpnGateways()

Returns the targetVpnGateways Resource.

urlMaps()

Returns the urlMaps Resource.

vpnTunnels()

Returns the vpnTunnels Resource.

zoneOperations()

Returns the zoneOperations Resource.

zones()

Returns the zones Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/compute_v1.httpHealthChecks.html000066400000000000000000001131601300622755700262700ustar00rootroot00000000000000

Compute Engine API . httpHealthChecks

Instance Methods

delete(project, httpHealthCheck)

Deletes the specified HttpHealthCheck resource.

get(project, httpHealthCheck)

Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

insert(project, body)

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HttpHealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, httpHealthCheck, body)

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

update(project, httpHealthCheck, body)

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, httpHealthCheck) 
Deletes the specified HttpHealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, httpHealthCheck) 
Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
      "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
      "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HttpHealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HttpHealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HttpHealthCheck resources.
      { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
          "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
          "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#httpHealthCheckList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
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, Project ID for 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 instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, httpHealthCheck, body) 
Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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 instances should be checked for health, via HTTP.
    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
    "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.httpsHealthChecks.html000066400000000000000000001125611300622755700264570ustar00rootroot00000000000000

Compute Engine API . httpsHealthChecks

Instance Methods

delete(project, httpsHealthCheck)

Deletes the specified HttpsHealthCheck resource.

get(project, httpsHealthCheck)

Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

insert(project, body)

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of HttpsHealthCheck resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, httpsHealthCheck, body)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

update(project, httpsHealthCheck, body)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Method Details

delete(project, httpsHealthCheck) 
Deletes the specified HttpsHealthCheck resource.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, httpsHealthCheck) 
Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)

Returns:
  An object of the form:

    { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
      "kind": "compute#httpsHealthCheck", # Type of the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
      "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 HTTPS health check request. The default value is 443.
      "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of HttpsHealthCheck resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of HttpsHealthCheck resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of HttpsHealthCheck resources.
      { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
          "kind": "compute#httpsHealthCheck", # Type of the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
          "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 HTTPS health check request. The default value is 443.
          "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#httpsHealthCheckList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, httpsHealthCheck, body) 
Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, httpsHealthCheck, body) 
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
    "kind": "compute#httpsHealthCheck", # Type of the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    "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 HTTPS health check request. The default value is 443.
    "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.images.html000066400000000000000000001361131300622755700243120ustar00rootroot00000000000000

Compute Engine API . images

Instance Methods

delete(project, image)

Deletes the specified image.

deprecate(project, image, body)

Sets the deprecation status of an image.

get(project, image)

Returns the specified image. Get a list of available images by making a list() request.

getFromFamily(project, family)

Returns the latest image that is part of an image family and is not deprecated.

insert(project, body)

Creates an image in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(project, image) 
Deletes the specified image.

Args:
  project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deprecate(project, image, body) 
Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Args:
  project: string, Project ID for 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, image) 
Returns the specified image. Get a list of available images by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  image: string, Name of the image resource to return. (required)

Returns:
  An object of the form:

    { # An Image resource.
      "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
          # - projects/project/zones/zone/disks/disk
          # - zones/zone/disks/disk
      "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
      "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
      "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
      },
      "rawDisk": { # The parameters of the raw disk image.
        "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
        "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
      },
      "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
      "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
      "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
      "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
          #
          # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "licenses": [ # Any applicable license URI.
        "A String",
      ],
      "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getFromFamily(project, family) 
Returns the latest image that is part of an image family and is not deprecated.

Args:
  project: string, Project ID for this request. (required)
  family: string, Name of the image family to search for. (required)

Returns:
  An object of the form:

    { # An Image resource.
      "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
          # - projects/project/zones/zone/disks/disk
          # - zones/zone/disks/disk
      "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
      "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
      "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
      },
      "rawDisk": { # The parameters of the raw disk image.
        "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
        "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
      },
      "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
      "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
      "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
      "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
          #
          # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "licenses": [ # Any applicable license URI.
        "A String",
      ],
      "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an image in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Image resource.
    "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
        # - projects/project/zones/zone/disks/disk
        # - zones/zone/disks/disk
    "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
    "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
    "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
    "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "rawDisk": { # The parameters of the raw disk image.
      "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
      "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
    },
    "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
    "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
    "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
    "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
        # 
        # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
        # 
        # Customer-supplied encryption keys do not protect access to metadata of the disk.
        # 
        # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "licenses": [ # Any applicable license URI.
      "A String",
    ],
    "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of images.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Image resources.
      { # An Image resource.
          "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
              # - projects/project/zones/zone/disks/disk
              # - zones/zone/disks/disk
          "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
          "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
          "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
          "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
          },
          "rawDisk": { # The parameters of the raw disk image.
            "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
            "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
          },
          "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
          "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
          "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
          "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
              #
              # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "licenses": [ # Any applicable license URI.
            "A String",
          ],
          "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#imageList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.instanceGroupManagers.html000066400000000000000000002521511300622755700273450ustar00rootroot00000000000000

Compute Engine API . instanceGroupManagers

Instance Methods

abandonInstances(project, zone, instanceGroupManager, body)

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of managed instance groups and groups them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroupManager)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

deleteInstances(project, zone, instanceGroupManager, body)

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

get(project, zone, instanceGroupManager)

Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

insert(project, zone, body)

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

listManagedInstances(project, zone, instanceGroupManager)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

list_next(previous_request, previous_response)

Retrieves the next page of results.

recreateInstances(project, zone, instanceGroupManager, body)

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

resize(project, zone, instanceGroupManager, size)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

setInstanceTemplate(project, zone, instanceGroupManager, body)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

setTargetPools(project, zone, instanceGroupManager, body)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Method Details

abandonInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to abandon from the managed instance group.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of managed instance groups and groups them by zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of filtered managed instance group lists.
      "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
        "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
          { # An Instance Group Manager resource.
              "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
                "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
                "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
                "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                    #
                    # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
                "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
                "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
                "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
                "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
                "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
              },
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
              "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
              "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
              "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
              "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
              "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
                "A String",
              ],
              "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
              "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
              "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
              "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
                { # The named port. For example: .
                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
                  "port": 42, # The port number, which can be a value between 1 and 65535.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
              "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
              "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
              "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
      },
    },
    "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
    "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
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, zone, instanceGroupManager) 
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read  Deleting an instance group for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instanceGroupManager) 
Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
        "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
        "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
            #
            # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
        "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
        "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
        "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
        "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
        "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
      },
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
      "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
      "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
      "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
      "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
      "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
        "A String",
      ],
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
      "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
      "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
      "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
      "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
      "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, zone, body) 
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
      "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
          #
          # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
      "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
      "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
      "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
      "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
    },
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
    "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
      "A String",
    ],
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
    "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of managed instance groups that are contained within the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # [Output Only] A list of managed instance groups.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of managed instance groups.
      { # An Instance Group Manager resource.
          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
            "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
            "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
                #
                # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
            "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
            "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
            "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
            "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
            "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
          },
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
          "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
          "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
          "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
          "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
          "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
            "A String",
          ],
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
          "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
          "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
          "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
          "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
          "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
listManagedInstances(project, zone, instanceGroupManager) 
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)

Returns:
  An object of the form:

    {
    "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
      {
        "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
            # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
            # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
            # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
            # - RECREATING The managed instance group is recreating this instance.
            # - DELETING The managed instance group is permanently deleting this instance.
            # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
            # - RESTARTING The managed instance group is restarting the instance.
            # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
        "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
        "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
          "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
        },
        "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
        "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
      },
    ],
  }
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.
recreateInstances(project, zone, instanceGroupManager, body) 
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The URL for one or more instances to recreate.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
resize(project, zone, instanceGroupManager, size) 
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setInstanceTemplate(project, zone, instanceGroupManager, body) 
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTargetPools(project, zone, instanceGroupManager, body) 
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the managed instance group is located. (required)
  instanceGroupManager: string, The name of the managed instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.instanceGroups.html000066400000000000000000001551671300622755700260630ustar00rootroot00000000000000

Compute Engine API . instanceGroups

Instance Methods

addInstances(project, zone, instanceGroup, body)

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance groups and sorts them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroup)

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

get(project, zone, instanceGroup)

Returns the specified instance group. Get a list of available instance groups by making a list() request.

insert(project, zone, body)

Creates an instance group in the specified project using the parameters that are included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instance groups that are located in the specified project and zone.

listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)

Lists the instances in the specified instance group.

listInstances_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeInstances(project, zone, instanceGroup, body)

Removes one or more instances from the specified instance group, but does not delete those instances.

setNamedPorts(project, zone, instanceGroup, body)

Sets the named ports for the specified instance group.

Method Details

addInstances(project, zone, instanceGroup, body) 
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read  Adding instances for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where you are adding instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to add to the instance group.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance groups and sorts them by zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped instance group lists.
      "a_key": { # The name of the scope that contains this set of instance groups.
        "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
          {
              "size": 42, # [Output Only] The total number of instances in the instance group.
              "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
              "region": "A String", # The URL of the region where the instance group is located (for regional resources).
              "network": "A String", # The URL of the network to which all instances in the instance group belong.
              "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
              "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
              "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
                  #
                  # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
                  #
                  # Named ports apply to all instances in this instance group.
                { # The named port. For example: .
                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
                  "port": 42, # The port number, which can be a value between 1 and 65535.
                },
              ],
              "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
              "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
              "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
              "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
      },
    },
    "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
    "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
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, zone, instanceGroup) 
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read  Deleting an instance group for more information.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instanceGroup) 
Returns the specified instance group. Get a list of available instance groups by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group. (required)

Returns:
  An object of the form:

    {
      "size": 42, # [Output Only] The total number of instances in the instance group.
      "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
      "region": "A String", # The URL of the region where the instance group is located (for regional resources).
      "network": "A String", # The URL of the network to which all instances in the instance group belong.
      "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
      "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
      "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
          #
          # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
          #
          # Named ports apply to all instances in this instance group.
        { # The named port. For example: .
          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          "port": 42, # The port number, which can be a value between 1 and 65535.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
      "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
      "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
      "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    }
insert(project, zone, body) 
Creates an instance group in the specified project using the parameters that are included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where you want to create the instance group. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "size": 42, # [Output Only] The total number of instances in the instance group.
    "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
    "region": "A String", # The URL of the region where the instance group is located (for regional resources).
    "network": "A String", # The URL of the network to which all instances in the instance group belong.
    "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
    "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
        # 
        # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
        # 
        # Named ports apply to all instances in this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
    "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
    "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
    "name": "A String", # The name of the instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instance groups that are located in the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of InstanceGroup resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of instance groups.
      {
          "size": 42, # [Output Only] The total number of instances in the instance group.
          "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
          "region": "A String", # The URL of the region where the instance group is located (for regional resources).
          "network": "A String", # The URL of the network to which all instances in the instance group belong.
          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
          "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
              #
              # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
              #
              # Named ports apply to all instances in this instance group.
            { # The named port. For example: .
              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
              "port": 42, # The port number, which can be a value between 1 and 65535.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
          "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
          "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
        },
    ],
    "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
    "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
  }
listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Lists the instances in the specified instance group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
  }

  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances.
      {
        "status": "A String", # [Output Only] The status of the instance.
        "instance": "A String", # [Output Only] The URL of the instance.
        "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
          { # The named port. For example: .
            "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
            "port": 42, # The port number, which can be a value between 1 and 65535.
          },
        ],
      },
    ],
    "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
    "id": "A String", # [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.
    "selfLink": "A String", # [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.
  }
listInstances_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.
removeInstances(project, zone, instanceGroup, body) 
Removes one or more instances from the specified instance group, but does not delete those instances.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The list of instances to remove from the instance group.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setNamedPorts(project, zone, instanceGroup, body) 
Sets the named ports for the specified instance group.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone where the instance group is located. (required)
  instanceGroup: string, The name of the instance group where the named ports are updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "namedPorts": [ # The list of named ports to set for this instance group.
      { # The named port. For example: .
        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
        "port": 42, # The port number, which can be a value between 1 and 65535.
      },
    ],
    "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.instanceTemplates.html000066400000000000000000002037211300622755700265300ustar00rootroot00000000000000

Compute Engine API . instanceTemplates

Instance Methods

delete(project, instanceTemplate)

Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

get(project, instanceTemplate)

Returns the specified instance template. Get a list of available instance templates by making a list() request.

insert(project, body)

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of instance templates that are contained within the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(project, instanceTemplate) 
Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

Args:
  project: string, Project ID for this request. (required)
  instanceTemplate: string, The name of the instance template to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, instanceTemplate) 
Returns the specified instance template. Get a list of available instance templates by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  instanceTemplate: string, The name of the instance template. (required)

Returns:
  An object of the form:

    { # An Instance Template resource.
      "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
      "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
      "properties": { # The instance properties for this instance template.
        "machineType": "A String", # The machine type to use for instances that are created from this template.
        "description": "A String", # An optional text description for the instances that are created from this instance template.
        "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
              #
              # To see the latest fingerprint, make get() request to the instance.
        },
        "disks": [ # An array of disks that are associated with the instances that are created from this template.
          { # An instance-attached disk resource.
            "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                #
                # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                #
                # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                #
                # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            },
            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                #
                # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                  #
                  # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              },
              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                  #
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                  #
                  # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                  # - projects/project/zones/zone/diskTypes/diskType
                  # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
            },
            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
            "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
            "licenses": [ # [Output Only] Any valid publicly visible licenses.
              "A String",
            ],
            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
            "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
          },
        ],
        "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
          "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
          "preemptible": True or False, # Whether the instance is preemptible.
          "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
        },
        "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
        "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
          { # 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.
          },
        ],
        "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
        "networkInterfaces": [ # An array of network access configurations for this interface.
          { # A network interface resource attached to an instance.
            "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                "name": "A String", # Name of this access configuration.
                "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
              },
            ],
            "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
            "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
            "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                # - regions/region/subnetworks/subnetwork
            "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                #
                # global/networks/default
                #
                # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                # - projects/project/global/networks/network
                # - global/networks/default
          },
        ],
      },
      "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Template resource.
    "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
    "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
    "properties": { # The instance properties for this instance template.
      "machineType": "A String", # The machine type to use for instances that are created from this template.
      "description": "A String", # An optional text description for the instances that are created from this instance template.
      "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            #
            # To see the latest fingerprint, make get() request to the instance.
      },
      "disks": [ # An array of disks that are associated with the instances that are created from this template.
        { # An instance-attached disk resource.
          "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
              #
              # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
              #
              # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
              #
              # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
              #
              # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
              #
              # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
          "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
          "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
              #
              # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              #
              # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
            "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            },
            "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
            "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
            "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                #
                # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                #
                # projects/debian-cloud/global/images/family/debian-8
                #
                # Alternatively, use a specific version of a public operating system image:
                #
                # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                #
                # To create a disk with a private image that you created, specify the image name in the following format:
                #
                # global/images/my-private-image
                #
                # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                #
                # global/images/family/my-private-family
            "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                #
                # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                #
                # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                # - projects/project/zones/zone/diskTypes/diskType
                # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
          },
          "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
          "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
          "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
          "licenses": [ # [Output Only] Any valid publicly visible licenses.
            "A String",
          ],
          "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
          "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
          "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
          "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
        },
      ],
      "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
        "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
        "preemptible": True or False, # Whether the instance is preemptible.
        "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
      },
      "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
      "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
        { # 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.
        },
      ],
      "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
        "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      },
      "networkInterfaces": [ # An array of network access configurations for this interface.
        { # A network interface resource attached to an instance.
          "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
              "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
              "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
              "name": "A String", # Name of this access configuration.
              "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
            },
          ],
          "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
          "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
          "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
              # - regions/region/subnetworks/subnetwork
          "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
              #
              # global/networks/default
              #
              # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
              # - projects/project/global/networks/network
              # - global/networks/default
        },
      ],
    },
    "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of instance templates that are contained within the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of instance templates.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] list of InstanceTemplate resources.
      { # An Instance Template resource.
          "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
          "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
          "properties": { # The instance properties for this instance template.
            "machineType": "A String", # The machine type to use for instances that are created from this template.
            "description": "A String", # An optional text description for the instances that are created from this instance template.
            "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                  #
                  # To see the latest fingerprint, make get() request to the instance.
            },
            "disks": [ # An array of disks that are associated with the instances that are created from this template.
              { # An instance-attached disk resource.
                "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                    #
                    # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                    #
                    # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                    #
                    # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                    #
                    # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
                  "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                  "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                },
                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                    #
                    # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                  "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                      #
                      # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                  },
                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
                  "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                      #
                      # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                      #
                      # projects/debian-cloud/global/images/family/debian-8
                      #
                      # Alternatively, use a specific version of a public operating system image:
                      #
                      # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                      #
                      # To create a disk with a private image that you created, specify the image name in the following format:
                      #
                      # global/images/my-private-image
                      #
                      # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                      #
                      # global/images/family/my-private-family
                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                      #
                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                      #
                      # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                      # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                      # - projects/project/zones/zone/diskTypes/diskType
                      # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
                },
                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
                "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
                "licenses": [ # [Output Only] Any valid publicly visible licenses.
                  "A String",
                ],
                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
                "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
              },
            ],
            "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
              "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
              "preemptible": True or False, # Whether the instance is preemptible.
              "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
            },
            "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
            "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
              { # 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.
              },
            ],
            "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
              "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            },
            "networkInterfaces": [ # An array of network access configurations for this interface.
              { # A network interface resource attached to an instance.
                "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                    "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                    "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                    "name": "A String", # Name of this access configuration.
                    "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                  },
                ],
                "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
                "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
                "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                    # - regions/region/subnetworks/subnetwork
                "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                    #
                    # global/networks/default
                    #
                    # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                    # - projects/project/global/networks/network
                    # - global/networks/default
              },
            ],
          },
          "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.
    "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
    "selfLink": "A String", # [Output Only] The URL for this instance template list. The server defines this URL.
  }
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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.instances.html000066400000000000000000005302761300622755700250440ustar00rootroot00000000000000

Compute Engine API . instances

Instance Methods

addAccessConfig(project, zone, instance, networkInterface, body)

Adds an access config to an instance's network interface.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves aggregated list of instances.

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. For more information, see Stopping or Deleting an Instance.

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. Get a list of available instances by making a list() request.

getSerialPortOutput(project, zone, instance, port=None)

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, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of instances 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.

setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)

Sets the auto-delete flag for a disk attached to an instance.

setMachineType(project, zone, instance, body)

Changes the machine type for a stopped instance to the machine type specified in the request.

setMetadata(project, zone, instance, body)

Sets metadata for the specified instance to the data included in the request.

setScheduling(project, zone, instance, body)

Sets an instance's scheduling options.

setTags(project, zone, instance, body)

Sets tags for the specified instance to the data included in the request.

start(project, zone, instance)

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

startWithEncryptionKey(project, zone, instance, body)

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

stop(project, zone, instance)

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Method Details

addAccessConfig(project, zone, instance, networkInterface, body) 
Adds an access config to an instance's network interface.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  networkInterface: string, The name of the network interface to add to this instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
  "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
  "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
  "name": "A String", # Name of this access configuration.
  "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves aggregated list of instances.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped instance lists.
      "a_key": { # [Output Only] Name of the scope containing this set of instances.
        "instances": [ # [Output Only] List of instances contained in this scope.
          { # An Instance resource.
            "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
            "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
            "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
            "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "zone": "A String", # [Output Only] URL of the zone where the instance resides.
            "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
                  #
                  # To see the latest fingerprint, make get() request to the instance.
            },
            "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
              { # An instance-attached disk resource.
                "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                    #
                    # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                    #
                    # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                    #
                    # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                    #
                    # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
                  "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                  "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                },
                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                    #
                    # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                    #
                    # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                  "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                      #
                      # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
                  },
                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
                  "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                      #
                      # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                      #
                      # projects/debian-cloud/global/images/family/debian-8
                      #
                      # Alternatively, use a specific version of a public operating system image:
                      #
                      # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                      #
                      # To create a disk with a private image that you created, specify the image name in the following format:
                      #
                      # global/images/my-private-image
                      #
                      # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                      #
                      # global/images/family/my-private-family
                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                      #
                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                      #
                      # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                      # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                      # - projects/project/zones/zone/diskTypes/diskType
                      # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
                },
                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
                "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
                "licenses": [ # [Output Only] Any valid publicly visible licenses.
                  "A String",
                ],
                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
                "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
              },
            ],
            "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
            "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
              "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
              "preemptible": True or False, # Whether the instance is preemptible.
              "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
            },
            "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
                #
                # zones/us-central1-f/machineTypes/n1-standard-1
                #
                # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
                #
                # zones/zone/machineTypes/custom-CPUS-MEMORY
                #
                # For example: zones/us-central1-f/machineTypes/custom-4-5120
                #
                # For a full list of restrictions, read the Specifications for custom machine types.
            "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
              { # 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": [ # An 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. Only one interface is supported per instance.
              { # A network interface resource attached to an instance.
                "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                    "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                    "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                    "name": "A String", # Name of this access configuration.
                    "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
                  },
                ],
                "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
                "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
                "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                    # - regions/region/subnetworks/subnetwork
                "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                    #
                    # global/networks/default
                    #
                    # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                    # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                    # - projects/project/global/networks/network
                    # - global/networks/default
              },
            ],
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
            "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
              "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
              "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
            },
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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 ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An instance-attached disk resource.
  "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
      # 
      # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
      # 
      # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
      # 
      # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
      # 
      # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
    "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
    "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
  },
  "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
      # 
      # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
  "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
  "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
      # 
      # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
      #
      # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
    "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        #
        # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
      "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
      "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    },
    "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
    "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
    "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
        #
        # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
        #
        # projects/debian-cloud/global/images/family/debian-8
        #
        # Alternatively, use a specific version of a public operating system image:
        #
        # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
        #
        # To create a disk with a private image that you created, specify the image name in the following format:
        #
        # global/images/my-private-image
        #
        # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
        #
        # global/images/family/my-private-family
    "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
        #
        # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
        #
        # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
        # - projects/project/zones/zone/diskTypes/diskType
        # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
  },
  "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
  "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
  "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
  "licenses": [ # [Output Only] Any valid publicly visible licenses.
    "A String",
  ],
  "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
  "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
  "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
  "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, zone, instance) 
Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
deleteAccessConfig(project, zone, instance, accessConfig, networkInterface) 
Deletes an access config from an instance's network interface.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name for this request. (required)
  accessConfig: string, The name of the access config to delete. (required)
  networkInterface: string, The name of the network interface. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
detachDisk(project, zone, instance, deviceName) 
Detaches a disk from an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, instance) 
Returns the specified Instance resource. Get a list of available instances by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to return. (required)

Returns:
  An object of the form:

    { # An Instance resource.
    "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
    "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
    "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
    "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the instance resides.
    "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
          #
          # To see the latest fingerprint, make get() request to the instance.
    },
    "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
      { # An instance-attached disk resource.
        "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
            #
            # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
            #
            # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
            #
            # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        },
        "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
            #
            # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
        "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
        "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
            #
            # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
            #
            # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
          "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
              #
              # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
          "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
          "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
              #
              # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
              #
              # projects/debian-cloud/global/images/family/debian-8
              #
              # Alternatively, use a specific version of a public operating system image:
              #
              # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
              #
              # To create a disk with a private image that you created, specify the image name in the following format:
              #
              # global/images/my-private-image
              #
              # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
              #
              # global/images/family/my-private-family
          "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
              #
              # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
              #
              # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
              # - projects/project/zones/zone/diskTypes/diskType
              # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
        },
        "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
        "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
        "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
        "licenses": [ # [Output Only] Any valid publicly visible licenses.
          "A String",
        ],
        "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
        "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
        "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
        "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
      },
    ],
    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
    "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
      "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
      "preemptible": True or False, # Whether the instance is preemptible.
      "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
    },
    "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
        #
        # zones/us-central1-f/machineTypes/n1-standard-1
        #
        # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
        #
        # zones/zone/machineTypes/custom-CPUS-MEMORY
        #
        # For example: zones/us-central1-f/machineTypes/custom-4-5120
        #
        # For a full list of restrictions, read the Specifications for custom machine types.
    "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
      { # 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": [ # An 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. Only one interface is supported per instance.
      { # A network interface resource attached to an instance.
        "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
            "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
            "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
            "name": "A String", # Name of this access configuration.
            "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
          },
        ],
        "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
        "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
        "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
            # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
            # - regions/region/subnetworks/subnetwork
        "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
            #
            # global/networks/default
            #
            # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
            # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
            # - projects/project/global/networks/network
            # - global/networks/default
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
    "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
      "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
  }
getSerialPortOutput(project, zone, instance, port=None) 
Returns the specified instance's serial port output.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance scoping this request. (required)
  port: integer, Specifies which COM or serial port to retrieve data from.

Returns:
  An object of the form:

    { # An instance's serial console output.
    "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
    "contents": "A String", # [Output Only] 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, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance resource.
  "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
  "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
  "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
  "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  "zone": "A String", # [Output Only] URL of the zone where the instance resides.
  "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        #
        # To see the latest fingerprint, make get() request to the instance.
  },
  "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
    { # An instance-attached disk resource.
      "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
          #
          # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
          #
          # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
          #
          # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
          #
          # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
          #
          # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
      "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
      "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
          #
          # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
          #
          # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
        "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
            #
            # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        },
        "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
        "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
        "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
            #
            # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
            #
            # projects/debian-cloud/global/images/family/debian-8
            #
            # Alternatively, use a specific version of a public operating system image:
            #
            # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
            #
            # To create a disk with a private image that you created, specify the image name in the following format:
            #
            # global/images/my-private-image
            #
            # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
            #
            # global/images/family/my-private-family
        "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
            #
            # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
            #
            # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
            # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
            # - projects/project/zones/zone/diskTypes/diskType
            # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
      },
      "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
      "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
      "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
      "licenses": [ # [Output Only] Any valid publicly visible licenses.
        "A String",
      ],
      "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
      "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
      "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
      "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
    },
  ],
  "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
  "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
    "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
    "preemptible": True or False, # Whether the instance is preemptible.
    "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
  },
  "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
      # 
      # zones/us-central1-f/machineTypes/n1-standard-1
      # 
      # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
      # 
      # zones/zone/machineTypes/custom-CPUS-MEMORY
      # 
      # For example: zones/us-central1-f/machineTypes/custom-4-5120
      # 
      # For a full list of restrictions, read the Specifications for custom machine types.
  "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
    { # 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": [ # An 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. Only one interface is supported per instance.
    { # A network interface resource attached to an instance.
      "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
          "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
          "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
          "name": "A String", # Name of this access configuration.
          "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
        },
      ],
      "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
      "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
      "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
          # - regions/region/subnetworks/subnetwork
      "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
          #
          # global/networks/default
          #
          # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
          # - projects/project/global/networks/network
          # - global/networks/default
    },
  ],
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
    "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
    "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
  },
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of instances contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of instances.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of instances.
      { # An Instance resource.
        "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
        "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
        "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
        "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "zone": "A String", # [Output Only] URL of the zone where the instance resides.
        "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
              #
              # To see the latest fingerprint, make get() request to the instance.
        },
        "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
          { # An instance-attached disk resource.
            "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
                #
                # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
                #
                # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
                #
                # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
                #
                # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
              "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
              "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
            },
            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
                #
                # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
                #
                # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
              "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
                  #
                  # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
                "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
                "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
              },
              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
              "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
                  #
                  # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
                  #
                  # projects/debian-cloud/global/images/family/debian-8
                  #
                  # Alternatively, use a specific version of a public operating system image:
                  #
                  # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
                  #
                  # To create a disk with a private image that you created, specify the image name in the following format:
                  #
                  # global/images/my-private-image
                  #
                  # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
                  #
                  # global/images/family/my-private-family
              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
                  #
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
                  #
                  # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
                  # - projects/project/zones/zone/diskTypes/diskType
                  # - zones/zone/diskTypes/diskType  Note that for InstanceTemplate, this is the name of the disk type, not URL.
            },
            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
            "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
            "licenses": [ # [Output Only] Any valid publicly visible licenses.
              "A String",
            ],
            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
            "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
          },
        ],
        "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
        "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
          "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
          "preemptible": True or False, # Whether the instance is preemptible.
          "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
        },
        "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
            #
            # zones/us-central1-f/machineTypes/n1-standard-1
            #
            # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
            #
            # zones/zone/machineTypes/custom-CPUS-MEMORY
            #
            # For example: zones/us-central1-f/machineTypes/custom-4-5120
            #
            # For a full list of restrictions, read the Specifications for custom machine types.
        "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
          { # 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": [ # An 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. Only one interface is supported per instance.
          { # A network interface resource attached to an instance.
            "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is 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. Only one access config per instance is supported.
                "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
                "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
                "name": "A String", # Name of this access configuration.
                "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
              },
            ],
            "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
            "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
            "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
                # - regions/region/subnetworks/subnetwork
            "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
                #
                # global/networks/default
                #
                # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
                # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
                # - projects/project/global/networks/network
                # - global/networks/default
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
        "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
          "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
          "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
        },
      },
    ],
    "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
reset(project, zone, instance) 
Performs a hard reset on the instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setDiskAutoDelete(project, zone, instance, autoDelete, deviceName) 
Sets the auto-delete flag for a disk attached to an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, The instance name. (required)
  autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
  deviceName: string, The device name of the disk to modify. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setMachineType(project, zone, instance, body) 
Changes the machine type for a stopped instance to the machine type specified in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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:

{
    "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setMetadata(project, zone, instance, body) 
Sets metadata for the specified instance to the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
  "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setScheduling(project, zone, instance, body) 
Sets an instance's scheduling options.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Instance name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Sets the scheduling options for an Instance.
  "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
  "preemptible": True or False, # Whether the instance is preemptible.
  "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setTags(project, zone, instance, body) 
Sets tags for the specified instance to the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for 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", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
      # 
      # To see the latest fingerprint, make get() request to the instance.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
start(project, zone, instance) 
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
startWithEncryptionKey(project, zone, instance, body) 
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to start. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
        # 
        # In order to start the instance, the disk url and its corresponding key must be provided.
        # 
        # If the disk is not protected with a customer-supplied encryption key it should not be specified.
      {
        "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
          "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
          "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
        },
        "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
stop(project, zone, instance) 
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  instance: string, Name of the instance resource to stop. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.licenses.html000066400000000000000000000042311300622755700246450ustar00rootroot00000000000000

Compute Engine API . licenses

Instance Methods

get(project, license)

Returns the specified License resource. Get a list of available licenses by making a list() request.

Method Details

get(project, license) 
Returns the specified License resource. Get a list of available licenses by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  license: string, Name of the License resource to return. (required)

Returns:
  An object of the form:

    { # A license resource.
    "chargesUseFee": True or False, # [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.
    "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.
    "name": "A String", # [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.machineTypes.html000066400000000000000000000502531300622755700254760ustar00rootroot00000000000000

Compute Engine API . machineTypes

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of machine types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, machineType)

Returns the specified machine type. Get a list of available machine types by making a list() request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of machine types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of machine types.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped machine type lists.
      "a_key": { # [Output Only] Name of the scope containing this set of machine types.
        "machineTypes": [ # [Output Only] List of machine types contained in this scope.
          { # A Machine Type resource.
            "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
            "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
            "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
            "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
            "description": "A String", # [Output Only] An optional textual description of the resource.
            "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
            "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
            "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
            "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
            "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
              {
                "diskGb": 42, # Size of the scratch disk, defined in GB.
              },
            ],
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
        "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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. Get a list of available machine types by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  machineType: string, Name of the machine type to return. (required)

Returns:
  An object of the form:

    { # A Machine Type resource.
    "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
    "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
    "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
    "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
    "description": "A String", # [Output Only] An optional textual description of the resource.
    "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
    "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
    "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
    "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
      {
        "diskGb": 42, # Size of the scratch disk, defined in GB.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of machine types available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  zone: string, The name of the zone for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of machine types.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Machine Type resources.
      { # A Machine Type resource.
        "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
        "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
        "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
        "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
        "description": "A String", # [Output Only] An optional textual description of the resource.
        "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
        "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
        "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
        "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
          {
            "diskGb": 42, # Size of the scratch disk, defined in GB.
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.networks.html000066400000000000000000000540501300622755700247200ustar00rootroot00000000000000

Compute Engine API . networks

Instance Methods

delete(project, network)

Deletes the specified network.

get(project, network)

Returns the specified network. Get a list of available networks by making a list() request.

insert(project, body)

Creates a network in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of networks 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.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, network) 
Returns the specified network. Get a list of available networks by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  network: string, Name of the network to return. (required)

Returns:
  An object of the form:

    { # Represents a Network resource. Read Networks and Firewalls for more information.
      "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
        "A String",
      ],
      "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
          #
          # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
      "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a network in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Network resource. Read Networks and Firewalls for more information.
    "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
      "A String",
    ],
    "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
        # 
        # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
    "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of networks available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of networks.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Network resources.
      { # Represents a Network resource. Read Networks and Firewalls for more information.
          "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
            "A String",
          ],
          "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
              #
              # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
          "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.projects.html000066400000000000000000000732361300622755700247040ustar00rootroot00000000000000

Compute Engine API . projects

Instance Methods

get(project)

Returns the specified Project resource.

moveDisk(project, body)

Moves a persistent disk from one zone to another.

moveInstance(project, body)

Moves an instance and its attached persistent disks from one zone to another.

setCommonInstanceMetadata(project, body)

Sets metadata common to all instances within the specified project using the data included in the request.

setUsageExportBucket(project, body)

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Method Details

get(project) 
Returns the specified Project resource.

Args:
  project: string, Project ID for this request. (required)

Returns:
  An object of the form:

    { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
    "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
    "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
    "enabledFeatures": [ # Restricted features enabled for use on this project.
      "A String",
    ],
    "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
    },
    "quotas": [ # [Output Only] Quotas assigned to this project.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
    "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
        "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
        "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
      },
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "description": "A String", # An optional textual description of the resource.
  }
moveDisk(project, body) 
Moves a persistent disk from one zone to another.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
        # - projects/project/zones/zone/disks/disk
        # - zones/zone/disks/disk
    "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
        # - projects/project/zones/zone
        # - zones/zone
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
moveInstance(project, body) 
Moves an instance and its attached persistent disks from one zone to another.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
        # - zones/zone/instances/instance
    "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
        # - projects/project/zones/zone
        # - zones/zone
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setCommonInstanceMetadata(project, body) 
Sets metadata common to all instances within the specified project using the data included in the request.

Args:
  project: string, Project ID for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
  "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setUsageExportBucket(project, body) 
Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
    "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
    "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.regionOperations.html000066400000000000000000000400221300622755700263650ustar00rootroot00000000000000

Compute Engine API . regionOperations

Instance Methods

delete(project, region, operation)

Deletes the specified region-specific Operations resource.

get(project, region, operation)

Retrieves the specified region-specific Operations resource.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, region, operation) 
Retrieves the specified region-specific Operations resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.regions.html000066400000000000000000000246721300622755700245210ustar00rootroot00000000000000

Compute Engine API . regions

Instance Methods

get(project, region)

Returns the specified Region resource. Get a list of available regions by making a list() request.

list(project, orderBy=None, 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. Get a list of available regions by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region resource to return. (required)

Returns:
  An object of the form:

    { # Region resource.
    "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
    "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
    "description": "A String", # [Output Only] Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "quotas": [ # [Output Only] Quotas assigned to this region.
      { # A quotas entry.
        "usage": 3.14, # [Output Only] Current usage of this metric.
        "metric": "A String", # [Output Only] Name of the quota metric.
        "limit": 3.14, # [Output Only] Quota limit for this metric.
      },
    ],
    "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of region resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of region resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Region resources.
      { # Region resource.
        "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
        "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "quotas": [ # [Output Only] Quotas assigned to this region.
          { # A quotas entry.
            "usage": 3.14, # [Output Only] Current usage of this metric.
            "metric": "A String", # [Output Only] Name of the quota metric.
            "limit": 3.14, # [Output Only] Quota limit for this metric.
          },
        ],
        "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
          "A String",
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.routers.html000066400000000000000000002155051300622755700245530ustar00rootroot00000000000000

Compute Engine API . routers

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of routers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, router)

Deletes the specified Router resource.

get(project, region, router)

Returns the specified Router resource. Get a list of available routers by making a list() request.

getRouterStatus(project, region, router)

Retrieves runtime information of the specified router.

insert(project, region, body)

Creates a Router resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of Router resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, region, router, body)

Updates the specified Router resource with the data included in the request. This method supports patch semantics.

preview(project, region, router, body)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

update(project, region, router, body)

Updates the specified Router resource with the data included in the request.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of routers.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of routers.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped router lists.
      "a_key": { # Name of the scope containing this set of routers.
        "routers": [ # List of routers contained in this scope.
          { # Router resource.
              "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
                {
                  "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
                  "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
                  "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
                },
              ],
              "bgp": { # BGP information specific to this router.
                "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
              },
              "network": "A String", # URI of the network to which this router belongs.
              "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
                {
                  "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
                  "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
                  "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
                  "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
                  "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
                  "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
                },
              ],
              "region": "A String", # [Output Only] URI of the region where the router resides.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of routers when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#routerAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, router) 
Deletes the specified Router resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, router) 
Returns the specified Router resource. Get a list of available routers by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to return. (required)

Returns:
  An object of the form:

    { # Router resource.
      "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
        {
          "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
          "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
          "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
        },
      ],
      "bgp": { # BGP information specific to this router.
        "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
      },
      "network": "A String", # URI of the network to which this router belongs.
      "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
        {
          "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
          "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
          "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
          "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
          "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
          "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
        },
      ],
      "region": "A String", # [Output Only] URI of the region where the router resides.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getRouterStatus(project, region, router) 
Retrieves runtime information of the specified router.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to query. (required)

Returns:
  An object of the form:

    {
    "kind": "compute#routerStatusResponse", # Type of resource.
    "result": {
      "bgpPeerStatus": [
        {
          "status": "A String", # Status of the BGP peer: {UP, DOWN}
          "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
          "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
          "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
          "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
          "peerIpAddress": "A String", # IP address of the remote BGP interface.
          "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
            { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
                #
                # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
                #
                # Packets that do not match any route in the sending instance's routing table are dropped.
              "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
              "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
              "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
              "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. You can specify this as a full or partial URL. For example:
                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
              "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
              "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
              "network": "A String", # Fully-qualified URL of the network that this route applies to.
              "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
              "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
                {
                  "message": "A String", # [Output Only] A human-readable description of the warning code.
                  "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                  "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                      # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                    {
                      "value": "A String", # [Output Only] A warning data value corresponding to the key.
                      "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                    },
                  ],
                },
              ],
              "destRange": "A String", # The destination range of outgoing packets that this route applies to.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            },
          ],
          "state": "A String", # BGP state as specified in RFC1771.
          "ipAddress": "A String", # IP address of the local BGP interface.
          "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
        },
      ],
      "network": "A String", # URI of the network to which this router belongs.
      "bestRoutes": [ # Best routes for this router's network.
        { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
            #
            # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
            #
            # Packets that do not match any route in the sending instance's routing table are dropped.
          "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
          "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
          "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "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. You can specify this as a full or partial URL. For example:
              # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
          "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
          "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
          "network": "A String", # Fully-qualified URL of the network that this route applies to.
          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
          "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
            {
              "message": "A String", # [Output Only] A human-readable description of the warning code.
              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                  "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                },
              ],
            },
          ],
          "destRange": "A String", # The destination range of outgoing packets that this route applies to.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        },
      ],
    },
  }
insert(project, region, body) 
Creates a Router resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Router resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Router resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of Router resources.
      { # Router resource.
          "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
            {
              "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
              "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
              "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
            },
          ],
          "bgp": { # BGP information specific to this router.
            "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
          },
          "network": "A String", # URI of the network to which this router belongs.
          "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
            {
              "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
              "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
              "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
              "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
              "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
              "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
            },
          ],
          "region": "A String", # [Output Only] URI of the region where the router resides.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, region, router, body) 
Updates the specified Router resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
preview(project, region, router, body) 
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to query. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    {
    "resource": { # Router resource. # Preview of given router.
        "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
          {
            "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
            "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
            "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
          },
        ],
        "bgp": { # BGP information specific to this router.
          "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
        },
        "network": "A String", # URI of the network to which this router belongs.
        "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
          {
            "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
            "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
            "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
            "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
            "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
            "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
          },
        ],
        "region": "A String", # [Output Only] URI of the region where the router resides.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      },
  }
update(project, region, router, body) 
Updates the specified Router resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  router: string, Name of the Router resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Router resource.
    "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
      {
        "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
        "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
        "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "bgp": { # BGP information specific to this router.
      "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
    },
    "network": "A String", # URI of the network to which this router belongs.
    "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
      {
        "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
        "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
        "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
        "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
        "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
        "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
      },
    ],
    "region": "A String", # [Output Only] URI of the region where the router resides.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.routes.html000066400000000000000000000733501300622755700243710ustar00rootroot00000000000000

Compute Engine API . routes

Instance Methods

delete(project, route)

Deletes the specified Route resource.

get(project, route)

Returns the specified Route resource. Get a list of available routes by making a list() request.

insert(project, body)

Creates a Route resource in the specified project using the data included in the request.

list(project, orderBy=None, 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, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, route) 
Returns the specified Route resource. Get a list of available routes by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  route: string, Name of the Route resource to return. (required)

Returns:
  An object of the form:

    { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
      #
      # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
      #
      # Packets that do not match any route in the sending instance's routing table are dropped.
    "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
    "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
    "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "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. You can specify this as a full or partial URL. For example:
        # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
    "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
    "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
    "network": "A String", # Fully-qualified URL of the network that this route applies to.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "destRange": "A String", # The destination range of outgoing packets that this route applies to.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  }
insert(project, body) 
Creates a Route resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
    # 
    # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
    # 
    # Packets that do not match any route in the sending instance's routing table are dropped.
  "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
  "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
  "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
  "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  "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. You can specify this as a full or partial URL. For example:
      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
  "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
  "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
  "network": "A String", # Fully-qualified URL of the network that this route applies to.
  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
  "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    {
      "message": "A String", # [Output Only] A human-readable description of the warning code.
      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
        {
          "value": "A String", # [Output Only] A warning data value corresponding to the key.
          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
        },
      ],
    },
  ],
  "destRange": "A String", # The destination range of outgoing packets that this route applies to.
  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
}


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Route resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Route resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Route resources.
      { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
          #
          # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
          #
          # Packets that do not match any route in the sending instance's routing table are dropped.
        "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
        "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
        "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
        "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "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. You can specify this as a full or partial URL. For example:
            # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
        "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
        "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
        "network": "A String", # Fully-qualified URL of the network that this route applies to.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "destRange": "A String", # The destination range of outgoing packets that this route applies to.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      },
    ],
    "kind": "compute#routeList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.snapshots.html000066400000000000000000000465771300622755700251050ustar00rootroot00000000000000

Compute Engine API . snapshots

Instance Methods

delete(project, snapshot)

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

get(project, snapshot)

Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of 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 Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snaphots.

Args:
  project: string, Project ID for this request. (required)
  snapshot: string, Name of the Snapshot resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, snapshot) 
Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  snapshot: string, Name of the Snapshot resource to return. (required)

Returns:
  An object of the form:

    { # A persistent disk snapshot resource.
      "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
      "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
      "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
      "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
          #
          # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
          #
          # Customer-supplied encryption keys do not protect access to metadata of the disk.
          #
          # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
        "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
        "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      },
      "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
      "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
      "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Snapshot resources contained within the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Snapshot resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Snapshot resources.
      { # A persistent disk snapshot resource.
          "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
          "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
          "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
          "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
              #
              # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
              #
              # Customer-supplied encryption keys do not protect access to metadata of the disk.
              #
              # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
            "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
            "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
          },
          "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
          "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
          "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#snapshotList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.sslCertificates.html000066400000000000000000000514341300622755700261760ustar00rootroot00000000000000

Compute Engine API . sslCertificates

Instance Methods

delete(project, sslCertificate)

Deletes the specified SslCertificate resource.

get(project, sslCertificate)

Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

insert(project, body)

Creates a SslCertificate resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of SslCertificate resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(project, sslCertificate) 
Deletes the specified SslCertificate resource.

Args:
  project: string, Project ID for this request. (required)
  sslCertificate: string, Name of the SslCertificate resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, sslCertificate) 
Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  sslCertificate: string, Name of the SslCertificate resource to return. (required)

Returns:
  An object of the form:

    { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
      "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
      "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output only] Server-defined URL for the resource.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    }
insert(project, body) 
Creates a SslCertificate resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
    "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
    "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output only] Server-defined URL for the resource.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of SslCertificate resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of SslCertificate resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of SslCertificate resources.
      { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
          "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
          "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
          "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output only] Server-defined URL for the resource.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        },
    ],
    "kind": "compute#sslCertificateList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.subnetworks.html000066400000000000000000000722331300622755700254350ustar00rootroot00000000000000

Compute Engine API . subnetworks

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of subnetworks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, subnetwork)

Deletes the specified subnetwork.

get(project, region, subnetwork)

Returns the specified subnetwork. Get a list of available subnetworks list() request.

insert(project, region, body)

Creates a subnetwork in the specified project using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of subnetworks available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of subnetworks.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output] A map of scoped Subnetwork lists.
      "a_key": { # Name of the scope containing this set of Subnetworks.
        "subnetworks": [ # List of subnetworks contained in this scope.
          { # A Subnetwork resource.
              "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "region": "A String", # URL of the region where the Subnetwork resides.
              "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
              "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
              "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # An informational warning that appears when the list of addresses is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, subnetwork) 
Deletes the specified subnetwork.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, subnetwork) 
Returns the specified subnetwork. Get a list of available subnetworks list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  subnetwork: string, Name of the Subnetwork resource to return. (required)

Returns:
  An object of the form:

    { # A Subnetwork resource.
      "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "region": "A String", # URL of the region where the Subnetwork resides.
      "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
      "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
      "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a subnetwork in the specified project using the data included in the request.

Args:
  project: string, Project ID for 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 Subnetwork resource.
    "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "region": "A String", # URL of the region where the Subnetwork resides.
    "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
    "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
    "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of subnetworks available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Subnetwork resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # The Subnetwork resources.
      { # A Subnetwork resource.
          "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "region": "A String", # URL of the region where the Subnetwork resides.
          "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
          "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
          "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.targetHttpProxies.html000066400000000000000000000623451300622755700265520ustar00rootroot00000000000000

Compute Engine API . targetHttpProxies

Instance Methods

delete(project, targetHttpProxy)

Deletes the specified TargetHttpProxy resource.

get(project, targetHttpProxy)

Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

insert(project, body)

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetHttpProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setUrlMap(project, targetHttpProxy, body)

Changes the URL map for TargetHttpProxy.

Method Details

delete(project, targetHttpProxy) 
Deletes the specified TargetHttpProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetHttpProxy) 
Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
      "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetHttpProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
    "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetHttpProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A list of TargetHttpProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetHttpProxy resources.
      { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
          "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setUrlMap(project, targetHttpProxy, body) 
Changes the URL map for TargetHttpProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "urlMap": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.targetHttpsProxies.html000066400000000000000000001005111300622755700267210ustar00rootroot00000000000000

Compute Engine API . targetHttpsProxies

Instance Methods

delete(project, targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

get(project, targetHttpsProxy)

Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

insert(project, body)

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetHttpsProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setSslCertificates(project, targetHttpsProxy, body)

Replaces SslCertificates for TargetHttpsProxy.

setUrlMap(project, targetHttpsProxy, body)

Changes the URL map for TargetHttpsProxy.

Method Details

delete(project, targetHttpsProxy) 
Deletes the specified TargetHttpsProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetHttpsProxy) 
Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
      "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
        "A String",
      ],
      "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
          # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
          # - projects/project/global/urlMaps/url-map
          # - global/urlMaps/url-map
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
    "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
      "A String",
    ],
    "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
        # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
        # - projects/project/global/urlMaps/url-map
        # - global/urlMaps/url-map
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetHttpsProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetHttpsProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetHttpsProxy resources.
      { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
          "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
            "A String",
          ],
          "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
              # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
              # - projects/project/global/urlMaps/url-map
              # - global/urlMaps/url-map
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setSslCertificates(project, targetHttpsProxy, body) 
Replaces SslCertificates for TargetHttpsProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setUrlMap(project, targetHttpsProxy, body) 
Changes the URL map for TargetHttpsProxy.

Args:
  project: string, Project ID for this request. (required)
  targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "urlMap": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.targetInstances.html000066400000000000000000000732671300622755700262150ustar00rootroot00000000000000

Compute Engine API . targetInstances

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target instances.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, targetInstance)

Deletes the specified TargetInstance resource.

get(project, zone, targetInstance)

Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

insert(project, zone, body)

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of TargetInstance resources available to the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target instances.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped target instance lists.
      "a_key": { # Name of the scope containing this set of target instances.
        "targetInstances": [ # List of target instances contained in this scope.
          { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
              "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
              "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
              "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
                  # - projects/project/zones/zone/instances/instance
                  # - zones/zone/instances/instance
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#targetInstanceAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, zone, targetInstance) 
Deletes the specified TargetInstance resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  targetInstance: string, Name of the TargetInstance resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, zone, targetInstance) 
Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  targetInstance: string, Name of the TargetInstance resource to return. (required)

Returns:
  An object of the form:

    { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
      "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
      "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
      "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
          # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
          # - projects/project/zones/zone/instances/instance
          # - zones/zone/instances/instance
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, zone, body) 
Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Args:
  project: string, Project ID for 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 TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
    "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
    "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
    "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
        # - projects/project/zones/zone/instances/instance
        # - zones/zone/instances/instance
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of TargetInstance resources available to the specified project and zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetInstance resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetInstance resources.
      { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
          "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
          "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
          "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
              # - projects/project/zones/zone/instances/instance
              # - zones/zone/instances/instance
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetInstanceList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.targetPools.html000066400000000000000000002073541300622755700253560ustar00rootroot00000000000000

Compute Engine API . targetPools

Instance Methods

addHealthCheck(project, region, targetPool, body)

Adds health check URLs to a target pool.

addInstance(project, region, targetPool, body)

Adds an instance to a target pool.

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target pools.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetPool)

Deletes the specified target pool.

get(project, region, targetPool)

Returns the specified target pool. Get a list of available target pools by making a list() request.

getHealth(project, region, targetPool, body)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

insert(project, region, body)

Creates a target pool in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of target pools available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeHealthCheck(project, region, targetPool, body)

Removes health check URL from a target pool.

removeInstance(project, region, targetPool, body)

Removes instance URL from a target pool.

setBackup(project, region, targetPool, body, failoverRatio=None)

Changes a backup target pool's configurations.

Method Details

addHealthCheck(project, region, targetPool, body) 
Adds health check URLs to a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the target pool to add a health check to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
          # - projects/project-id/global/httpHealthChecks/health-check
          # - global/httpHealthChecks/health-check
        "healthCheck": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
addInstance(project, region, targetPool, body) 
Adds an instance to a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to add instances to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
        # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
        # - projects/project-id/zones/zone/instances/instance-name
        # - zones/zone/instances/instance-name
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target pools.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped target pool lists.
      "a_key": { # Name of the scope containing this set of target pools.
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
        "targetPools": [ # List of target pools contained in this scope.
          { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
              "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
                  #
                  # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
                  #
                  # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "region": "A String", # [Output Only] URL of the region where the target pool resides.
              "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
              "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
                  # NONE: Connections from the same client IP may go to any instance in the pool.
                  # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
                  # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
              "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
                "A String",
              ],
              "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
                  #
                  # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
                  #
                  # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
              "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
                "A String",
              ],
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
      },
    },
    "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, targetPool) 
Deletes the specified target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, targetPool) 
Returns the specified target pool. Get a list of available target pools by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to return. (required)

Returns:
  An object of the form:

    { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
      "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
          #
          # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
          #
          # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "region": "A String", # [Output Only] URL of the region where the target pool resides.
      "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
      "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
          # NONE: Connections from the same client IP may go to any instance in the pool.
          # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
          # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
      "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
        "A String",
      ],
      "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
          #
          # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
          #
          # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
      "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getHealth(project, region, targetPool, body) 
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  "instance": "A String", # The URL for a specific instance.
}


Returns:
  An object of the form:

    {
    "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
    "healthStatus": [
      {
        "instance": "A String", # URL of the instance resource.
        "healthState": "A String", # Health state of the instance.
        "ipAddress": "A String", # The IP address represented by this resource.
        "port": 42, # The port on the instance.
      },
    ],
  }
insert(project, region, body) 
Creates a target pool in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for 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 TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
    "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
        # 
        # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
        # 
        # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "region": "A String", # [Output Only] URL of the region where the target pool resides.
    "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
    "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
        # NONE: Connections from the same client IP may go to any instance in the pool.
        # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
        # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
    "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
      "A String",
    ],
    "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
        # 
        # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
        # 
        # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
    "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of target pools available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetPool resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetPool resources.
      { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
          "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
              #
              # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
              #
              # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "region": "A String", # [Output Only] URL of the region where the target pool resides.
          "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
          "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
              # NONE: Connections from the same client IP may go to any instance in the pool.
              # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
              # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
          "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
            "A String",
          ],
          "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
              #
              # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
              #
              # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
          "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
removeHealthCheck(project, region, targetPool, body) 
Removes health check URL from a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetPool: string, Name of the target pool to remove health checks from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
        # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
        # - projects/project/global/httpHealthChecks/health-check
        # - global/httpHealthChecks/health-check
      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
          # - projects/project-id/global/httpHealthChecks/health-check
          # - global/httpHealthChecks/health-check
        "healthCheck": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
removeInstance(project, region, targetPool, body) 
Removes instance URL from a target pool.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to remove instances from. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # URLs of the instances to be removed from target pool.
      {
        "instance": "A String", # The URL for a specific instance.
      },
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setBackup(project, region, targetPool, body, failoverRatio=None) 
Changes a backup target pool's configurations.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "target": "A String",
  }

  failoverRatio: number, New failoverRatio value for the target pool.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.targetSslProxies.html000066400000000000000000001122021300622755700263600ustar00rootroot00000000000000

Compute Engine API . targetSslProxies

Instance Methods

delete(project, targetSslProxy)

Deletes the specified TargetSslProxy resource.

get(project, targetSslProxy)

Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

insert(project, body)

Creates a TargetSslProxy resource in the specified project using the data included in the request.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of TargetSslProxy resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setBackendService(project, targetSslProxy, body)

Changes the BackendService for TargetSslProxy.

setProxyHeader(project, targetSslProxy, body)

Changes the ProxyHeaderType for TargetSslProxy.

setSslCertificates(project, targetSslProxy, body)

Changes SslCertificates for TargetSslProxy.

Method Details

delete(project, targetSslProxy) 
Deletes the specified TargetSslProxy resource.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, targetSslProxy) 
Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)

Returns:
  An object of the form:

    { # A TargetSslProxy resource. This resource defines an SSL proxy.
      "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "service": "A String", # URL to the BackendService resource.
      "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
        "A String",
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a TargetSslProxy resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A TargetSslProxy resource. This resource defines an SSL proxy.
    "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "service": "A String", # URL to the BackendService resource.
    "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
      "A String",
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of TargetSslProxy resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetSslProxy resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of TargetSslProxy resources.
      { # A TargetSslProxy resource. This resource defines an SSL proxy.
          "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "service": "A String", # URL to the BackendService resource.
          "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
            "A String",
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetSslProxyList", # Type of resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
setBackendService(project, targetSslProxy, body) 
Changes the BackendService for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setProxyHeader(project, targetSslProxy, body) 
Changes the ProxyHeaderType for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setSslCertificates(project, targetSslProxy, body) 
Changes SslCertificates for TargetSslProxy.

Args:
  project: string, Project ID for this request. (required)
  targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.targetVpnGateways.html000066400000000000000000000732471300622755700265340ustar00rootroot00000000000000

Compute Engine API . targetVpnGateways

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of target VPN gateways.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetVpnGateway)

Deletes the specified target VPN gateway.

get(project, region, targetVpnGateway)

Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

insert(project, region, body)

Creates a target VPN gateway in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of target VPN gateways available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of target VPN gateways.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # A map of scoped target vpn gateway lists.
      "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
        "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
          { # Represents a Target VPN gateway resource.
              "status": "A String", # [Output Only] The status of the VPN gateway.
              "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
                "A String",
              ],
              "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
              "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
                "A String",
              ],
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
              "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, targetVpnGateway) 
Deletes the specified target VPN gateway.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetVpnGateway: string, Name of the target VPN gateway to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, targetVpnGateway) 
Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  targetVpnGateway: string, Name of the target VPN gateway to return. (required)

Returns:
  An object of the form:

    { # Represents a Target VPN gateway resource.
      "status": "A String", # [Output Only] The status of the VPN gateway.
      "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
        "A String",
      ],
      "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
      "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
        "A String",
      ],
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a target VPN gateway in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Target VPN gateway resource.
    "status": "A String", # [Output Only] The status of the VPN gateway.
    "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
      "A String",
    ],
    "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
    "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
      "A String",
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of target VPN gateways available to the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of TargetVpnGateway resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of TargetVpnGateway resources.
      { # Represents a Target VPN gateway resource.
          "status": "A String", # [Output Only] The status of the VPN gateway.
          "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
            "A String",
          ],
          "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
          "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
            "A String",
          ],
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.urlMaps.html000066400000000000000000001676701300622755700245040ustar00rootroot00000000000000

Compute Engine API . urlMaps

Instance Methods

delete(project, urlMap)

Deletes the specified UrlMap resource.

get(project, urlMap)

Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

insert(project, body)

Creates a UrlMap resource in the specified project using the data included in the request.

invalidateCache(project, urlMap, body)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves the list of UrlMap resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, urlMap, body)

Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.

update(project, urlMap, body)

Updates the specified UrlMap resource with the data included in the request.

validate(project, urlMap, body)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Method Details

delete(project, urlMap) 
Deletes the specified UrlMap resource.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, urlMap) 
Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to return. (required)

Returns:
  An object of the form:

    { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
      "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
      "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
        { # Message for the expected URL mappings.
          "path": "A String", # Path portion of the URL.
          "host": "A String", # Host portion of the URL.
          "description": "A String", # Description of this test case.
          "service": "A String", # Expected BackendService resource the given URL should be mapped to.
        },
      ],
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
      "pathMatchers": [ # The list of named PathMatchers to use against the URL.
        { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
          "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
              # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
              # - compute/v1/projects/project/global/backendServices/backendService
              # - global/backendServices/backendService
          "pathRules": [ # The list of path rules.
            { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
              "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                "A String",
              ],
              "service": "A String", # The URL of the BackendService resource if this rule is matched.
            },
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
        },
      ],
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "hostRules": [ # The list of HostRules to use against the URL.
        { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
          "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
            "A String",
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
        },
      ],
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, body) 
Creates a UrlMap resource in the specified project using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
invalidateCache(project, urlMap, body) 
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap scoping this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "path": "A String",
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of UrlMap resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of UrlMap resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # A list of UrlMap resources.
      { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
          "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
          "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
            { # Message for the expected URL mappings.
              "path": "A String", # Path portion of the URL.
              "host": "A String", # Host portion of the URL.
              "description": "A String", # Description of this test case.
              "service": "A String", # Expected BackendService resource the given URL should be mapped to.
            },
          ],
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
          "pathMatchers": [ # The list of named PathMatchers to use against the URL.
            { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
              "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
                  # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
                  # - compute/v1/projects/project/global/backendServices/backendService
                  # - global/backendServices/backendService
              "pathRules": [ # The list of path rules.
                { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
                  "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                    "A String",
                  ],
                  "service": "A String", # The URL of the BackendService resource if this rule is matched.
                },
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
            },
          ],
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "hostRules": [ # The list of HostRules to use against the URL.
            { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
              "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
                "A String",
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
            },
          ],
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#urlMapList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
patch(project, urlMap, body) 
Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
update(project, urlMap, body) 
Updates the specified UrlMap resource with the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
    "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
      { # Message for the expected URL mappings.
        "path": "A String", # Path portion of the URL.
        "host": "A String", # Host portion of the URL.
        "description": "A String", # Description of this test case.
        "service": "A String", # Expected BackendService resource the given URL should be mapped to.
      },
    ],
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
    "pathMatchers": [ # The list of named PathMatchers to use against the URL.
      { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
        "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
            # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
            # - compute/v1/projects/project/global/backendServices/backendService
            # - global/backendServices/backendService
        "pathRules": [ # The list of path rules.
          { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
            "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
              "A String",
            ],
            "service": "A String", # The URL of the BackendService resource if this rule is matched.
          },
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
      },
    ],
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "hostRules": [ # The list of HostRules to use against the URL.
      { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
        "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
          "A String",
        ],
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
      },
    ],
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
validate(project, urlMap, body) 
Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Args:
  project: string, Project ID for this request. (required)
  urlMap: string, Name of the UrlMap resource to be validated as. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
        "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
        "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
          { # Message for the expected URL mappings.
            "path": "A String", # Path portion of the URL.
            "host": "A String", # Host portion of the URL.
            "description": "A String", # Description of this test case.
            "service": "A String", # Expected BackendService resource the given URL should be mapped to.
          },
        ],
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
        "pathMatchers": [ # The list of named PathMatchers to use against the URL.
          { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
            "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
                # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
                # - compute/v1/projects/project/global/backendServices/backendService
                # - global/backendServices/backendService
            "pathRules": [ # The list of path rules.
              { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
                "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
                  "A String",
                ],
                "service": "A String", # The URL of the BackendService resource if this rule is matched.
              },
            ],
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "hostRules": [ # The list of HostRules to use against the URL.
          { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
            "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
              "A String",
            ],
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
          },
        ],
        "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      },
  }


Returns:
  An object of the form:

    {
    "result": { # Message representing the validation result for a UrlMap.
      "testFailures": [
        {
          "path": "A String",
          "actualService": "A String",
          "host": "A String",
          "expectedService": "A String",
        },
      ],
      "loadErrors": [
        "A String",
      ],
      "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
      "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
    },
  }
google-api-python-client-1.5.5/docs/dyn/compute_v1.vpnTunnels.html000066400000000000000000001001161300622755700252130ustar00rootroot00000000000000

Compute Engine API . vpnTunnels

Instance Methods

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves an aggregated list of VPN tunnels.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, vpnTunnel)

Deletes the specified VpnTunnel resource.

get(project, region, vpnTunnel)

Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

insert(project, region, body)

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves an aggregated list of VPN tunnels.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": { # [Output Only] A map of scoped vpn tunnel lists.
      "a_key": { # Name of the scope containing this set of vpn tunnels.
        "vpnTunnels": [ # List of vpn tunnels contained in this scope.
          {
              "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
              "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
              "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
              "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
                "A String",
              ],
              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
              "peerIp": "A String", # IP address of the peer VPN gateway.
              "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
              "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
                "A String",
              ],
              "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
              "status": "A String", # [Output Only] The status of the VPN tunnel.
              "sharedSecretHash": "A String", # Hash of the shared secret.
              "router": "A String", # URL of router resource to be used for dynamic routing.
              "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
              "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            },
        ],
        "warning": { # Informational warning which replaces the list of addresses when the list is empty.
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      },
    },
    "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
  }
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, vpnTunnel) 
Deletes the specified VpnTunnel resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, region, vpnTunnel) 
Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  vpnTunnel: string, Name of the VpnTunnel resource to return. (required)

Returns:
  An object of the form:

    {
      "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
      "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
      "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
      "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
        "A String",
      ],
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "peerIp": "A String", # IP address of the peer VPN gateway.
      "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
      "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
        "A String",
      ],
      "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
      "status": "A String", # [Output Only] The status of the VPN tunnel.
      "sharedSecretHash": "A String", # Hash of the shared secret.
      "router": "A String", # URL of router resource to be used for dynamic routing.
      "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
insert(project, region, body) 
Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
    "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
    "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
      "A String",
    ],
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "peerIp": "A String", # IP address of the peer VPN gateway.
    "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
    "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
      "A String",
    ],
    "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    "status": "A String", # [Output Only] The status of the VPN tunnel.
    "sharedSecretHash": "A String", # Hash of the shared secret.
    "router": "A String", # URL of router resource to be used for dynamic routing.
    "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of VpnTunnel resources contained in the specified project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of VpnTunnel resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of VpnTunnel resources.
      {
          "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
          "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
          "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
          "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
            "A String",
          ],
          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          "peerIp": "A String", # IP address of the peer VPN gateway.
          "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
          "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
            "A String",
          ],
          "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
          "status": "A String", # [Output Only] The status of the VPN tunnel.
          "sharedSecretHash": "A String", # Hash of the shared secret.
          "router": "A String", # URL of router resource to be used for dynamic routing.
          "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
    "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.zoneOperations.html000066400000000000000000000377451300622755700260770ustar00rootroot00000000000000

Compute Engine API . zoneOperations

Instance Methods

delete(project, zone, operation)

Deletes the specified zone-specific Operations resource.

get(project, zone, operation)

Retrieves the specified zone-specific Operations resource.

list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)

Retrieves a 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 Operations resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  operation: string, Name of the Operations resource to delete. (required)
get(project, zone, operation) 
Retrieves the specified zone-specific Operations resource.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. (required)
  operation: string, Name of the Operations resource to return. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves a list of Operation resources contained within the specified zone.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of Operation resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Operation resources.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
    "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/compute_v1.zones.html000066400000000000000000000231331300622755700242000ustar00rootroot00000000000000

Compute Engine API . zones

Instance Methods

get(project, zone)

Returns the specified Zone resource. Get a list of available zones by making a list() request.

list(project, orderBy=None, 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. Get a list of available zones by making a list() request.

Args:
  project: string, Project ID for 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", # [Output Only] Status of the zone, either UP or DOWN.
    "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
    "description": "A String", # [Output Only] Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
    },
    "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "name": "A String", # [Output Only] Name of the resource.
  }
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Zone resources available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # Contains a list of zone resources.
    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    "items": [ # [Output Only] A list of Zone resources.
      { # A Zone resource.
        "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
        "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      },
    ],
    "kind": "compute#zoneList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server-defined URL for 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.
google-api-python-client-1.5.5/docs/dyn/consumersurveys_v2.html000066400000000000000000000046601300622755700246700ustar00rootroot00000000000000

Consumer Surveys API

Instance Methods

mobileapppanels()

Returns the mobileapppanels Resource.

results()

Returns the results Resource.

surveys()

Returns the surveys Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/consumersurveys_v2.mobileapppanels.html000066400000000000000000000177261300622755700300510ustar00rootroot00000000000000

Consumer Surveys API . mobileapppanels

Instance Methods

get(panelId)

Retrieves a MobileAppPanel that is available to the authenticated user.

list(startIndex=None, maxResults=None, token=None)

Lists the MobileAppPanels available to the authenticated user.

update(panelId, body)

Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.

Method Details

get(panelId) 
Retrieves a MobileAppPanel that is available to the authenticated user.

Args:
  panelId: string, External URL ID for the panel. (required)

Returns:
  An object of the form:

    { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
    "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
      "A String",
    ],
    "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
    "name": "A String", # Human readable name of the audience panel.
    "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
    "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
    "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
  }
list(startIndex=None, maxResults=None, token=None) 
Lists the MobileAppPanels available to the authenticated user.

Args:
  startIndex: integer, A parameter
  maxResults: integer, A parameter
  token: string, A parameter

Returns:
  An object of the form:

    {
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "resources": [ # An individual predefined panel of Opinion Rewards mobile users.
      { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
        "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
          "A String",
        ],
        "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
        "name": "A String", # Human readable name of the audience panel.
        "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
        "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
        "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
      },
    ],
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
update(panelId, body) 
Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.

Args:
  panelId: string, External URL ID for the panel. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
  "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
    "A String",
  ],
  "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
  "name": "A String", # Human readable name of the audience panel.
  "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
  "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
  "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
}


Returns:
  An object of the form:

    { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
    "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
      "A String",
    ],
    "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
    "name": "A String", # Human readable name of the audience panel.
    "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
    "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
    "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
  }
google-api-python-client-1.5.5/docs/dyn/consumersurveys_v2.results.html000066400000000000000000000052371300622755700263710ustar00rootroot00000000000000

Consumer Surveys API . results

Instance Methods

get(surveyUrlId)

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

get_media(surveyUrlId)

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Method Details

get(surveyUrlId) 
Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  An object of the form:

    { # Reference to the current results for a given survey.
    "status": "A String", # Human readable string describing the status of the request.
    "surveyUrlId": "A String", # External survey ID as viewable by survey owners in the editor view.
  }
get_media(surveyUrlId) 
Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/consumersurveys_v2.surveys.html000066400000000000000000002114201300622755700264010ustar00rootroot00000000000000

Consumer Surveys API . surveys

Instance Methods

delete(surveyUrlId)

Removes a survey from view in all user GET requests.

get(surveyUrlId)

Retrieves information about the specified survey.

insert(body)

Creates a survey.

list(startIndex=None, maxResults=None, token=None)

Lists the surveys owned by the authenticated user.

start(resourceId, body)

Begins running a survey.

stop(resourceId)

Stops a running survey.

update(surveyUrlId, body)

Updates a survey. Currently the only property that can be updated is the owners property.

Method Details

delete(surveyUrlId) 
Removes a survey from view in all user GET requests.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  An object of the form:

    {
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
get(surveyUrlId) 
Retrieves information about the specified survey.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  An object of the form:

    { # Representation of an individual survey object.
      "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
        "A String",
      ],
      "description": "A String", # Text description of the survey.
      "title": "A String", # Optional name that will be given to the survey.
      "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
      "state": "A String", # State that the survey is in.
      "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
        "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
        "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
        "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
        "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
          "A String",
        ],
        "populationSource": "A String", # Online population source where the respondents are sampled from.
        "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
          "A String",
        ],
        "gender": "A String", # Optional gender to target.
      },
      "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
        "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
        "currencyCode": "A String", # Currency code that the cost is given in.
        "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
        "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
      },
      "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
      "questions": [ # List of questions defining the survey.
        { # Message defining the question specifications.
          "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
          "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
          "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
            "A String",
          ],
          "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
          "question": "A String", # Required question text shown to the respondent.
          "numStars": "A String", # Number of stars to use for ratings questions.
          "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
          "videoId": "A String", # The YouTube video ID to be show in video questions.
          "answers": [ # Required list of answer options for a question.
            "A String",
          ],
          "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
          "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
          "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
          "images": [
            { # Container object for image data and alt_text.
              "url": "A String", # The read-only URL for the hosted images.
              "altText": "A String", # The alt text property used in image tags is required for all images.
              "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
            },
          ],
          "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
          "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
            "A String",
          ],
          "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
          "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
          "openTextPlaceholder": "A String", # Placeholder text for an open text question.
        },
      ],
      "wantedResponseCount": 42, # Number of responses desired for the survey.
      "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
        "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
        "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
      },
    }
insert(body) 
Creates a survey.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of an individual survey object.
    "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
      "A String",
    ],
    "description": "A String", # Text description of the survey.
    "title": "A String", # Optional name that will be given to the survey.
    "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
    "state": "A String", # State that the survey is in.
    "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
      "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
      "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
      "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
      "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
        "A String",
      ],
      "populationSource": "A String", # Online population source where the respondents are sampled from.
      "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
        "A String",
      ],
      "gender": "A String", # Optional gender to target.
    },
    "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
      "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
      "currencyCode": "A String", # Currency code that the cost is given in.
      "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
      "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
    },
    "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
    "questions": [ # List of questions defining the survey.
      { # Message defining the question specifications.
        "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
        "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
        "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
          "A String",
        ],
        "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
        "question": "A String", # Required question text shown to the respondent.
        "numStars": "A String", # Number of stars to use for ratings questions.
        "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
        "videoId": "A String", # The YouTube video ID to be show in video questions.
        "answers": [ # Required list of answer options for a question.
          "A String",
        ],
        "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
        "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
        "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
        "images": [
          { # Container object for image data and alt_text.
            "url": "A String", # The read-only URL for the hosted images.
            "altText": "A String", # The alt text property used in image tags is required for all images.
            "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
          },
        ],
        "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
        "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
          "A String",
        ],
        "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
        "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
        "openTextPlaceholder": "A String", # Placeholder text for an open text question.
      },
    ],
    "wantedResponseCount": 42, # Number of responses desired for the survey.
    "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
      "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
      "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
    },
  }


Returns:
  An object of the form:

    { # Representation of an individual survey object.
      "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
        "A String",
      ],
      "description": "A String", # Text description of the survey.
      "title": "A String", # Optional name that will be given to the survey.
      "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
      "state": "A String", # State that the survey is in.
      "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
        "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
        "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
        "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
        "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
          "A String",
        ],
        "populationSource": "A String", # Online population source where the respondents are sampled from.
        "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
          "A String",
        ],
        "gender": "A String", # Optional gender to target.
      },
      "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
        "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
        "currencyCode": "A String", # Currency code that the cost is given in.
        "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
        "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
      },
      "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
      "questions": [ # List of questions defining the survey.
        { # Message defining the question specifications.
          "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
          "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
          "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
            "A String",
          ],
          "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
          "question": "A String", # Required question text shown to the respondent.
          "numStars": "A String", # Number of stars to use for ratings questions.
          "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
          "videoId": "A String", # The YouTube video ID to be show in video questions.
          "answers": [ # Required list of answer options for a question.
            "A String",
          ],
          "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
          "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
          "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
          "images": [
            { # Container object for image data and alt_text.
              "url": "A String", # The read-only URL for the hosted images.
              "altText": "A String", # The alt text property used in image tags is required for all images.
              "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
            },
          ],
          "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
          "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
            "A String",
          ],
          "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
          "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
          "openTextPlaceholder": "A String", # Placeholder text for an open text question.
        },
      ],
      "wantedResponseCount": 42, # Number of responses desired for the survey.
      "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
        "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
        "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
      },
    }
list(startIndex=None, maxResults=None, token=None) 
Lists the surveys owned by the authenticated user.

Args:
  startIndex: integer, A parameter
  maxResults: integer, A parameter
  token: string, A parameter

Returns:
  An object of the form:

    {
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "resources": [ # An individual survey resource.
      { # Representation of an individual survey object.
          "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
            "A String",
          ],
          "description": "A String", # Text description of the survey.
          "title": "A String", # Optional name that will be given to the survey.
          "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
          "state": "A String", # State that the survey is in.
          "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
            "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
            "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
            "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
            "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
              "A String",
            ],
            "populationSource": "A String", # Online population source where the respondents are sampled from.
            "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
              "A String",
            ],
            "gender": "A String", # Optional gender to target.
          },
          "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
            "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
            "currencyCode": "A String", # Currency code that the cost is given in.
            "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
            "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
          },
          "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
          "questions": [ # List of questions defining the survey.
            { # Message defining the question specifications.
              "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
              "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
              "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
                "A String",
              ],
              "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
              "question": "A String", # Required question text shown to the respondent.
              "numStars": "A String", # Number of stars to use for ratings questions.
              "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
              "videoId": "A String", # The YouTube video ID to be show in video questions.
              "answers": [ # Required list of answer options for a question.
                "A String",
              ],
              "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
              "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
              "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
              "images": [
                { # Container object for image data and alt_text.
                  "url": "A String", # The read-only URL for the hosted images.
                  "altText": "A String", # The alt text property used in image tags is required for all images.
                  "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
                },
              ],
              "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
              "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
                "A String",
              ],
              "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
              "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
              "openTextPlaceholder": "A String", # Placeholder text for an open text question.
            },
          ],
          "wantedResponseCount": 42, # Number of responses desired for the survey.
          "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
            "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
            "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
          },
        },
    ],
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
start(resourceId, body) 
Begins running a survey.

Args:
  resourceId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "maxCostPerResponseNanos": "A String", # Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details.
  }


Returns:
  An object of the form:

    {
    "resource": { # Representation of an individual survey object. # Survey object containing the specification of the started Survey.
        "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
          "A String",
        ],
        "description": "A String", # Text description of the survey.
        "title": "A String", # Optional name that will be given to the survey.
        "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
        "state": "A String", # State that the survey is in.
        "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
          "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
          "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
          "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
          "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
            "A String",
          ],
          "populationSource": "A String", # Online population source where the respondents are sampled from.
          "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
            "A String",
          ],
          "gender": "A String", # Optional gender to target.
        },
        "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
          "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
          "currencyCode": "A String", # Currency code that the cost is given in.
          "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
          "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
        },
        "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
        "questions": [ # List of questions defining the survey.
          { # Message defining the question specifications.
            "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
            "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
            "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
              "A String",
            ],
            "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
            "question": "A String", # Required question text shown to the respondent.
            "numStars": "A String", # Number of stars to use for ratings questions.
            "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
            "videoId": "A String", # The YouTube video ID to be show in video questions.
            "answers": [ # Required list of answer options for a question.
              "A String",
            ],
            "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
            "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
            "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
            "images": [
              { # Container object for image data and alt_text.
                "url": "A String", # The read-only URL for the hosted images.
                "altText": "A String", # The alt text property used in image tags is required for all images.
                "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
              },
            ],
            "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
            "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
              "A String",
            ],
            "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
            "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
            "openTextPlaceholder": "A String", # Placeholder text for an open text question.
          },
        ],
        "wantedResponseCount": 42, # Number of responses desired for the survey.
        "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
          "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
          "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
        },
      },
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
stop(resourceId) 
Stops a running survey.

Args:
  resourceId: string, A parameter (required)

Returns:
  An object of the form:

    {
    "resource": { # Representation of an individual survey object. # Survey object containing the specification of the stopped Survey.
        "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
          "A String",
        ],
        "description": "A String", # Text description of the survey.
        "title": "A String", # Optional name that will be given to the survey.
        "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
        "state": "A String", # State that the survey is in.
        "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
          "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
          "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
          "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
          "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
            "A String",
          ],
          "populationSource": "A String", # Online population source where the respondents are sampled from.
          "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
            "A String",
          ],
          "gender": "A String", # Optional gender to target.
        },
        "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
          "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
          "currencyCode": "A String", # Currency code that the cost is given in.
          "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
          "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
        },
        "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
        "questions": [ # List of questions defining the survey.
          { # Message defining the question specifications.
            "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
            "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
            "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
              "A String",
            ],
            "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
            "question": "A String", # Required question text shown to the respondent.
            "numStars": "A String", # Number of stars to use for ratings questions.
            "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
            "videoId": "A String", # The YouTube video ID to be show in video questions.
            "answers": [ # Required list of answer options for a question.
              "A String",
            ],
            "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
            "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
            "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
            "images": [
              { # Container object for image data and alt_text.
                "url": "A String", # The read-only URL for the hosted images.
                "altText": "A String", # The alt text property used in image tags is required for all images.
                "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
              },
            ],
            "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
            "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
              "A String",
            ],
            "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
            "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
            "openTextPlaceholder": "A String", # Placeholder text for an open text question.
          },
        ],
        "wantedResponseCount": 42, # Number of responses desired for the survey.
        "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
          "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
          "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
        },
      },
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
update(surveyUrlId, body) 
Updates a survey. Currently the only property that can be updated is the owners property.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of an individual survey object.
    "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
      "A String",
    ],
    "description": "A String", # Text description of the survey.
    "title": "A String", # Optional name that will be given to the survey.
    "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
    "state": "A String", # State that the survey is in.
    "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
      "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
      "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
      "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
      "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
        "A String",
      ],
      "populationSource": "A String", # Online population source where the respondents are sampled from.
      "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
        "A String",
      ],
      "gender": "A String", # Optional gender to target.
    },
    "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
      "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
      "currencyCode": "A String", # Currency code that the cost is given in.
      "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
      "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
    },
    "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
    "questions": [ # List of questions defining the survey.
      { # Message defining the question specifications.
        "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
        "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
        "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
          "A String",
        ],
        "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
        "question": "A String", # Required question text shown to the respondent.
        "numStars": "A String", # Number of stars to use for ratings questions.
        "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
        "videoId": "A String", # The YouTube video ID to be show in video questions.
        "answers": [ # Required list of answer options for a question.
          "A String",
        ],
        "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
        "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
        "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
        "images": [
          { # Container object for image data and alt_text.
            "url": "A String", # The read-only URL for the hosted images.
            "altText": "A String", # The alt text property used in image tags is required for all images.
            "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
          },
        ],
        "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
        "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
          "A String",
        ],
        "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
        "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
        "openTextPlaceholder": "A String", # Placeholder text for an open text question.
      },
    ],
    "wantedResponseCount": 42, # Number of responses desired for the survey.
    "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
      "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
      "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
    },
  }


Returns:
  An object of the form:

    { # Representation of an individual survey object.
      "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
        "A String",
      ],
      "description": "A String", # Text description of the survey.
      "title": "A String", # Optional name that will be given to the survey.
      "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
      "state": "A String", # State that the survey is in.
      "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
        "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
        "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
        "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
        "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
          "A String",
        ],
        "populationSource": "A String", # Online population source where the respondents are sampled from.
        "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
          "A String",
        ],
        "gender": "A String", # Optional gender to target.
      },
      "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
        "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
        "currencyCode": "A String", # Currency code that the cost is given in.
        "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
        "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
      },
      "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
      "questions": [ # List of questions defining the survey.
        { # Message defining the question specifications.
          "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
          "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
          "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
            "A String",
          ],
          "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
          "question": "A String", # Required question text shown to the respondent.
          "numStars": "A String", # Number of stars to use for ratings questions.
          "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
          "videoId": "A String", # The YouTube video ID to be show in video questions.
          "answers": [ # Required list of answer options for a question.
            "A String",
          ],
          "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
          "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
          "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
          "images": [
            { # Container object for image data and alt_text.
              "url": "A String", # The read-only URL for the hosted images.
              "altText": "A String", # The alt text property used in image tags is required for all images.
              "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
            },
          ],
          "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
          "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
            "A String",
          ],
          "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
          "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
          "openTextPlaceholder": "A String", # Placeholder text for an open text question.
        },
      ],
      "wantedResponseCount": 42, # Number of responses desired for the survey.
      "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
        "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
        "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
      },
    }
google-api-python-client-1.5.5/docs/dyn/container_v1.html000066400000000000000000000041361300622755700233530ustar00rootroot00000000000000

Google Container Engine API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/container_v1.projects.html000066400000000000000000000023431300622755700252010ustar00rootroot00000000000000

Google Container Engine API . projects

Instance Methods

zones()

Returns the zones Resource.

google-api-python-client-1.5.5/docs/dyn/container_v1.projects.zones.clusters.html000066400000000000000000001430711300622755700302050ustar00rootroot00000000000000

Google Container Engine API . projects . zones . clusters

Instance Methods

nodePools()

Returns the nodePools Resource.

create(projectId, zone, body, x__xgafv=None)

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.

delete(projectId, zone, clusterId, x__xgafv=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.

get(projectId, zone, clusterId, x__xgafv=None)

Gets the details of a specific cluster.

list(projectId, zone, x__xgafv=None)

Lists all clusters owned by a project in either the specified zone or all zones.

update(projectId, zone, clusterId, body, x__xgafv=None)

Updates the settings of a specific cluster.

Method Details

create(projectId, zone, body, x__xgafv=None) 
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # CreateClusterRequest creates a cluster.
    "cluster": { # A Google Container Engine cluster. # A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters)
      "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
      "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
        "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
          "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
        },
        "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
          "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
        },
      },
      "locations": [ # The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
        "A String",
      ],
      "network": "A String", # The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
      "loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
      "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
        "A String",
      ],
      "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
      "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
      "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
      "status": "A String", # [Output only] The current status of this cluster.
      "description": "A String", # An optional description of this cluster.
      "currentNodeVersion": "A String", # [Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
      "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
      "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint.
        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password.
        "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
        "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
        "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
      },
      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.
      "nodePools": [ # The node pools associated with this cluster. When creating a new cluster, only a single node pool should be specified. This field should not be set if "node_config" or "initial_node_count" are specified.
        { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
          "status": "A String", # The status of the nodes in this pool instance.
          "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
          "name": "A String", # The name of the node pool.
          "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
            "A String",
          ],
          "version": "A String", # The version of the Kubernetes of this node.
          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
          "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
            "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
            "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
              "A String",
            ],
            "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
              "a_key": "A String",
            },
          },
          "selfLink": "A String", # Server-defined URL for the resource.
        },
      ],
      "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
      "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
      "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
      "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster.
      "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
      "initialClusterVersion": "A String", # [Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
      "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
        "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
        "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
          "A String",
        ],
        "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
          "a_key": "A String",
        },
      },
      "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
      "selfLink": "A String", # [Output only] Server-defined URL for the resource.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
    "status": "A String", # The current status of the operation.
    "name": "A String", # The server-assigned ID for the operation.
    "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
    "detail": "A String", # Detailed operation progress, if available.
    "selfLink": "A String", # Server-defined URL for the resource.
    "operationType": "A String", # The operation type.
    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
    "targetLink": "A String", # Server-defined URL for the target of the operation.
  }
delete(projectId, zone, clusterId, x__xgafv=None) 
Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
    "status": "A String", # The current status of the operation.
    "name": "A String", # The server-assigned ID for the operation.
    "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
    "detail": "A String", # Detailed operation progress, if available.
    "selfLink": "A String", # Server-defined URL for the resource.
    "operationType": "A String", # The operation type.
    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
    "targetLink": "A String", # Server-defined URL for the target of the operation.
  }
get(projectId, zone, clusterId, x__xgafv=None) 
Gets the details of a specific cluster.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster to retrieve. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Google Container Engine cluster.
    "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
    "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
      "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
        "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
      },
      "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
        "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
      },
    },
    "locations": [ # The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
      "A String",
    ],
    "network": "A String", # The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
    "loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
    "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
      "A String",
    ],
    "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
    "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
    "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
    "status": "A String", # [Output only] The current status of this cluster.
    "description": "A String", # An optional description of this cluster.
    "currentNodeVersion": "A String", # [Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
    "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
    "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint.
      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password.
      "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
      "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
      "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
    },
    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.
    "nodePools": [ # The node pools associated with this cluster. When creating a new cluster, only a single node pool should be specified. This field should not be set if "node_config" or "initial_node_count" are specified.
      { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
        "status": "A String", # The status of the nodes in this pool instance.
        "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
        "name": "A String", # The name of the node pool.
        "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
          "A String",
        ],
        "version": "A String", # The version of the Kubernetes of this node.
        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
        "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
          "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
          "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
            "A String",
          ],
          "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
            "a_key": "A String",
          },
        },
        "selfLink": "A String", # Server-defined URL for the resource.
      },
    ],
    "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
    "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
    "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
    "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster.
    "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
    "initialClusterVersion": "A String", # [Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
    "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
      "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
      "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
        "A String",
      ],
      "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
        "a_key": "A String",
      },
    },
    "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
    "selfLink": "A String", # [Output only] Server-defined URL for the resource.
  }
list(projectId, zone, x__xgafv=None) 
Lists all clusters owned by a project in either the specified zone or all zones.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # ListClustersResponse is the result of ListClustersRequest.
    "clusters": [ # A list of clusters in the project in the specified zone, or across all ones.
      { # A Google Container Engine cluster.
        "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
        "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
          "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
            "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
          },
          "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
            "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
          },
        },
        "locations": [ # The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
          "A String",
        ],
        "network": "A String", # The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
        "loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
        "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
          "A String",
        ],
        "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
        "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
        "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
        "status": "A String", # [Output only] The current status of this cluster.
        "description": "A String", # An optional description of this cluster.
        "currentNodeVersion": "A String", # [Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
        "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
        "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint.
          "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
          "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password.
          "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
          "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
          "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
        },
        "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.
        "nodePools": [ # The node pools associated with this cluster. When creating a new cluster, only a single node pool should be specified. This field should not be set if "node_config" or "initial_node_count" are specified.
          { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
            "status": "A String", # The status of the nodes in this pool instance.
            "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
            "name": "A String", # The name of the node pool.
            "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
              "A String",
            ],
            "version": "A String", # The version of the Kubernetes of this node.
            "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
            "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
              "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
              "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
              "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
                "A String",
              ],
              "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
                "a_key": "A String",
              },
            },
            "selfLink": "A String", # Server-defined URL for the resource.
          },
        ],
        "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
        "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
        "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
        "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster.
        "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
        "initialClusterVersion": "A String", # [Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
        "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
          "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
          "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
            "A String",
          ],
          "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
            "a_key": "A String",
          },
        },
        "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
        "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
        "selfLink": "A String", # [Output only] Server-defined URL for the resource.
      },
    ],
    "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
      "A String",
    ],
  }
update(projectId, zone, clusterId, body, x__xgafv=None) 
Updates the settings of a specific cluster.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster to upgrade. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # UpdateClusterRequest updates the settings of a cluster.
    "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # A description of the update.
      "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
      "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if the "desired_node_version" or "desired_image_family" is specified and there is more than one node pool on the cluster.
      "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an upgrade). Use `-` to upgrade to the latest version supported by the server.
      "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster
      "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
        "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
          "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
        },
        "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
          "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
        },
      },
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
    "status": "A String", # The current status of the operation.
    "name": "A String", # The server-assigned ID for the operation.
    "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
    "detail": "A String", # Detailed operation progress, if available.
    "selfLink": "A String", # Server-defined URL for the resource.
    "operationType": "A String", # The operation type.
    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
    "targetLink": "A String", # Server-defined URL for the target of the operation.
  }
google-api-python-client-1.5.5/docs/dyn/container_v1.projects.zones.clusters.nodePools.html000066400000000000000000000370111300622755700321420ustar00rootroot00000000000000

Google Container Engine API . projects . zones . clusters . nodePools

Instance Methods

create(projectId, zone, clusterId, body, x__xgafv=None)

Creates a node pool for a cluster.

delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)

Deletes a node pool from a cluster.

get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)

Retrieves the node pool requested.

list(projectId, zone, clusterId, x__xgafv=None)

Lists the node pools for a cluster.

Method Details

create(projectId, zone, clusterId, body, x__xgafv=None) 
Creates a node pool for a cluster.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # CreateNodePoolRequest creates a node pool for a cluster.
    "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # The node pool to create.
      "status": "A String", # The status of the nodes in this pool instance.
      "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
      "name": "A String", # The name of the node pool.
      "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
        "A String",
      ],
      "version": "A String", # The version of the Kubernetes of this node.
      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
      "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
        "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
        "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
          "A String",
        ],
        "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
          "a_key": "A String",
        },
      },
      "selfLink": "A String", # Server-defined URL for the resource.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
    "status": "A String", # The current status of the operation.
    "name": "A String", # The server-assigned ID for the operation.
    "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
    "detail": "A String", # Detailed operation progress, if available.
    "selfLink": "A String", # Server-defined URL for the resource.
    "operationType": "A String", # The operation type.
    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
    "targetLink": "A String", # Server-defined URL for the target of the operation.
  }
delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None) 
Deletes a node pool from a cluster.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster. (required)
  nodePoolId: string, The name of the node pool to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
    "status": "A String", # The current status of the operation.
    "name": "A String", # The server-assigned ID for the operation.
    "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
    "detail": "A String", # Detailed operation progress, if available.
    "selfLink": "A String", # Server-defined URL for the resource.
    "operationType": "A String", # The operation type.
    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
    "targetLink": "A String", # Server-defined URL for the target of the operation.
  }
get(projectId, zone, clusterId, nodePoolId, x__xgafv=None) 
Retrieves the node pool requested.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster. (required)
  nodePoolId: string, The name of the node pool. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
    "status": "A String", # The status of the nodes in this pool instance.
    "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
    "name": "A String", # The name of the node pool.
    "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
      "A String",
    ],
    "version": "A String", # The version of the Kubernetes of this node.
    "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
    "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
      "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
      "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
        "A String",
      ],
      "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
        "a_key": "A String",
      },
    },
    "selfLink": "A String", # Server-defined URL for the resource.
  }
list(projectId, zone, clusterId, x__xgafv=None) 
Lists the node pools for a cluster.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, The name of the cluster. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # ListNodePoolsResponse is the result of ListNodePoolsRequest.
    "nodePools": [ # A list of node pools for a cluster.
      { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
        "status": "A String", # The status of the nodes in this pool instance.
        "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
        "name": "A String", # The name of the node pool.
        "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
          "A String",
        ],
        "version": "A String", # The version of the Kubernetes of this node.
        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
        "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
          "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
          "machineType": "A String", # The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
            "A String",
          ],
          "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are 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 or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
            "a_key": "A String",
          },
        },
        "selfLink": "A String", # Server-defined URL for the resource.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/container_v1.projects.zones.html000066400000000000000000000051721300622755700263410ustar00rootroot00000000000000

Google Container Engine API . projects . zones

Instance Methods

clusters()

Returns the clusters Resource.

operations()

Returns the operations Resource.

getServerconfig(projectId, zone, x__xgafv=None)

Returns configuration info about the Container Engine service.

Method Details

getServerconfig(projectId, zone, x__xgafv=None) 
Returns configuration info about the Container Engine service.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Container Engine service configuration.
    "defaultClusterVersion": "A String", # Version of Kubernetes the service deploys by default.
    "validNodeVersions": [ # List of valid node upgrade target versions.
      "A String",
    ],
    "defaultImageFamily": "A String", # Default image family.
    "validImageFamilies": [ # List of valid image families.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/container_v1.projects.zones.operations.html000066400000000000000000000111461300622755700305210ustar00rootroot00000000000000

Google Container Engine API . projects . zones . operations

Instance Methods

get(projectId, zone, operationId, x__xgafv=None)

Gets the specified operation.

list(projectId, zone, x__xgafv=None)

Lists all operations in a project in a specific zone or all zones.

Method Details

get(projectId, zone, operationId, x__xgafv=None) 
Gets the specified operation.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
  operationId: string, The server-assigned `name` of the operation. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
    "status": "A String", # The current status of the operation.
    "name": "A String", # The server-assigned ID for the operation.
    "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
    "detail": "A String", # Detailed operation progress, if available.
    "selfLink": "A String", # Server-defined URL for the resource.
    "operationType": "A String", # The operation type.
    "statusMessage": "A String", # If an error has occurred, a textual description of the error.
    "targetLink": "A String", # Server-defined URL for the target of the operation.
  }
list(projectId, zone, x__xgafv=None) 
Lists all operations in a project in a specific zone or all zones.

Args:
  projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
  zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # ListOperationsResponse is the result of ListOperationsRequest.
    "operations": [ # A list of operations in the project in the specified zone.
      { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
        "status": "A String", # The current status of the operation.
        "name": "A String", # The server-assigned ID for the operation.
        "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
        "detail": "A String", # Detailed operation progress, if available.
        "selfLink": "A String", # Server-defined URL for the resource.
        "operationType": "A String", # The operation type.
        "statusMessage": "A String", # If an error has occurred, a textual description of the error.
        "targetLink": "A String", # Server-defined URL for the target of the operation.
      },
    ],
    "missingZones": [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/content_v2.accounts.html000066400000000000000000000716421300622755700246700ustar00rootroot00000000000000

Content API for Shopping . accounts

Instance Methods

authinfo()

Returns information about the authenticated user.

custombatch(body, dryRun=None)

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

delete(merchantId, accountId, dryRun=None)

Deletes a Merchant Center sub-account.

get(merchantId, accountId)

Retrieves a Merchant Center account.

insert(merchantId, body, dryRun=None)

Creates a Merchant Center sub-account.

list(merchantId, pageToken=None, maxResults=None)

Lists the sub-accounts in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(merchantId, accountId, body, dryRun=None)

Updates a Merchant Center account. This method supports patch semantics.

update(merchantId, accountId, body, dryRun=None)

Updates a Merchant Center account.

Method Details

authinfo() 
Returns information about the authenticated user.

Args:

Returns:
  An object of the form:

    {
    "kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
    "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user.
        # - For an individual account: only the merchant ID is defined
        # - For an aggregator: only the aggregator ID is defined
        # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
      {
        "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
        "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
      },
    ],
  }
custombatch(body, dryRun=None) 
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accounts request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "account": { # Account data. # The account to create or update. Only defined if the method is insert or update.
            "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
            "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
            "name": "A String", # Display name for the account.
            "adultContent": True or False, # Indicates whether the merchant sells adult content.
            "id": "A String", # Merchant Center account ID.
            "websiteUrl": "A String", # The merchant's website.
            "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
            "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
              {
                "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
                "adwordsId": "A String", # Customer ID of the AdWords account.
              },
            ],
            "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
              {
                "admin": True or False, # Whether user is an admin.
                "emailAddress": "A String", # User's email address.
              },
            ],
          },
        "merchantId": "A String", # The ID of the managing account.
        "accountId": "A String", # The ID of the account to get or delete. Only defined if the method is get or delete.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#accountsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch accounts response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "account": { # Account data. # The retrieved, created, or updated account. Not defined if the method was delete.
            "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
            "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
            "name": "A String", # Display name for the account.
            "adultContent": True or False, # Indicates whether the merchant sells adult content.
            "id": "A String", # Merchant Center account ID.
            "websiteUrl": "A String", # The merchant's website.
            "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
            "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
              {
                "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
                "adwordsId": "A String", # Customer ID of the AdWords account.
              },
            ],
            "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
              {
                "admin": True or False, # Whether user is an admin.
                "emailAddress": "A String", # User's email address.
              },
            ],
          },
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "kind": "content#accountsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry".
      },
    ],
  }
delete(merchantId, accountId, dryRun=None) 
Deletes a Merchant Center sub-account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)
  dryRun: boolean, Flag to run the request in dry-run mode.
get(merchantId, accountId) 
Retrieves a Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)

Returns:
  An object of the form:

    { # Account data.
      "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
      "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
      "name": "A String", # Display name for the account.
      "adultContent": True or False, # Indicates whether the merchant sells adult content.
      "id": "A String", # Merchant Center account ID.
      "websiteUrl": "A String", # The merchant's website.
      "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
      "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
          "adwordsId": "A String", # Customer ID of the AdWords account.
        },
      ],
      "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
        {
          "admin": True or False, # Whether user is an admin.
          "emailAddress": "A String", # User's email address.
        },
      ],
    }
insert(merchantId, body, dryRun=None) 
Creates a Merchant Center sub-account.

Args:
  merchantId: string, The ID of the managing account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Account data.
    "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
    "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
    "name": "A String", # Display name for the account.
    "adultContent": True or False, # Indicates whether the merchant sells adult content.
    "id": "A String", # Merchant Center account ID.
    "websiteUrl": "A String", # The merchant's website.
    "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
    "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
      {
        "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
        "adwordsId": "A String", # Customer ID of the AdWords account.
      },
    ],
    "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
      {
        "admin": True or False, # Whether user is an admin.
        "emailAddress": "A String", # User's email address.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Account data.
      "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
      "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
      "name": "A String", # Display name for the account.
      "adultContent": True or False, # Indicates whether the merchant sells adult content.
      "id": "A String", # Merchant Center account ID.
      "websiteUrl": "A String", # The merchant's website.
      "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
      "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
          "adwordsId": "A String", # Customer ID of the AdWords account.
        },
      ],
      "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
        {
          "admin": True or False, # Whether user is an admin.
          "emailAddress": "A String", # User's email address.
        },
      ],
    }
list(merchantId, pageToken=None, maxResults=None) 
Lists the sub-accounts in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of accounts to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
    "kind": "content#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
    "resources": [
      { # Account data.
          "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
          "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
          "name": "A String", # Display name for the account.
          "adultContent": True or False, # Indicates whether the merchant sells adult content.
          "id": "A String", # Merchant Center account ID.
          "websiteUrl": "A String", # The merchant's website.
          "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
          "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
            {
              "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
              "adwordsId": "A String", # Customer ID of the AdWords account.
            },
          ],
          "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
            {
              "admin": True or False, # Whether user is an admin.
              "emailAddress": "A String", # User's email address.
            },
          ],
        },
    ],
  }
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(merchantId, accountId, body, dryRun=None) 
Updates a Merchant Center account. This method supports patch semantics.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Account data.
    "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
    "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
    "name": "A String", # Display name for the account.
    "adultContent": True or False, # Indicates whether the merchant sells adult content.
    "id": "A String", # Merchant Center account ID.
    "websiteUrl": "A String", # The merchant's website.
    "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
    "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
      {
        "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
        "adwordsId": "A String", # Customer ID of the AdWords account.
      },
    ],
    "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
      {
        "admin": True or False, # Whether user is an admin.
        "emailAddress": "A String", # User's email address.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Account data.
      "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
      "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
      "name": "A String", # Display name for the account.
      "adultContent": True or False, # Indicates whether the merchant sells adult content.
      "id": "A String", # Merchant Center account ID.
      "websiteUrl": "A String", # The merchant's website.
      "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
      "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
          "adwordsId": "A String", # Customer ID of the AdWords account.
        },
      ],
      "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
        {
          "admin": True or False, # Whether user is an admin.
          "emailAddress": "A String", # User's email address.
        },
      ],
    }
update(merchantId, accountId, body, dryRun=None) 
Updates a Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Account data.
    "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
    "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
    "name": "A String", # Display name for the account.
    "adultContent": True or False, # Indicates whether the merchant sells adult content.
    "id": "A String", # Merchant Center account ID.
    "websiteUrl": "A String", # The merchant's website.
    "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
    "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
      {
        "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
        "adwordsId": "A String", # Customer ID of the AdWords account.
      },
    ],
    "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
      {
        "admin": True or False, # Whether user is an admin.
        "emailAddress": "A String", # User's email address.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Account data.
      "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
      "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
      "name": "A String", # Display name for the account.
      "adultContent": True or False, # Indicates whether the merchant sells adult content.
      "id": "A String", # Merchant Center account ID.
      "websiteUrl": "A String", # The merchant's website.
      "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
      "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.
        {
          "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
          "adwordsId": "A String", # Customer ID of the AdWords account.
        },
      ],
      "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
        {
          "admin": True or False, # Whether user is an admin.
          "emailAddress": "A String", # User's email address.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/content_v2.accountshipping.html000066400000000000000000002750331300622755700262470ustar00rootroot00000000000000

Content API for Shopping . accountshipping

Instance Methods

custombatch(body, dryRun=None)

Retrieves and updates the shipping settings of multiple accounts in a single request.

get(merchantId, accountId)

Retrieves the shipping settings of the account.

list(merchantId, pageToken=None, maxResults=None)

Lists the shipping settings of the sub-accounts in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(merchantId, accountId, body, dryRun=None)

Updates the shipping settings of the account. This method supports patch semantics.

update(merchantId, accountId, body, dryRun=None)

Updates the shipping settings of the account.

Method Details

custombatch(body, dryRun=None) 
Retrieves and updates the shipping settings of multiple accounts in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accountshipping request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "accountShipping": { # The shipping settings of a merchant account. # The account shipping settings to update. Only defined if the method is update.
          "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
          "carrierRates": [ # Carrier-based shipping calculations.
            { # A carrier-calculated shipping rate.
              "shippingOrigin": "A String", # Shipping origin represented as a postal code.
              "name": "A String", # The name of the carrier rate.
              "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
              "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
              "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
              "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
              "modifierFlatRate": { # Additive shipping rate modifier.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
            },
          ],
          "locationGroups": [ # Location groups for shipping.
            { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
              "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
                { # A postal code range, that can be either:
                    # - A range of postal codes (e.g., start=12340, end=12359)
                    # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                  "start": "A String", # The first (inclusive) postal code or prefix of the range.
                  "end": "A String", # The last (inclusive) postal code or prefix of the range.
                },
              ],
              "country": "A String", # The CLDR territory code of the country in which this location group is.
              "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
                "A String",
              ],
              "name": "A String", # The name of the location group.
              "postalCodes": [ # A postal code representing a city or a set of cities.
                  # - A single postal code (e.g., 12345)
                  # - A postal code prefix followed by a star (e.g., 1234*)
                "A String",
              ],
            },
          ],
          "services": [ # Shipping services describing shipping fees calculation.
            { # Shipping services provided in a country.
              "name": "A String", # The name of this shipping service.
              "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
              "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
              "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
                "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
                "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
                "rateTable": "A String", # Name of the rate table to use for the calculation.
                "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
                "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              },
              "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
              "active": True or False, # Whether the shipping service is available.
              "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
                  # - The tree root should have no condition and no calculation method.
                  # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
                  # - The last child of an element must have no condition and matches all elements not previously matched.
                  # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
                "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
                  "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
                  "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
                  "rateTable": "A String", # Name of the rate table to use for the calculation.
                  "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
                  "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                },
                "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
                  "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                  "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
                  "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
                  "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                      # - A range of postal codes (e.g., start=12340, end=12359)
                      # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                    "start": "A String", # The first (inclusive) postal code or prefix of the range.
                    "end": "A String", # The last (inclusive) postal code or prefix of the range.
                  },
                  "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
                  "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
                },
                "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
                  # Object with schema name: AccountShippingShippingServiceCostRule
                ],
              },
            },
          ],
          "accountId": "A String", # The ID of the account to which these account shipping settings belong.
          "rateTables": [ # Rate tables definitions.
            { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
              "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
                {
                  "rate": { # The rate applicable if the cell conditions are matched.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
                    "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                    "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
                    "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
                    "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                        # - A range of postal codes (e.g., start=12340, end=12359)
                        # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                      "start": "A String", # The first (inclusive) postal code or prefix of the range.
                      "end": "A String", # The last (inclusive) postal code or prefix of the range.
                    },
                    "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                    "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
                    "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
                  },
                },
              ],
              "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
              "name": "A String", # The name of the rate table.
            },
          ],
        },
        "merchantId": "A String", # The ID of the managing account.
        "accountId": "A String", # The ID of the account for which to get/update account shipping settings.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#accountshippingCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountshippingCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch accountshipping response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "kind": "content#accountshippingCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountshippingCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "accountShipping": { # The shipping settings of a merchant account. # The retrieved or updated account shipping settings.
          "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
          "carrierRates": [ # Carrier-based shipping calculations.
            { # A carrier-calculated shipping rate.
              "shippingOrigin": "A String", # Shipping origin represented as a postal code.
              "name": "A String", # The name of the carrier rate.
              "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
              "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
              "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
              "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
              "modifierFlatRate": { # Additive shipping rate modifier.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
            },
          ],
          "locationGroups": [ # Location groups for shipping.
            { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
              "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
                { # A postal code range, that can be either:
                    # - A range of postal codes (e.g., start=12340, end=12359)
                    # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                  "start": "A String", # The first (inclusive) postal code or prefix of the range.
                  "end": "A String", # The last (inclusive) postal code or prefix of the range.
                },
              ],
              "country": "A String", # The CLDR territory code of the country in which this location group is.
              "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
                "A String",
              ],
              "name": "A String", # The name of the location group.
              "postalCodes": [ # A postal code representing a city or a set of cities.
                  # - A single postal code (e.g., 12345)
                  # - A postal code prefix followed by a star (e.g., 1234*)
                "A String",
              ],
            },
          ],
          "services": [ # Shipping services describing shipping fees calculation.
            { # Shipping services provided in a country.
              "name": "A String", # The name of this shipping service.
              "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
              "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
              "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
                "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
                "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
                "rateTable": "A String", # Name of the rate table to use for the calculation.
                "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
                "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              },
              "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
              "active": True or False, # Whether the shipping service is available.
              "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
                  # - The tree root should have no condition and no calculation method.
                  # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
                  # - The last child of an element must have no condition and matches all elements not previously matched.
                  # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
                "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
                  "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
                  "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
                  "rateTable": "A String", # Name of the rate table to use for the calculation.
                  "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
                  "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                },
                "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
                  "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                  "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
                  "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
                  "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                      # - A range of postal codes (e.g., start=12340, end=12359)
                      # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                    "start": "A String", # The first (inclusive) postal code or prefix of the range.
                    "end": "A String", # The last (inclusive) postal code or prefix of the range.
                  },
                  "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
                  "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
                },
                "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
                  # Object with schema name: AccountShippingShippingServiceCostRule
                ],
              },
            },
          ],
          "accountId": "A String", # The ID of the account to which these account shipping settings belong.
          "rateTables": [ # Rate tables definitions.
            { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
              "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
                {
                  "rate": { # The rate applicable if the cell conditions are matched.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
                    "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                    "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
                    "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
                    "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                        # - A range of postal codes (e.g., start=12340, end=12359)
                        # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                      "start": "A String", # The first (inclusive) postal code or prefix of the range.
                      "end": "A String", # The last (inclusive) postal code or prefix of the range.
                    },
                    "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                    "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
                    "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
                  },
                },
              ],
              "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
              "name": "A String", # The name of the rate table.
            },
          ],
        },
      },
    ],
  }
get(merchantId, accountId) 
Retrieves the shipping settings of the account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update account shipping settings. (required)

Returns:
  An object of the form:

    { # The shipping settings of a merchant account.
    "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
    "carrierRates": [ # Carrier-based shipping calculations.
      { # A carrier-calculated shipping rate.
        "shippingOrigin": "A String", # Shipping origin represented as a postal code.
        "name": "A String", # The name of the carrier rate.
        "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
        "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
        "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
        "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
        "modifierFlatRate": { # Additive shipping rate modifier.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
      },
    ],
    "locationGroups": [ # Location groups for shipping.
      { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
        "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
          { # A postal code range, that can be either:
              # - A range of postal codes (e.g., start=12340, end=12359)
              # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
            "start": "A String", # The first (inclusive) postal code or prefix of the range.
            "end": "A String", # The last (inclusive) postal code or prefix of the range.
          },
        ],
        "country": "A String", # The CLDR territory code of the country in which this location group is.
        "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
          "A String",
        ],
        "name": "A String", # The name of the location group.
        "postalCodes": [ # A postal code representing a city or a set of cities.
            # - A single postal code (e.g., 12345)
            # - A postal code prefix followed by a star (e.g., 1234*)
          "A String",
        ],
      },
    ],
    "services": [ # Shipping services describing shipping fees calculation.
      { # Shipping services provided in a country.
        "name": "A String", # The name of this shipping service.
        "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
        "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
        "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
          "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
          "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
          "rateTable": "A String", # Name of the rate table to use for the calculation.
          "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
          "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
        },
        "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
        "active": True or False, # Whether the shipping service is available.
        "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
            # - The tree root should have no condition and no calculation method.
            # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
            # - The last child of an element must have no condition and matches all elements not previously matched.
            # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
          "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
            "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
            "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
            "rateTable": "A String", # Name of the rate table to use for the calculation.
            "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
            "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
          },
          "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
            "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
              "value": "A String", # The weight represented as a number.
              "unit": "A String", # The weight unit.
            },
            "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
            "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
            "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                # - A range of postal codes (e.g., start=12340, end=12359)
                # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
              "start": "A String", # The first (inclusive) postal code or prefix of the range.
              "end": "A String", # The last (inclusive) postal code or prefix of the range.
            },
            "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
            "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
          },
          "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
            # Object with schema name: AccountShippingShippingServiceCostRule
          ],
        },
      },
    ],
    "accountId": "A String", # The ID of the account to which these account shipping settings belong.
    "rateTables": [ # Rate tables definitions.
      { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
        "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
          {
            "rate": { # The rate applicable if the cell conditions are matched.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
              "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                "value": "A String", # The weight represented as a number.
                "unit": "A String", # The weight unit.
              },
              "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
              "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
              "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                  # - A range of postal codes (e.g., start=12340, end=12359)
                  # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                "start": "A String", # The first (inclusive) postal code or prefix of the range.
                "end": "A String", # The last (inclusive) postal code or prefix of the range.
              },
              "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
              "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
            },
          },
        ],
        "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
        "name": "A String", # The name of the rate table.
      },
    ],
  }
list(merchantId, pageToken=None, maxResults=None) 
Lists the shipping settings of the sub-accounts in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of shipping settings to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of account shipping settings.
    "kind": "content#accountshippingListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountshippingListResponse".
    "resources": [
      { # The shipping settings of a merchant account.
        "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
        "carrierRates": [ # Carrier-based shipping calculations.
          { # A carrier-calculated shipping rate.
            "shippingOrigin": "A String", # Shipping origin represented as a postal code.
            "name": "A String", # The name of the carrier rate.
            "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
            "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
            "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
            "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
            "modifierFlatRate": { # Additive shipping rate modifier.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
          },
        ],
        "locationGroups": [ # Location groups for shipping.
          { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
            "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
              { # A postal code range, that can be either:
                  # - A range of postal codes (e.g., start=12340, end=12359)
                  # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                "start": "A String", # The first (inclusive) postal code or prefix of the range.
                "end": "A String", # The last (inclusive) postal code or prefix of the range.
              },
            ],
            "country": "A String", # The CLDR territory code of the country in which this location group is.
            "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
              "A String",
            ],
            "name": "A String", # The name of the location group.
            "postalCodes": [ # A postal code representing a city or a set of cities.
                # - A single postal code (e.g., 12345)
                # - A postal code prefix followed by a star (e.g., 1234*)
              "A String",
            ],
          },
        ],
        "services": [ # Shipping services describing shipping fees calculation.
          { # Shipping services provided in a country.
            "name": "A String", # The name of this shipping service.
            "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
            "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
            "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
              "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
              "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
              "rateTable": "A String", # Name of the rate table to use for the calculation.
              "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
              "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
            },
            "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
            "active": True or False, # Whether the shipping service is available.
            "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
                # - The tree root should have no condition and no calculation method.
                # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
                # - The last child of an element must have no condition and matches all elements not previously matched.
                # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
              "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
                "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
                "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
                "rateTable": "A String", # Name of the rate table to use for the calculation.
                "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
                "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              },
              "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
                "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                  "value": "A String", # The weight represented as a number.
                  "unit": "A String", # The weight unit.
                },
                "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
                "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
                "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                    # - A range of postal codes (e.g., start=12340, end=12359)
                    # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                  "start": "A String", # The first (inclusive) postal code or prefix of the range.
                  "end": "A String", # The last (inclusive) postal code or prefix of the range.
                },
                "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
                "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
              },
              "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
                # Object with schema name: AccountShippingShippingServiceCostRule
              ],
            },
          },
        ],
        "accountId": "A String", # The ID of the account to which these account shipping settings belong.
        "rateTables": [ # Rate tables definitions.
          { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
            "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
              {
                "rate": { # The rate applicable if the cell conditions are matched.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
                  "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                  "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
                  "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
                  "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                      # - A range of postal codes (e.g., start=12340, end=12359)
                      # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                    "start": "A String", # The first (inclusive) postal code or prefix of the range.
                    "end": "A String", # The last (inclusive) postal code or prefix of the range.
                  },
                  "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
                  "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
                },
              },
            ],
            "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
            "name": "A String", # The name of the rate 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(merchantId, accountId, body, dryRun=None) 
Updates the shipping settings of the account. This method supports patch semantics.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update account shipping settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The shipping settings of a merchant account.
  "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
  "carrierRates": [ # Carrier-based shipping calculations.
    { # A carrier-calculated shipping rate.
      "shippingOrigin": "A String", # Shipping origin represented as a postal code.
      "name": "A String", # The name of the carrier rate.
      "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
      "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
      "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
      "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
      "modifierFlatRate": { # Additive shipping rate modifier.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
    },
  ],
  "locationGroups": [ # Location groups for shipping.
    { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
      "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
        { # A postal code range, that can be either:
            # - A range of postal codes (e.g., start=12340, end=12359)
            # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
          "start": "A String", # The first (inclusive) postal code or prefix of the range.
          "end": "A String", # The last (inclusive) postal code or prefix of the range.
        },
      ],
      "country": "A String", # The CLDR territory code of the country in which this location group is.
      "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
        "A String",
      ],
      "name": "A String", # The name of the location group.
      "postalCodes": [ # A postal code representing a city or a set of cities.
          # - A single postal code (e.g., 12345)
          # - A postal code prefix followed by a star (e.g., 1234*)
        "A String",
      ],
    },
  ],
  "services": [ # Shipping services describing shipping fees calculation.
    { # Shipping services provided in a country.
      "name": "A String", # The name of this shipping service.
      "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
      "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
      "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
        "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
        "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
        "rateTable": "A String", # Name of the rate table to use for the calculation.
        "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
        "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
      },
      "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
      "active": True or False, # Whether the shipping service is available.
      "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
          # - The tree root should have no condition and no calculation method.
          # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
          # - The last child of an element must have no condition and matches all elements not previously matched.
          # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
        "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
          "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
          "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
          "rateTable": "A String", # Name of the rate table to use for the calculation.
          "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
          "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
        },
        "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
          "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
            "value": "A String", # The weight represented as a number.
            "unit": "A String", # The weight unit.
          },
          "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
          "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
          "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
              # - A range of postal codes (e.g., start=12340, end=12359)
              # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
            "start": "A String", # The first (inclusive) postal code or prefix of the range.
            "end": "A String", # The last (inclusive) postal code or prefix of the range.
          },
          "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
          "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
        },
        "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
          # Object with schema name: AccountShippingShippingServiceCostRule
        ],
      },
    },
  ],
  "accountId": "A String", # The ID of the account to which these account shipping settings belong.
  "rateTables": [ # Rate tables definitions.
    { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
      "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
        {
          "rate": { # The rate applicable if the cell conditions are matched.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
            "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
              "value": "A String", # The weight represented as a number.
              "unit": "A String", # The weight unit.
            },
            "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
            "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
            "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                # - A range of postal codes (e.g., start=12340, end=12359)
                # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
              "start": "A String", # The first (inclusive) postal code or prefix of the range.
              "end": "A String", # The last (inclusive) postal code or prefix of the range.
            },
            "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
            "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
          },
        },
      ],
      "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
      "name": "A String", # The name of the rate table.
    },
  ],
}

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # The shipping settings of a merchant account.
    "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
    "carrierRates": [ # Carrier-based shipping calculations.
      { # A carrier-calculated shipping rate.
        "shippingOrigin": "A String", # Shipping origin represented as a postal code.
        "name": "A String", # The name of the carrier rate.
        "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
        "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
        "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
        "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
        "modifierFlatRate": { # Additive shipping rate modifier.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
      },
    ],
    "locationGroups": [ # Location groups for shipping.
      { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
        "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
          { # A postal code range, that can be either:
              # - A range of postal codes (e.g., start=12340, end=12359)
              # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
            "start": "A String", # The first (inclusive) postal code or prefix of the range.
            "end": "A String", # The last (inclusive) postal code or prefix of the range.
          },
        ],
        "country": "A String", # The CLDR territory code of the country in which this location group is.
        "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
          "A String",
        ],
        "name": "A String", # The name of the location group.
        "postalCodes": [ # A postal code representing a city or a set of cities.
            # - A single postal code (e.g., 12345)
            # - A postal code prefix followed by a star (e.g., 1234*)
          "A String",
        ],
      },
    ],
    "services": [ # Shipping services describing shipping fees calculation.
      { # Shipping services provided in a country.
        "name": "A String", # The name of this shipping service.
        "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
        "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
        "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
          "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
          "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
          "rateTable": "A String", # Name of the rate table to use for the calculation.
          "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
          "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
        },
        "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
        "active": True or False, # Whether the shipping service is available.
        "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
            # - The tree root should have no condition and no calculation method.
            # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
            # - The last child of an element must have no condition and matches all elements not previously matched.
            # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
          "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
            "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
            "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
            "rateTable": "A String", # Name of the rate table to use for the calculation.
            "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
            "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
          },
          "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
            "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
              "value": "A String", # The weight represented as a number.
              "unit": "A String", # The weight unit.
            },
            "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
            "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
            "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                # - A range of postal codes (e.g., start=12340, end=12359)
                # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
              "start": "A String", # The first (inclusive) postal code or prefix of the range.
              "end": "A String", # The last (inclusive) postal code or prefix of the range.
            },
            "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
            "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
          },
          "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
            # Object with schema name: AccountShippingShippingServiceCostRule
          ],
        },
      },
    ],
    "accountId": "A String", # The ID of the account to which these account shipping settings belong.
    "rateTables": [ # Rate tables definitions.
      { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
        "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
          {
            "rate": { # The rate applicable if the cell conditions are matched.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
              "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                "value": "A String", # The weight represented as a number.
                "unit": "A String", # The weight unit.
              },
              "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
              "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
              "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                  # - A range of postal codes (e.g., start=12340, end=12359)
                  # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                "start": "A String", # The first (inclusive) postal code or prefix of the range.
                "end": "A String", # The last (inclusive) postal code or prefix of the range.
              },
              "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
              "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
            },
          },
        ],
        "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
        "name": "A String", # The name of the rate table.
      },
    ],
  }
update(merchantId, accountId, body, dryRun=None) 
Updates the shipping settings of the account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update account shipping settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The shipping settings of a merchant account.
  "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
  "carrierRates": [ # Carrier-based shipping calculations.
    { # A carrier-calculated shipping rate.
      "shippingOrigin": "A String", # Shipping origin represented as a postal code.
      "name": "A String", # The name of the carrier rate.
      "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
      "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
      "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
      "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
      "modifierFlatRate": { # Additive shipping rate modifier.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
    },
  ],
  "locationGroups": [ # Location groups for shipping.
    { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
      "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
        { # A postal code range, that can be either:
            # - A range of postal codes (e.g., start=12340, end=12359)
            # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
          "start": "A String", # The first (inclusive) postal code or prefix of the range.
          "end": "A String", # The last (inclusive) postal code or prefix of the range.
        },
      ],
      "country": "A String", # The CLDR territory code of the country in which this location group is.
      "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
        "A String",
      ],
      "name": "A String", # The name of the location group.
      "postalCodes": [ # A postal code representing a city or a set of cities.
          # - A single postal code (e.g., 12345)
          # - A postal code prefix followed by a star (e.g., 1234*)
        "A String",
      ],
    },
  ],
  "services": [ # Shipping services describing shipping fees calculation.
    { # Shipping services provided in a country.
      "name": "A String", # The name of this shipping service.
      "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
      "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
      "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
        "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
        "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
        "rateTable": "A String", # Name of the rate table to use for the calculation.
        "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
        "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
      },
      "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
      "active": True or False, # Whether the shipping service is available.
      "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
          # - The tree root should have no condition and no calculation method.
          # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
          # - The last child of an element must have no condition and matches all elements not previously matched.
          # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
        "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
          "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
          "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
          "rateTable": "A String", # Name of the rate table to use for the calculation.
          "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
          "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
        },
        "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
          "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
            "value": "A String", # The weight represented as a number.
            "unit": "A String", # The weight unit.
          },
          "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
          "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
          "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
              # - A range of postal codes (e.g., start=12340, end=12359)
              # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
            "start": "A String", # The first (inclusive) postal code or prefix of the range.
            "end": "A String", # The last (inclusive) postal code or prefix of the range.
          },
          "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
          "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
        },
        "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
          # Object with schema name: AccountShippingShippingServiceCostRule
        ],
      },
    },
  ],
  "accountId": "A String", # The ID of the account to which these account shipping settings belong.
  "rateTables": [ # Rate tables definitions.
    { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
      "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
        {
          "rate": { # The rate applicable if the cell conditions are matched.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
            "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
              "value": "A String", # The weight represented as a number.
              "unit": "A String", # The weight unit.
            },
            "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
            "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
            "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                # - A range of postal codes (e.g., start=12340, end=12359)
                # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
              "start": "A String", # The first (inclusive) postal code or prefix of the range.
              "end": "A String", # The last (inclusive) postal code or prefix of the range.
            },
            "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
            "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
          },
        },
      ],
      "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
      "name": "A String", # The name of the rate table.
    },
  ],
}

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # The shipping settings of a merchant account.
    "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
    "carrierRates": [ # Carrier-based shipping calculations.
      { # A carrier-calculated shipping rate.
        "shippingOrigin": "A String", # Shipping origin represented as a postal code.
        "name": "A String", # The name of the carrier rate.
        "saleCountry": "A String", # The sale country for which this carrier rate is valid, represented as a CLDR territory code.
        "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
        "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
        "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
        "modifierFlatRate": { # Additive shipping rate modifier.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
      },
    ],
    "locationGroups": [ # Location groups for shipping.
      { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
        "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
          { # A postal code range, that can be either:
              # - A range of postal codes (e.g., start=12340, end=12359)
              # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
            "start": "A String", # The first (inclusive) postal code or prefix of the range.
            "end": "A String", # The last (inclusive) postal code or prefix of the range.
          },
        ],
        "country": "A String", # The CLDR territory code of the country in which this location group is.
        "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
          "A String",
        ],
        "name": "A String", # The name of the location group.
        "postalCodes": [ # A postal code representing a city or a set of cities.
            # - A single postal code (e.g., 12345)
            # - A postal code prefix followed by a star (e.g., 1234*)
          "A String",
        ],
      },
    ],
    "services": [ # Shipping services describing shipping fees calculation.
      { # Shipping services provided in a country.
        "name": "A String", # The name of this shipping service.
        "saleCountry": "A String", # The CLDR territory code of the sale country for which this service can be used.
        "maxDaysInTransit": "A String", # The maximum number of days in transit. Must be a value between 0 and 250 included. A value of 0 means same day delivery.
        "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
          "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
          "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
          "rateTable": "A String", # Name of the rate table to use for the calculation.
          "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
          "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
        },
        "minDaysInTransit": "A String", # The minimum number of days in transit. Must be a value between 0 and maxDaysIntransit included. A value of 0 means same day delivery.
        "active": True or False, # Whether the shipping service is available.
        "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
            # - The tree root should have no condition and no calculation method.
            # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
            # - The last child of an element must have no condition and matches all elements not previously matched.
            # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
          "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
            "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
            "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
            "rateTable": "A String", # Name of the rate table to use for the calculation.
            "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
            "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
          },
          "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
            "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
              "value": "A String", # The weight represented as a number.
              "unit": "A String", # The weight unit.
            },
            "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
            "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
            "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                # - A range of postal codes (e.g., start=12340, end=12359)
                # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
              "start": "A String", # The first (inclusive) postal code or prefix of the range.
              "end": "A String", # The last (inclusive) postal code or prefix of the range.
            },
            "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
            "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
          },
          "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
            # Object with schema name: AccountShippingShippingServiceCostRule
          ],
        },
      },
    ],
    "accountId": "A String", # The ID of the account to which these account shipping settings belong.
    "rateTables": [ # Rate tables definitions.
      { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
        "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
          {
            "rate": { # The rate applicable if the cell conditions are matched.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
              "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
                "value": "A String", # The weight represented as a number.
                "unit": "A String", # The weight unit.
              },
              "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
              "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
              "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
                  # - A range of postal codes (e.g., start=12340, end=12359)
                  # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
                "start": "A String", # The first (inclusive) postal code or prefix of the range.
                "end": "A String", # The last (inclusive) postal code or prefix of the range.
              },
              "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
              "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
            },
          },
        ],
        "saleCountry": "A String", # The sale country for which this table is valid, represented as a CLDR territory code.
        "name": "A String", # The name of the rate table.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/content_v2.accountstatuses.html000066400000000000000000000240171300622755700262730ustar00rootroot00000000000000

Content API for Shopping . accountstatuses

Instance Methods

custombatch(body)

A description of how to use this function

get(merchantId, accountId)

Retrieves the status of a Merchant Center account.

list(merchantId, pageToken=None, maxResults=None)

Lists the statuses of the sub-accounts in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

custombatch(body) 
A description of how to use this function

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accountstatuses request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String", # The method (get).
        "merchantId": "A String", # The ID of the managing account.
        "accountId": "A String", # The ID of the (sub-)account whose status to get.
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#accountstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch accountstatuses response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "accountStatus": { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. # The requested account status. Defined if and only if the request was successful.
          "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
          "dataQualityIssues": [ # A list of data quality issues.
            {
              "displayedValue": "A String", # Actual value displayed on the landing page.
              "severity": "A String", # Severity of the problem.
              "lastChecked": "A String", # Last time the account was checked for this issue.
              "country": "A String", # Country for which this issue is reported.
              "exampleItems": [ # Example items featuring the issue.
                { # An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
                  "itemId": "A String", # Unique item ID as specified in the uploaded product data.
                  "submittedValue": "A String", # The item value that was submitted.
                  "link": "A String", # Landing page of the item.
                  "valueOnLandingPage": "A String", # The actual value on the landing page.
                  "title": "A String", # Title of the item.
                },
              ],
              "submittedValue": "A String", # Submitted value that causes the issue.
              "numItems": 42, # Number of items in the account found to have the said issue.
              "id": "A String", # Issue identifier.
            },
          ],
          "accountId": "A String", # The ID of the account for which the status is reported.
        },
      },
    ],
  }
get(merchantId, accountId) 
Retrieves the status of a Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account. (required)

Returns:
  An object of the form:

    { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
    "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
    "dataQualityIssues": [ # A list of data quality issues.
      {
        "displayedValue": "A String", # Actual value displayed on the landing page.
        "severity": "A String", # Severity of the problem.
        "lastChecked": "A String", # Last time the account was checked for this issue.
        "country": "A String", # Country for which this issue is reported.
        "exampleItems": [ # Example items featuring the issue.
          { # An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
            "itemId": "A String", # Unique item ID as specified in the uploaded product data.
            "submittedValue": "A String", # The item value that was submitted.
            "link": "A String", # Landing page of the item.
            "valueOnLandingPage": "A String", # The actual value on the landing page.
            "title": "A String", # Title of the item.
          },
        ],
        "submittedValue": "A String", # Submitted value that causes the issue.
        "numItems": 42, # Number of items in the account found to have the said issue.
        "id": "A String", # Issue identifier.
      },
    ],
    "accountId": "A String", # The ID of the account for which the status is reported.
  }
list(merchantId, pageToken=None, maxResults=None) 
Lists the statuses of the sub-accounts in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of account statuses to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of account statuses.
    "kind": "content#accountstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".
    "resources": [
      { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
        "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
        "dataQualityIssues": [ # A list of data quality issues.
          {
            "displayedValue": "A String", # Actual value displayed on the landing page.
            "severity": "A String", # Severity of the problem.
            "lastChecked": "A String", # Last time the account was checked for this issue.
            "country": "A String", # Country for which this issue is reported.
            "exampleItems": [ # Example items featuring the issue.
              { # An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
                "itemId": "A String", # Unique item ID as specified in the uploaded product data.
                "submittedValue": "A String", # The item value that was submitted.
                "link": "A String", # Landing page of the item.
                "valueOnLandingPage": "A String", # The actual value on the landing page.
                "title": "A String", # Title of the item.
              },
            ],
            "submittedValue": "A String", # Submitted value that causes the issue.
            "numItems": 42, # Number of items in the account found to have the said issue.
            "id": "A String", # Issue identifier.
          },
        ],
        "accountId": "A String", # The ID of the account for which the status is reported.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/content_v2.accounttax.html000066400000000000000000000373011300622755700252140ustar00rootroot00000000000000

Content API for Shopping . accounttax

Instance Methods

custombatch(body, dryRun=None)

Retrieves and updates tax settings of multiple accounts in a single request.

get(merchantId, accountId)

Retrieves the tax settings of the account.

list(merchantId, pageToken=None, maxResults=None)

Lists the tax settings of the sub-accounts in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(merchantId, accountId, body, dryRun=None)

Updates the tax settings of the account. This method supports patch semantics.

update(merchantId, accountId, body, dryRun=None)

Updates the tax settings of the account.

Method Details

custombatch(body, dryRun=None) 
Retrieves and updates tax settings of multiple accounts in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accounttax request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "accountTax": { # The tax settings of a merchant account. # The account tax settings to update. Only defined if the method is update.
          "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
            { # Tax calculation rule to apply in a state or province (USA only).
              "country": "A String", # Country code in which tax is applicable.
              "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
              "shippingTaxed": True or False, # If true, shipping charges are also taxed.
              "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
              "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
            },
          ],
          "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
          "accountId": "A String", # The ID of the account to which these account tax settings belong.
        },
        "merchantId": "A String", # The ID of the managing account.
        "accountId": "A String", # The ID of the account for which to get/update account tax settings.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch accounttax response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "accountTax": { # The tax settings of a merchant account. # The retrieved or updated account tax settings.
          "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
            { # Tax calculation rule to apply in a state or province (USA only).
              "country": "A String", # Country code in which tax is applicable.
              "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
              "shippingTaxed": True or False, # If true, shipping charges are also taxed.
              "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
              "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
            },
          ],
          "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
          "accountId": "A String", # The ID of the account to which these account tax settings belong.
        },
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry".
      },
    ],
  }
get(merchantId, accountId) 
Retrieves the tax settings of the account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update account tax settings. (required)

Returns:
  An object of the form:

    { # The tax settings of a merchant account.
    "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
      { # Tax calculation rule to apply in a state or province (USA only).
        "country": "A String", # Country code in which tax is applicable.
        "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
        "shippingTaxed": True or False, # If true, shipping charges are also taxed.
        "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
        "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
      },
    ],
    "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    "accountId": "A String", # The ID of the account to which these account tax settings belong.
  }
list(merchantId, pageToken=None, maxResults=None) 
Lists the tax settings of the sub-accounts in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of tax settings to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
    "kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
    "resources": [
      { # The tax settings of a merchant account.
        "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
          { # Tax calculation rule to apply in a state or province (USA only).
            "country": "A String", # Country code in which tax is applicable.
            "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
            "shippingTaxed": True or False, # If true, shipping charges are also taxed.
            "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
            "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
          },
        ],
        "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
        "accountId": "A String", # The ID of the account to which these account tax settings belong.
      },
    ],
  }
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(merchantId, accountId, body, dryRun=None) 
Updates the tax settings of the account. This method supports patch semantics.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update account tax settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The tax settings of a merchant account.
  "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    { # Tax calculation rule to apply in a state or province (USA only).
      "country": "A String", # Country code in which tax is applicable.
      "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
      "shippingTaxed": True or False, # If true, shipping charges are also taxed.
      "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
      "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    },
  ],
  "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
  "accountId": "A String", # The ID of the account to which these account tax settings belong.
}

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # The tax settings of a merchant account.
    "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
      { # Tax calculation rule to apply in a state or province (USA only).
        "country": "A String", # Country code in which tax is applicable.
        "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
        "shippingTaxed": True or False, # If true, shipping charges are also taxed.
        "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
        "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
      },
    ],
    "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    "accountId": "A String", # The ID of the account to which these account tax settings belong.
  }
update(merchantId, accountId, body, dryRun=None) 
Updates the tax settings of the account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update account tax settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The tax settings of a merchant account.
  "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    { # Tax calculation rule to apply in a state or province (USA only).
      "country": "A String", # Country code in which tax is applicable.
      "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
      "shippingTaxed": True or False, # If true, shipping charges are also taxed.
      "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
      "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    },
  ],
  "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
  "accountId": "A String", # The ID of the account to which these account tax settings belong.
}

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # The tax settings of a merchant account.
    "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
      { # Tax calculation rule to apply in a state or province (USA only).
        "country": "A String", # Country code in which tax is applicable.
        "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
        "shippingTaxed": True or False, # If true, shipping charges are also taxed.
        "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
        "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
      },
    ],
    "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    "accountId": "A String", # The ID of the account to which these account tax settings belong.
  }
google-api-python-client-1.5.5/docs/dyn/content_v2.datafeeds.html000066400000000000000000001052251300622755700247640ustar00rootroot00000000000000

Content API for Shopping . datafeeds

Instance Methods

custombatch(body, dryRun=None)

A description of how to use this function

delete(merchantId, datafeedId, dryRun=None)

Deletes a datafeed from your Merchant Center account.

get(merchantId, datafeedId)

Retrieves a datafeed from your Merchant Center account.

insert(merchantId, body, dryRun=None)

Registers a datafeed with your Merchant Center account.

list(merchantId, pageToken=None, maxResults=None)

Lists the datafeeds in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(merchantId, datafeedId, body, dryRun=None)

Updates a datafeed of your Merchant Center account. This method supports patch semantics.

update(merchantId, datafeedId, body, dryRun=None)

Updates a datafeed of your Merchant Center account.

Method Details

custombatch(body, dryRun=None) 
A description of how to use this function

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch datafeeds request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "datafeedId": "A String", # The ID of the data feed to get or delete.
        "datafeed": { # Datafeed data. # The data feed to insert.
            "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
            "contentType": "A String", # The type of data feed.
            "name": "A String", # A descriptive name of the data feed.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
            "format": { # Format of the feed file.
              "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
              "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
              "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
            },
            "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
              "username": "A String", # An optional user name for fetch_url.
              "hour": 42, # The hour of the day the feed file should be fetched (0-23).
              "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
              "weekday": "A String", # The day of the week the feed file should be fetched.
              "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
              "password": "A String", # An optional password for fetch_url.
              "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
              "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
            },
            "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
            "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
            "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
              "A String",
            ],
            "id": "A String", # The ID of the data feed.
            "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
          },
        "merchantId": "A String", # The ID of the managing account.
        "method": "A String",
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch datafeeds response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "datafeed": { # Datafeed data. # The requested data feed. Defined if and only if the request was successful.
            "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
            "contentType": "A String", # The type of data feed.
            "name": "A String", # A descriptive name of the data feed.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
            "format": { # Format of the feed file.
              "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
              "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
              "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
            },
            "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
              "username": "A String", # An optional user name for fetch_url.
              "hour": 42, # The hour of the day the feed file should be fetched (0-23).
              "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
              "weekday": "A String", # The day of the week the feed file should be fetched.
              "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
              "password": "A String", # An optional password for fetch_url.
              "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
              "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
            },
            "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
            "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
            "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
              "A String",
            ],
            "id": "A String", # The ID of the data feed.
            "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
          },
      },
    ],
  }
delete(merchantId, datafeedId, dryRun=None) 
Deletes a datafeed from your Merchant Center account.

Args:
  merchantId: string, A parameter (required)
  datafeedId: string, A parameter (required)
  dryRun: boolean, Flag to run the request in dry-run mode.
get(merchantId, datafeedId) 
Retrieves a datafeed from your Merchant Center account.

Args:
  merchantId: string, A parameter (required)
  datafeedId: string, A parameter (required)

Returns:
  An object of the form:

    { # Datafeed data.
      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
      "contentType": "A String", # The type of data feed.
      "name": "A String", # A descriptive name of the data feed.
      "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
      "format": { # Format of the feed file.
        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
        "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
      },
      "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
        "username": "A String", # An optional user name for fetch_url.
        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
        "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
        "weekday": "A String", # The day of the week the feed file should be fetched.
        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
        "password": "A String", # An optional password for fetch_url.
        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
      },
      "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
      "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
        "A String",
      ],
      "id": "A String", # The ID of the data feed.
      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
    }
insert(merchantId, body, dryRun=None) 
Registers a datafeed with your Merchant Center account.

Args:
  merchantId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Datafeed data.
    "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
    "contentType": "A String", # The type of data feed.
    "name": "A String", # A descriptive name of the data feed.
    "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
    "format": { # Format of the feed file.
      "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
      "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
      "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
    },
    "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
      "username": "A String", # An optional user name for fetch_url.
      "hour": 42, # The hour of the day the feed file should be fetched (0-23).
      "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
      "weekday": "A String", # The day of the week the feed file should be fetched.
      "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
      "password": "A String", # An optional password for fetch_url.
      "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
      "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
    },
    "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
    "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
    "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
      "A String",
    ],
    "id": "A String", # The ID of the data feed.
    "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Datafeed data.
      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
      "contentType": "A String", # The type of data feed.
      "name": "A String", # A descriptive name of the data feed.
      "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
      "format": { # Format of the feed file.
        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
        "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
      },
      "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
        "username": "A String", # An optional user name for fetch_url.
        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
        "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
        "weekday": "A String", # The day of the week the feed file should be fetched.
        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
        "password": "A String", # An optional password for fetch_url.
        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
      },
      "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
      "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
        "A String",
      ],
      "id": "A String", # The ID of the data feed.
      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
    }
list(merchantId, pageToken=None, maxResults=None) 
Lists the datafeeds in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of products to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds.
    "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
    "resources": [
      { # Datafeed data.
          "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
          "contentType": "A String", # The type of data feed.
          "name": "A String", # A descriptive name of the data feed.
          "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
          "format": { # Format of the feed file.
            "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
            "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
            "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
          },
          "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
            "username": "A String", # An optional user name for fetch_url.
            "hour": 42, # The hour of the day the feed file should be fetched (0-23).
            "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
            "weekday": "A String", # The day of the week the feed file should be fetched.
            "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
            "password": "A String", # An optional password for fetch_url.
            "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
            "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
          },
          "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
          "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
          "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
            "A String",
          ],
          "id": "A String", # The ID of the data feed.
          "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
        },
    ],
  }
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(merchantId, datafeedId, body, dryRun=None) 
Updates a datafeed of your Merchant Center account. This method supports patch semantics.

Args:
  merchantId: string, A parameter (required)
  datafeedId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Datafeed data.
    "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
    "contentType": "A String", # The type of data feed.
    "name": "A String", # A descriptive name of the data feed.
    "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
    "format": { # Format of the feed file.
      "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
      "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
      "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
    },
    "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
      "username": "A String", # An optional user name for fetch_url.
      "hour": 42, # The hour of the day the feed file should be fetched (0-23).
      "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
      "weekday": "A String", # The day of the week the feed file should be fetched.
      "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
      "password": "A String", # An optional password for fetch_url.
      "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
      "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
    },
    "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
    "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
    "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
      "A String",
    ],
    "id": "A String", # The ID of the data feed.
    "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Datafeed data.
      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
      "contentType": "A String", # The type of data feed.
      "name": "A String", # A descriptive name of the data feed.
      "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
      "format": { # Format of the feed file.
        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
        "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
      },
      "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
        "username": "A String", # An optional user name for fetch_url.
        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
        "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
        "weekday": "A String", # The day of the week the feed file should be fetched.
        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
        "password": "A String", # An optional password for fetch_url.
        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
      },
      "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
      "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
        "A String",
      ],
      "id": "A String", # The ID of the data feed.
      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
    }
update(merchantId, datafeedId, body, dryRun=None) 
Updates a datafeed of your Merchant Center account.

Args:
  merchantId: string, A parameter (required)
  datafeedId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Datafeed data.
    "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
    "contentType": "A String", # The type of data feed.
    "name": "A String", # A descriptive name of the data feed.
    "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
    "format": { # Format of the feed file.
      "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
      "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
      "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
    },
    "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
      "username": "A String", # An optional user name for fetch_url.
      "hour": 42, # The hour of the day the feed file should be fetched (0-23).
      "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
      "weekday": "A String", # The day of the week the feed file should be fetched.
      "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
      "password": "A String", # An optional password for fetch_url.
      "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
      "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
    },
    "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
    "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
    "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
      "A String",
    ],
    "id": "A String", # The ID of the data feed.
    "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Datafeed data.
      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
      "contentType": "A String", # The type of data feed.
      "name": "A String", # A descriptive name of the data feed.
      "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
      "format": { # Format of the feed file.
        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
        "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
      },
      "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
        "username": "A String", # An optional user name for fetch_url.
        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
        "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
        "weekday": "A String", # The day of the week the feed file should be fetched.
        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
        "password": "A String", # An optional password for fetch_url.
        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
      },
      "targetCountry": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
      "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
        "A String",
      ],
      "id": "A String", # The ID of the data feed.
      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
    }
google-api-python-client-1.5.5/docs/dyn/content_v2.datafeedstatuses.html000066400000000000000000000300641300622755700263730ustar00rootroot00000000000000

Content API for Shopping . datafeedstatuses

Instance Methods

custombatch(body)

A description of how to use this function

get(merchantId, datafeedId)

Retrieves the status of a datafeed from your Merchant Center account.

list(merchantId, pageToken=None, maxResults=None)

Lists the statuses of the datafeeds in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

custombatch(body) 
A description of how to use this function

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch datafeedstatuses request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "datafeedId": "A String", # The ID of the data feed to get or delete.
        "merchantId": "A String", # The ID of the managing account.
        "method": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#datafeedstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch datafeedstatuses response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "datafeedStatus": { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. # The requested data feed status. Defined if and only if the request was successful.
          "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
          "errors": [ # The list of errors occurring in the feed.
            { # An error occurring in the feed, like "invalid price".
              "count": "A String", # The number of occurrences of the error in the feed.
              "message": "A String", # The error message, e.g., "Invalid price".
              "code": "A String", # The code of the error, e.g., "validation/invalid_value".
              "examples": [ # A list of example occurrences of the error, grouped by product.
                { # An example occurrence for a particular error.
                  "itemId": "A String", # The ID of the example item.
                  "value": "A String", # The problematic value.
                  "lineNumber": "A String", # Line number in the data feed where the example is found.
                },
              ],
            },
          ],
          "processingStatus": "A String", # The processing status of the feed.
          "itemsTotal": "A String", # The number of items in the feed that were processed.
          "warnings": [ # The list of errors occurring in the feed.
            { # An error occurring in the feed, like "invalid price".
              "count": "A String", # The number of occurrences of the error in the feed.
              "message": "A String", # The error message, e.g., "Invalid price".
              "code": "A String", # The code of the error, e.g., "validation/invalid_value".
              "examples": [ # A list of example occurrences of the error, grouped by product.
                { # An example occurrence for a particular error.
                  "itemId": "A String", # The ID of the example item.
                  "value": "A String", # The problematic value.
                  "lineNumber": "A String", # Line number in the data feed where the example is found.
                },
              ],
            },
          ],
          "lastUploadDate": "A String", # The last date at which the feed was uploaded.
          "itemsValid": "A String", # The number of items in the feed that were valid.
          "datafeedId": "A String", # The ID of the feed for which the status is reported.
        },
      },
    ],
  }
get(merchantId, datafeedId) 
Retrieves the status of a datafeed from your Merchant Center account.

Args:
  merchantId: string, A parameter (required)
  datafeedId: string, A parameter (required)

Returns:
  An object of the form:

    { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
    "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
    "errors": [ # The list of errors occurring in the feed.
      { # An error occurring in the feed, like "invalid price".
        "count": "A String", # The number of occurrences of the error in the feed.
        "message": "A String", # The error message, e.g., "Invalid price".
        "code": "A String", # The code of the error, e.g., "validation/invalid_value".
        "examples": [ # A list of example occurrences of the error, grouped by product.
          { # An example occurrence for a particular error.
            "itemId": "A String", # The ID of the example item.
            "value": "A String", # The problematic value.
            "lineNumber": "A String", # Line number in the data feed where the example is found.
          },
        ],
      },
    ],
    "processingStatus": "A String", # The processing status of the feed.
    "itemsTotal": "A String", # The number of items in the feed that were processed.
    "warnings": [ # The list of errors occurring in the feed.
      { # An error occurring in the feed, like "invalid price".
        "count": "A String", # The number of occurrences of the error in the feed.
        "message": "A String", # The error message, e.g., "Invalid price".
        "code": "A String", # The code of the error, e.g., "validation/invalid_value".
        "examples": [ # A list of example occurrences of the error, grouped by product.
          { # An example occurrence for a particular error.
            "itemId": "A String", # The ID of the example item.
            "value": "A String", # The problematic value.
            "lineNumber": "A String", # Line number in the data feed where the example is found.
          },
        ],
      },
    ],
    "lastUploadDate": "A String", # The last date at which the feed was uploaded.
    "itemsValid": "A String", # The number of items in the feed that were valid.
    "datafeedId": "A String", # The ID of the feed for which the status is reported.
  }
list(merchantId, pageToken=None, maxResults=None) 
Lists the statuses of the datafeeds in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of products to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of datafeed statuses.
    "kind": "content#datafeedstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
    "resources": [
      { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
        "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
        "errors": [ # The list of errors occurring in the feed.
          { # An error occurring in the feed, like "invalid price".
            "count": "A String", # The number of occurrences of the error in the feed.
            "message": "A String", # The error message, e.g., "Invalid price".
            "code": "A String", # The code of the error, e.g., "validation/invalid_value".
            "examples": [ # A list of example occurrences of the error, grouped by product.
              { # An example occurrence for a particular error.
                "itemId": "A String", # The ID of the example item.
                "value": "A String", # The problematic value.
                "lineNumber": "A String", # Line number in the data feed where the example is found.
              },
            ],
          },
        ],
        "processingStatus": "A String", # The processing status of the feed.
        "itemsTotal": "A String", # The number of items in the feed that were processed.
        "warnings": [ # The list of errors occurring in the feed.
          { # An error occurring in the feed, like "invalid price".
            "count": "A String", # The number of occurrences of the error in the feed.
            "message": "A String", # The error message, e.g., "Invalid price".
            "code": "A String", # The code of the error, e.g., "validation/invalid_value".
            "examples": [ # A list of example occurrences of the error, grouped by product.
              { # An example occurrence for a particular error.
                "itemId": "A String", # The ID of the example item.
                "value": "A String", # The problematic value.
                "lineNumber": "A String", # Line number in the data feed where the example is found.
              },
            ],
          },
        ],
        "lastUploadDate": "A String", # The last date at which the feed was uploaded.
        "itemsValid": "A String", # The number of items in the feed that were valid.
        "datafeedId": "A String", # The ID of the feed for which the status is reported.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/content_v2.html000066400000000000000000000072621300622755700230470ustar00rootroot00000000000000

Content API for Shopping

Instance Methods

accounts()

Returns the accounts Resource.

accountshipping()

Returns the accountshipping Resource.

accountstatuses()

Returns the accountstatuses Resource.

accounttax()

Returns the accounttax Resource.

datafeeds()

Returns the datafeeds Resource.

datafeedstatuses()

Returns the datafeedstatuses Resource.

inventory()

Returns the inventory Resource.

orders()

Returns the orders Resource.

products()

Returns the products Resource.

productstatuses()

Returns the productstatuses Resource.

shippingsettings()

Returns the shippingsettings Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/content_v2.inventory.html000066400000000000000000000211521300622755700250750ustar00rootroot00000000000000

Content API for Shopping . inventory

Instance Methods

custombatch(body, dryRun=None)

Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.

set(merchantId, storeCode, productId, body, dryRun=None)

Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product.

Method Details

custombatch(body, dryRun=None) 
Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch inventory request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "storeCode": "A String", # The code of the store for which to update price and availability. Use online to update price and availability of an online product.
        "productId": "A String", # The ID of the product for which to update price and availability.
        "inventory": { # Price and availability of the product.
          "kind": "content#inventory", # Identifies what kind of resource this is. Value: the fixed string "content#inventory".
          "installment": { # Number and amount of installments to pay for an item. Brazil only.
            "amount": { # The amount the buyer has to pay per month.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "months": "A String", # The number of installments the buyer has to pay.
          },
          "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
          "price": { # The price of the product.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "sellOnGoogleQuantity": 42, # The quantity of the product that is reserved for sell-on-google ads. Supported only for online products.
          "salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "availability": "A String", # The availability of the product.
          "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
            "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
            "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
            "pointsValue": "A String", # The retailer's loyalty points in absolute value.
          },
          "quantity": 42, # The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
        },
        "merchantId": "A String", # The ID of the managing account.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#inventoryCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch inventory response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "kind": "content#inventoryCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
      },
    ],
  }
set(merchantId, storeCode, productId, body, dryRun=None) 
Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product.

Args:
  merchantId: string, The ID of the managing account. (required)
  storeCode: string, The code of the store for which to update price and availability. Use online to update price and availability of an online product. (required)
  productId: string, The ID of the product for which to update price and availability. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "installment": { # Number and amount of installments to pay for an item. Brazil only.
      "amount": { # The amount the buyer has to pay per month.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "months": "A String", # The number of installments the buyer has to pay.
    },
    "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
    "price": { # The price of the product.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "sellOnGoogleQuantity": 42, # The quantity of the product that is reserved for sell-on-google ads. Supported only for online products.
    "salePrice": { # The sale price of the product. Mandatory if sale_price_effective_date is defined.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "availability": "A String", # The availability of the product.
    "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
      "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
      "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
      "pointsValue": "A String", # The retailer's loyalty points in absolute value.
    },
    "quantity": 42, # The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#inventorySetResponse", # Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse".
  }
google-api-python-client-1.5.5/docs/dyn/content_v2.orders.html000066400000000000000000002613071300622755700243460ustar00rootroot00000000000000

Content API for Shopping . orders

Instance Methods

acknowledge(merchantId, orderId, body)

Marks an order as acknowledged.

advancetestorder(merchantId, orderId)

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

cancel(merchantId, orderId, body)

Cancels all line items in an order.

cancellineitem(merchantId, orderId, body)

Cancels a line item.

createtestorder(merchantId, body)

Sandbox only. Creates a test order.

custombatch(body)

Retrieves or modifies multiple orders in a single request.

get(merchantId, orderId)

Retrieves an order from your Merchant Center account.

getbymerchantorderid(merchantId, merchantOrderId)

Retrieves an order using merchant order id.

gettestordertemplate(merchantId, templateName)

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)

Lists the orders in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

refund(merchantId, orderId, body)

Refund a portion of the order, up to the full amount paid.

returnlineitem(merchantId, orderId, body)

Returns a line item.

shiplineitems(merchantId, orderId, body)

Marks line item(s) as shipped.

updatemerchantorderid(merchantId, orderId, body)

Updates the merchant order ID for a given order.

updateshipment(merchantId, orderId, body)

Updates a shipment's status, carrier, and/or tracking ID.

Method Details

acknowledge(merchantId, orderId, body) 
Marks an order as acknowledged.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
    "executionStatus": "A String", # The status of the execution.
  }
advancetestorder(merchantId, orderId) 
Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the test order to modify. (required)

Returns:
  An object of the form:

    {
    "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
  }
cancel(merchantId, orderId, body) 
Cancels all line items in an order.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order to cancel. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "reason": "A String", # The reason for the cancellation.
    "reasonText": "A String", # The explanation of the reason.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
    "executionStatus": "A String", # The status of the execution.
  }
cancellineitem(merchantId, orderId, body) 
Cancels a line item.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "reason": "A String", # The reason for the cancellation.
    "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "reasonText": "A String", # The explanation of the reason.
    "lineItemId": "A String", # The ID of the line item to cancel.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
    "quantity": 42, # The quantity to cancel.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
    "executionStatus": "A String", # The status of the execution.
  }
createtestorder(merchantId, body) 
Sandbox only. Creates a test order.

Args:
  merchantId: string, The ID of the managing account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "testOrder": { # The test order to create.
      "customer": { # The details of the customer who placed the order.
        "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
        "fullName": "A String", # Full name of the customer.
        "email": "A String", # Email address of the customer.
      },
      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
        {
          "benefits": [
            {
              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                "A String",
              ],
              "discount": { # The discount in the order price when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
              "taxImpact": { # The impact on tax when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
            },
          ],
          "longTitle": "A String", # The full title of the promotion.
          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
          "id": "A String", # The unique ID of the promotion.
        },
      ],
      "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
      "shippingCostTax": { # The tax for the total shipping cost.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
      "shippingCost": { # The total cost of shipping for all items.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "shippingOption": "A String", # The requested shipping option.
      "lineItems": [ # Line items that are ordered. At least one line item must be provided.
        {
          "returnInfo": { # Details of the return policy for the line item.
            "policyUrl": "A String", # URL of the item return policy.
            "isReturnable": True or False, # Whether the item is returnable.
            "daysToReturn": 42, # How many days later the item can be returned.
          },
          "product": { # Product data from the time of the order placement.
            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "title": "A String", # The title of the product.
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
            "variantAttributes": [ # Variant attributes for the item. Optional.
              {
                "dimension": "A String", # The dimension of the variant.
                "value": "A String", # The value for the dimension.
              },
            ],
            "brand": "A String", # Brand of the item.
            "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
            "offerId": "A String", # An identifier of the item.
            "imageLink": "A String", # URL of an image of the item.
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
            "channel": "A String", # The item's channel.
            "price": { # The price for the product.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": "A String", # Condition or state of the item.
          },
          "unitTax": { # Unit tax for the line item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantityOrdered": 42, # Number of items ordered.
          "shippingDetails": { # Details of the requested shipping for the line item.
            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
            "method": { # Details of the shipping method.
              "minDaysInTransit": 42, # Minimum transit time.
              "carrier": "A String", # The carrier for the shipping. Optional.
              "methodName": "A String", # The name of the shipping method.
              "maxDaysInTransit": 42, # Maximum transit time.
            },
            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
          },
        },
      ],
      "paymentMethod": { # The details of the payment method.
        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
        "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
        "lastFourDigits": "A String", # The last four digits of the card number.
        "predefinedBillingAddress": "A String", # The billing address.
      },
    },
    "templateName": "A String", # The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template.
  }


Returns:
  An object of the form:

    {
    "orderId": "A String", # The ID of the newly created test order.
    "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
  }
custombatch(body) 
Retrieves or modifies multiple orders in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      {
        "orderId": "A String", # The ID of the order. Required for all methods beside getByMerchantOrderId.
        "merchantOrderId": "A String", # The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods.
        "shipLineItems": { # Required for shipLineItems method.
          "lineItems": [ # Line items to ship.
            {
              "lineItemId": "A String", # The id of the line item that is shipped.
              "quantity": 42, # The quantity that is shipped.
            },
          ],
          "carrier": "A String", # The carrier handling the shipment.
          "trackingId": "A String", # The tracking id for the shipment.
          "shipmentId": "A String", # The ID of the shipment.
        },
        "updateShipment": { # Required for updateShipment method.
          "status": "A String", # New status for the shipment. Not updated if missing.
          "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
          "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
          "shipmentId": "A String", # The ID of the shipment.
        },
        "method": "A String", # The method to apply.
        "batchId": 42, # An entry ID, unique within the batch request.
        "cancelLineItem": { # Required for cancelLineItem method.
          "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "reasonText": "A String", # The explanation of the reason.
          "reason": "A String", # The reason for the cancellation.
          "lineItemId": "A String", # The ID of the line item to cancel.
          "quantity": 42, # The quantity to cancel.
        },
        "refund": { # Required for refund method.
          "amount": { # The amount that is refunded.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "reasonText": "A String", # The explanation of the reason.
          "reason": "A String", # The reason for the refund.
        },
        "cancel": { # Required for cancel method.
          "reason": "A String", # The reason for the cancellation.
          "reasonText": "A String", # The explanation of the reason.
        },
        "returnLineItem": { # Required for returnLineItem method.
          "reason": "A String", # The reason for the return.
          "reasonText": "A String", # The explanation of the reason.
          "lineItemId": "A String", # The ID of the line item to return.
          "quantity": 42, # The quantity to return.
        },
        "merchantId": "A String", # The ID of the managing account.
        "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      {
        "batchId": 42, # The ID of the request entry this entry responds to.
        "kind": "content#ordersCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "order": { # The retrieved order. Only defined if the method is get and if the request was successful.
          "customer": { # The details of the customer who placed the order.
            "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
            "fullName": "A String", # Full name of the customer.
            "email": "A String", # Email address of the customer.
          },
          "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
            {
              "benefits": [
                {
                  "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                    "A String",
                  ],
                  "discount": { # The discount in the order price when the promotion is applied.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
                  "taxImpact": { # The impact on tax when the promotion is applied.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
                },
              ],
              "longTitle": "A String", # The full title of the promotion.
              "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
              "redemptionChannel": "A String", # Indicates that the promotion is valid online.
              "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
              "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
                  # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
              "id": "A String", # The unique ID of the promotion.
            },
          ],
          "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
          "shippingCostTax": { # The tax for the total shipping cost.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "shipments": [ # Shipments of the order.
            {
              "status": "A String", # The status of the shipment.
              "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
              "carrier": "A String", # The carrier handling the shipment.
              "trackingId": "A String", # The tracking id for the shipment.
              "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
              "lineItems": [ # The line items that are shipped.
                {
                  "lineItemId": "A String", # The id of the line item that is shipped.
                  "quantity": 42, # The quantity that is shipped.
                },
              ],
              "id": "A String", # The id of the shipment.
            },
          ],
          "refunds": [ # Refunds for the order.
            {
              "amount": { # The amount that is refunded.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
              "reason": "A String", # The reason for the refund.
              "actor": "A String", # The actor that created the refund.
              "reasonText": "A String", # The explanation of the reason.
            },
          ],
          "paymentMethod": { # The details of the payment method.
            "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
            "lastFourDigits": "A String", # The last four digits of the card number.
            "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
            "phoneNumber": "A String", # The billing phone number.
            "billingAddress": { # The billing address.
              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
              "country": "A String", # CLDR country code (e.g. "US").
              "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                  # John Smith
                  # 1600 Amphitheatre Parkway
                  # Mountain View, CA, 94043
                  # United States
                "A String",
              ],
              "streetAddress": [ # Street-level part of the address.
                "A String",
              ],
              "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
              "recipientName": "A String", # Name of the recipient.
              "isPostOfficeBox": True or False, # Whether the address is a post office box.
              "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
            },
            "type": "A String", # The type of instrument (VISA, Mastercard, etc).
          },
          "shippingCost": { # The total cost of shipping for all items.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "acknowledged": True or False, # Whether the order was acknowledged.
          "paymentStatus": "A String", # The status of the payment.
          "merchantId": "A String",
          "merchantOrderId": "A String", # Merchant-provided id of the order.
          "shippingOption": "A String", # The requested shipping option.
          "status": "A String", # The status of the order.
          "deliveryDetails": { # The details for the delivery.
            "phoneNumber": "A String", # The phone number of the person receiving the delivery.
            "address": { # The delivery address
              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
              "country": "A String", # CLDR country code (e.g. "US").
              "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                  # John Smith
                  # 1600 Amphitheatre Parkway
                  # Mountain View, CA, 94043
                  # United States
                "A String",
              ],
              "streetAddress": [ # Street-level part of the address.
                "A String",
              ],
              "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
              "recipientName": "A String", # Name of the recipient.
              "isPostOfficeBox": True or False, # Whether the address is a post office box.
              "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
            },
          },
          "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
          "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
          "lineItems": [ # Line items that are ordered.
            {
              "product": { # Product data from the time of the order placement.
                "targetCountry": "A String", # The CLDR territory code of the target country of the product.
                "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
                "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
                "title": "A String", # The title of the product.
                "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
                "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
                  {
                    "dimension": "A String", # The dimension of the variant.
                    "value": "A String", # The value for the dimension.
                  },
                ],
                "brand": "A String", # Brand of the item.
                "itemGroupId": "A String", # Shared identifier for all variants of the same product.
                "offerId": "A String", # An identifier of the item.
                "price": { # Price of the item.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "imageLink": "A String", # URL of an image of the item.
                "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
                "channel": "A String", # The item's channel (online or local).
                "id": "A String", # The REST id of the product.
                "condition": "A String", # Condition or state of the item.
              },
              "quantityDelivered": 42, # Number of items delivered.
              "returnInfo": { # Details of the return policy for the line item.
                "policyUrl": "A String", # URL of the item return policy.
                "isReturnable": True or False, # Whether the item is returnable.
                "daysToReturn": 42, # How many days later the item can be returned.
              },
              "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "quantityPending": 42, # Number of items pending.
              "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "cancellations": [ # Cancellations of the line item.
                {
                  "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
                  "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
                  "reasonText": "A String", # The explanation of the reason.
                  "actor": "A String", # The actor that created the cancellation.
                  "quantity": 42, # The quantity that was canceled.
                },
              ],
              "quantityCanceled": 42, # Number of items canceled.
              "quantityOrdered": 42, # Number of items ordered.
              "returns": [ # Returns of the line item.
                {
                  "reason": "A String", # The reason for the return.
                  "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
                  "reasonText": "A String", # The explanation of the reason.
                  "actor": "A String", # The actor that created the refund.
                  "quantity": 42, # Quantity that is returned.
                },
              ],
              "quantityShipped": 42, # Number of items shipped.
              "quantityReturned": 42, # Number of items returned.
              "id": "A String", # The id of the line item.
              "shippingDetails": { # Details of the requested shipping for the line item.
                "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
                "method": { # Details of the shipping method.
                  "minDaysInTransit": 42, # Minimum transit time.
                  "carrier": "A String", # The carrier for the shipping. Optional.
                  "methodName": "A String", # The name of the shipping method.
                  "maxDaysInTransit": 42, # Maximum transit time.
                },
                "shipByDate": "A String", # The ship by date, in ISO 8601 format.
              },
            },
          ],
          "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "id": "A String", # The REST id of the order. Globally unique.
        },
        "executionStatus": "A String", # The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful.
      },
    ],
  }
get(merchantId, orderId) 
Retrieves an order from your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)

Returns:
  An object of the form:

    {
    "customer": { # The details of the customer who placed the order.
      "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
      "fullName": "A String", # Full name of the customer.
      "email": "A String", # Email address of the customer.
    },
    "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
      {
        "benefits": [
          {
            "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
              "A String",
            ],
            "discount": { # The discount in the order price when the promotion is applied.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
            "taxImpact": { # The impact on tax when the promotion is applied.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
          },
        ],
        "longTitle": "A String", # The full title of the promotion.
        "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
        "redemptionChannel": "A String", # Indicates that the promotion is valid online.
        "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
        "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
            # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
        "id": "A String", # The unique ID of the promotion.
      },
    ],
    "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
    "shippingCostTax": { # The tax for the total shipping cost.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "shipments": [ # Shipments of the order.
      {
        "status": "A String", # The status of the shipment.
        "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
        "carrier": "A String", # The carrier handling the shipment.
        "trackingId": "A String", # The tracking id for the shipment.
        "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
        "lineItems": [ # The line items that are shipped.
          {
            "lineItemId": "A String", # The id of the line item that is shipped.
            "quantity": 42, # The quantity that is shipped.
          },
        ],
        "id": "A String", # The id of the shipment.
      },
    ],
    "refunds": [ # Refunds for the order.
      {
        "amount": { # The amount that is refunded.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
        "reason": "A String", # The reason for the refund.
        "actor": "A String", # The actor that created the refund.
        "reasonText": "A String", # The explanation of the reason.
      },
    ],
    "paymentMethod": { # The details of the payment method.
      "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
      "lastFourDigits": "A String", # The last four digits of the card number.
      "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
      "phoneNumber": "A String", # The billing phone number.
      "billingAddress": { # The billing address.
        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
        "country": "A String", # CLDR country code (e.g. "US").
        "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
            # John Smith
            # 1600 Amphitheatre Parkway
            # Mountain View, CA, 94043
            # United States
          "A String",
        ],
        "streetAddress": [ # Street-level part of the address.
          "A String",
        ],
        "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
        "recipientName": "A String", # Name of the recipient.
        "isPostOfficeBox": True or False, # Whether the address is a post office box.
        "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
      },
      "type": "A String", # The type of instrument (VISA, Mastercard, etc).
    },
    "shippingCost": { # The total cost of shipping for all items.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "acknowledged": True or False, # Whether the order was acknowledged.
    "paymentStatus": "A String", # The status of the payment.
    "merchantId": "A String",
    "merchantOrderId": "A String", # Merchant-provided id of the order.
    "shippingOption": "A String", # The requested shipping option.
    "status": "A String", # The status of the order.
    "deliveryDetails": { # The details for the delivery.
      "phoneNumber": "A String", # The phone number of the person receiving the delivery.
      "address": { # The delivery address
        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
        "country": "A String", # CLDR country code (e.g. "US").
        "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
            # John Smith
            # 1600 Amphitheatre Parkway
            # Mountain View, CA, 94043
            # United States
          "A String",
        ],
        "streetAddress": [ # Street-level part of the address.
          "A String",
        ],
        "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
        "recipientName": "A String", # Name of the recipient.
        "isPostOfficeBox": True or False, # Whether the address is a post office box.
        "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
      },
    },
    "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
    "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
    "lineItems": [ # Line items that are ordered.
      {
        "product": { # Product data from the time of the order placement.
          "targetCountry": "A String", # The CLDR territory code of the target country of the product.
          "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
          "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
          "title": "A String", # The title of the product.
          "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
          "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
            {
              "dimension": "A String", # The dimension of the variant.
              "value": "A String", # The value for the dimension.
            },
          ],
          "brand": "A String", # Brand of the item.
          "itemGroupId": "A String", # Shared identifier for all variants of the same product.
          "offerId": "A String", # An identifier of the item.
          "price": { # Price of the item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "imageLink": "A String", # URL of an image of the item.
          "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
          "channel": "A String", # The item's channel (online or local).
          "id": "A String", # The REST id of the product.
          "condition": "A String", # Condition or state of the item.
        },
        "quantityDelivered": 42, # Number of items delivered.
        "returnInfo": { # Details of the return policy for the line item.
          "policyUrl": "A String", # URL of the item return policy.
          "isReturnable": True or False, # Whether the item is returnable.
          "daysToReturn": 42, # How many days later the item can be returned.
        },
        "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "quantityPending": 42, # Number of items pending.
        "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "cancellations": [ # Cancellations of the line item.
          {
            "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
            "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
            "reasonText": "A String", # The explanation of the reason.
            "actor": "A String", # The actor that created the cancellation.
            "quantity": 42, # The quantity that was canceled.
          },
        ],
        "quantityCanceled": 42, # Number of items canceled.
        "quantityOrdered": 42, # Number of items ordered.
        "returns": [ # Returns of the line item.
          {
            "reason": "A String", # The reason for the return.
            "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
            "reasonText": "A String", # The explanation of the reason.
            "actor": "A String", # The actor that created the refund.
            "quantity": 42, # Quantity that is returned.
          },
        ],
        "quantityShipped": 42, # Number of items shipped.
        "quantityReturned": 42, # Number of items returned.
        "id": "A String", # The id of the line item.
        "shippingDetails": { # Details of the requested shipping for the line item.
          "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
          "method": { # Details of the shipping method.
            "minDaysInTransit": 42, # Minimum transit time.
            "carrier": "A String", # The carrier for the shipping. Optional.
            "methodName": "A String", # The name of the shipping method.
            "maxDaysInTransit": 42, # Maximum transit time.
          },
          "shipByDate": "A String", # The ship by date, in ISO 8601 format.
        },
      },
    ],
    "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "id": "A String", # The REST id of the order. Globally unique.
  }
getbymerchantorderid(merchantId, merchantOrderId) 
Retrieves an order using merchant order id.

Args:
  merchantId: string, The ID of the managing account. (required)
  merchantOrderId: string, The merchant order id to be looked for. (required)

Returns:
  An object of the form:

    {
    "kind": "content#ordersGetByMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
    "order": { # The requested order.
      "customer": { # The details of the customer who placed the order.
        "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
        "fullName": "A String", # Full name of the customer.
        "email": "A String", # Email address of the customer.
      },
      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
        {
          "benefits": [
            {
              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                "A String",
              ],
              "discount": { # The discount in the order price when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
              "taxImpact": { # The impact on tax when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
            },
          ],
          "longTitle": "A String", # The full title of the promotion.
          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
          "id": "A String", # The unique ID of the promotion.
        },
      ],
      "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
      "shippingCostTax": { # The tax for the total shipping cost.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "shipments": [ # Shipments of the order.
        {
          "status": "A String", # The status of the shipment.
          "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
          "carrier": "A String", # The carrier handling the shipment.
          "trackingId": "A String", # The tracking id for the shipment.
          "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
          "lineItems": [ # The line items that are shipped.
            {
              "lineItemId": "A String", # The id of the line item that is shipped.
              "quantity": 42, # The quantity that is shipped.
            },
          ],
          "id": "A String", # The id of the shipment.
        },
      ],
      "refunds": [ # Refunds for the order.
        {
          "amount": { # The amount that is refunded.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
          "reason": "A String", # The reason for the refund.
          "actor": "A String", # The actor that created the refund.
          "reasonText": "A String", # The explanation of the reason.
        },
      ],
      "paymentMethod": { # The details of the payment method.
        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
        "lastFourDigits": "A String", # The last four digits of the card number.
        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
        "phoneNumber": "A String", # The billing phone number.
        "billingAddress": { # The billing address.
          "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
          "country": "A String", # CLDR country code (e.g. "US").
          "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
              # John Smith
              # 1600 Amphitheatre Parkway
              # Mountain View, CA, 94043
              # United States
            "A String",
          ],
          "streetAddress": [ # Street-level part of the address.
            "A String",
          ],
          "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
          "recipientName": "A String", # Name of the recipient.
          "isPostOfficeBox": True or False, # Whether the address is a post office box.
          "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
        },
        "type": "A String", # The type of instrument (VISA, Mastercard, etc).
      },
      "shippingCost": { # The total cost of shipping for all items.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "acknowledged": True or False, # Whether the order was acknowledged.
      "paymentStatus": "A String", # The status of the payment.
      "merchantId": "A String",
      "merchantOrderId": "A String", # Merchant-provided id of the order.
      "shippingOption": "A String", # The requested shipping option.
      "status": "A String", # The status of the order.
      "deliveryDetails": { # The details for the delivery.
        "phoneNumber": "A String", # The phone number of the person receiving the delivery.
        "address": { # The delivery address
          "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
          "country": "A String", # CLDR country code (e.g. "US").
          "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
              # John Smith
              # 1600 Amphitheatre Parkway
              # Mountain View, CA, 94043
              # United States
            "A String",
          ],
          "streetAddress": [ # Street-level part of the address.
            "A String",
          ],
          "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
          "recipientName": "A String", # Name of the recipient.
          "isPostOfficeBox": True or False, # Whether the address is a post office box.
          "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
        },
      },
      "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
      "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
      "lineItems": [ # Line items that are ordered.
        {
          "product": { # Product data from the time of the order placement.
            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
            "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "title": "A String", # The title of the product.
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
            "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
              {
                "dimension": "A String", # The dimension of the variant.
                "value": "A String", # The value for the dimension.
              },
            ],
            "brand": "A String", # Brand of the item.
            "itemGroupId": "A String", # Shared identifier for all variants of the same product.
            "offerId": "A String", # An identifier of the item.
            "price": { # Price of the item.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "imageLink": "A String", # URL of an image of the item.
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
            "channel": "A String", # The item's channel (online or local).
            "id": "A String", # The REST id of the product.
            "condition": "A String", # Condition or state of the item.
          },
          "quantityDelivered": 42, # Number of items delivered.
          "returnInfo": { # Details of the return policy for the line item.
            "policyUrl": "A String", # URL of the item return policy.
            "isReturnable": True or False, # Whether the item is returnable.
            "daysToReturn": 42, # How many days later the item can be returned.
          },
          "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantityPending": 42, # Number of items pending.
          "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "cancellations": [ # Cancellations of the line item.
            {
              "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
              "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
              "reasonText": "A String", # The explanation of the reason.
              "actor": "A String", # The actor that created the cancellation.
              "quantity": 42, # The quantity that was canceled.
            },
          ],
          "quantityCanceled": 42, # Number of items canceled.
          "quantityOrdered": 42, # Number of items ordered.
          "returns": [ # Returns of the line item.
            {
              "reason": "A String", # The reason for the return.
              "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
              "reasonText": "A String", # The explanation of the reason.
              "actor": "A String", # The actor that created the refund.
              "quantity": 42, # Quantity that is returned.
            },
          ],
          "quantityShipped": 42, # Number of items shipped.
          "quantityReturned": 42, # Number of items returned.
          "id": "A String", # The id of the line item.
          "shippingDetails": { # Details of the requested shipping for the line item.
            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
            "method": { # Details of the shipping method.
              "minDaysInTransit": 42, # Minimum transit time.
              "carrier": "A String", # The carrier for the shipping. Optional.
              "methodName": "A String", # The name of the shipping method.
              "maxDaysInTransit": 42, # Maximum transit time.
            },
            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
          },
        },
      ],
      "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "id": "A String", # The REST id of the order. Globally unique.
    },
  }
gettestordertemplate(merchantId, templateName) 
Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Args:
  merchantId: string, The ID of the managing account. (required)
  templateName: string, The name of the template to retrieve. (required)
    Allowed values
      template1 - 
      template1a - 
      template1b - 
      template2 - 

Returns:
  An object of the form:

    {
    "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
    "template": { # The requested test order template.
      "customer": { # The details of the customer who placed the order.
        "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
        "fullName": "A String", # Full name of the customer.
        "email": "A String", # Email address of the customer.
      },
      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
        {
          "benefits": [
            {
              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                "A String",
              ],
              "discount": { # The discount in the order price when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
              "taxImpact": { # The impact on tax when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
            },
          ],
          "longTitle": "A String", # The full title of the promotion.
          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
          "id": "A String", # The unique ID of the promotion.
        },
      ],
      "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
      "shippingCostTax": { # The tax for the total shipping cost.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
      "shippingCost": { # The total cost of shipping for all items.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "shippingOption": "A String", # The requested shipping option.
      "lineItems": [ # Line items that are ordered. At least one line item must be provided.
        {
          "returnInfo": { # Details of the return policy for the line item.
            "policyUrl": "A String", # URL of the item return policy.
            "isReturnable": True or False, # Whether the item is returnable.
            "daysToReturn": 42, # How many days later the item can be returned.
          },
          "product": { # Product data from the time of the order placement.
            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "title": "A String", # The title of the product.
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
            "variantAttributes": [ # Variant attributes for the item. Optional.
              {
                "dimension": "A String", # The dimension of the variant.
                "value": "A String", # The value for the dimension.
              },
            ],
            "brand": "A String", # Brand of the item.
            "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
            "offerId": "A String", # An identifier of the item.
            "imageLink": "A String", # URL of an image of the item.
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
            "channel": "A String", # The item's channel.
            "price": { # The price for the product.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": "A String", # Condition or state of the item.
          },
          "unitTax": { # Unit tax for the line item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantityOrdered": 42, # Number of items ordered.
          "shippingDetails": { # Details of the requested shipping for the line item.
            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
            "method": { # Details of the shipping method.
              "minDaysInTransit": 42, # Minimum transit time.
              "carrier": "A String", # The carrier for the shipping. Optional.
              "methodName": "A String", # The name of the shipping method.
              "maxDaysInTransit": 42, # Maximum transit time.
            },
            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
          },
        },
      ],
      "paymentMethod": { # The details of the payment method.
        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
        "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
        "lastFourDigits": "A String", # The last four digits of the card number.
        "predefinedBillingAddress": "A String", # The billing address.
      },
    },
  }
list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None) 
Lists the orders in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderBy: string, The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.
    Allowed values
      placedDate asc - 
      placedDate desc - 
  pageToken: string, The token returned by the previous request.
  placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format.
  acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.
  maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
Known issue: All List calls will return all Orders without limit regardless of the value of this field.
  placedDateStart: string, Obtains orders placed after this date (inclusively), in ISO 8601 format.
  statuses: string, Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. (repeated)
    Allowed values
      active - 
      canceled - 
      completed - 
      delivered - 
      inProgress - 
      partiallyDelivered - 
      partiallyReturned - 
      partiallyShipped - 
      pendingShipment - 
      returned - 
      shipped - 

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
    "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
    "resources": [
      {
        "customer": { # The details of the customer who placed the order.
          "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
          "fullName": "A String", # Full name of the customer.
          "email": "A String", # Email address of the customer.
        },
        "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
          {
            "benefits": [
              {
                "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                  "A String",
                ],
                "discount": { # The discount in the order price when the promotion is applied.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
                "taxImpact": { # The impact on tax when the promotion is applied.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
              },
            ],
            "longTitle": "A String", # The full title of the promotion.
            "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
            "redemptionChannel": "A String", # Indicates that the promotion is valid online.
            "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
            "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
                # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
            "id": "A String", # The unique ID of the promotion.
          },
        ],
        "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
        "shippingCostTax": { # The tax for the total shipping cost.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "shipments": [ # Shipments of the order.
          {
            "status": "A String", # The status of the shipment.
            "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
            "carrier": "A String", # The carrier handling the shipment.
            "trackingId": "A String", # The tracking id for the shipment.
            "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
            "lineItems": [ # The line items that are shipped.
              {
                "lineItemId": "A String", # The id of the line item that is shipped.
                "quantity": 42, # The quantity that is shipped.
              },
            ],
            "id": "A String", # The id of the shipment.
          },
        ],
        "refunds": [ # Refunds for the order.
          {
            "amount": { # The amount that is refunded.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
            "reason": "A String", # The reason for the refund.
            "actor": "A String", # The actor that created the refund.
            "reasonText": "A String", # The explanation of the reason.
          },
        ],
        "paymentMethod": { # The details of the payment method.
          "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
          "lastFourDigits": "A String", # The last four digits of the card number.
          "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
          "phoneNumber": "A String", # The billing phone number.
          "billingAddress": { # The billing address.
            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
            "country": "A String", # CLDR country code (e.g. "US").
            "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                # John Smith
                # 1600 Amphitheatre Parkway
                # Mountain View, CA, 94043
                # United States
              "A String",
            ],
            "streetAddress": [ # Street-level part of the address.
              "A String",
            ],
            "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
            "recipientName": "A String", # Name of the recipient.
            "isPostOfficeBox": True or False, # Whether the address is a post office box.
            "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
          },
          "type": "A String", # The type of instrument (VISA, Mastercard, etc).
        },
        "shippingCost": { # The total cost of shipping for all items.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "acknowledged": True or False, # Whether the order was acknowledged.
        "paymentStatus": "A String", # The status of the payment.
        "merchantId": "A String",
        "merchantOrderId": "A String", # Merchant-provided id of the order.
        "shippingOption": "A String", # The requested shipping option.
        "status": "A String", # The status of the order.
        "deliveryDetails": { # The details for the delivery.
          "phoneNumber": "A String", # The phone number of the person receiving the delivery.
          "address": { # The delivery address
            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
            "country": "A String", # CLDR country code (e.g. "US").
            "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                # John Smith
                # 1600 Amphitheatre Parkway
                # Mountain View, CA, 94043
                # United States
              "A String",
            ],
            "streetAddress": [ # Street-level part of the address.
              "A String",
            ],
            "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
            "recipientName": "A String", # Name of the recipient.
            "isPostOfficeBox": True or False, # Whether the address is a post office box.
            "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
          },
        },
        "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
        "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
        "lineItems": [ # Line items that are ordered.
          {
            "product": { # Product data from the time of the order placement.
              "targetCountry": "A String", # The CLDR territory code of the target country of the product.
              "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
              "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
              "title": "A String", # The title of the product.
              "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
              "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
                {
                  "dimension": "A String", # The dimension of the variant.
                  "value": "A String", # The value for the dimension.
                },
              ],
              "brand": "A String", # Brand of the item.
              "itemGroupId": "A String", # Shared identifier for all variants of the same product.
              "offerId": "A String", # An identifier of the item.
              "price": { # Price of the item.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "imageLink": "A String", # URL of an image of the item.
              "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
              "channel": "A String", # The item's channel (online or local).
              "id": "A String", # The REST id of the product.
              "condition": "A String", # Condition or state of the item.
            },
            "quantityDelivered": 42, # Number of items delivered.
            "returnInfo": { # Details of the return policy for the line item.
              "policyUrl": "A String", # URL of the item return policy.
              "isReturnable": True or False, # Whether the item is returnable.
              "daysToReturn": 42, # How many days later the item can be returned.
            },
            "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "quantityPending": 42, # Number of items pending.
            "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "cancellations": [ # Cancellations of the line item.
              {
                "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
                "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
                "reasonText": "A String", # The explanation of the reason.
                "actor": "A String", # The actor that created the cancellation.
                "quantity": 42, # The quantity that was canceled.
              },
            ],
            "quantityCanceled": 42, # Number of items canceled.
            "quantityOrdered": 42, # Number of items ordered.
            "returns": [ # Returns of the line item.
              {
                "reason": "A String", # The reason for the return.
                "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
                "reasonText": "A String", # The explanation of the reason.
                "actor": "A String", # The actor that created the refund.
                "quantity": 42, # Quantity that is returned.
              },
            ],
            "quantityShipped": 42, # Number of items shipped.
            "quantityReturned": 42, # Number of items returned.
            "id": "A String", # The id of the line item.
            "shippingDetails": { # Details of the requested shipping for the line item.
              "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
              "method": { # Details of the shipping method.
                "minDaysInTransit": 42, # Minimum transit time.
                "carrier": "A String", # The carrier for the shipping. Optional.
                "methodName": "A String", # The name of the shipping method.
                "maxDaysInTransit": 42, # Maximum transit time.
              },
              "shipByDate": "A String", # The ship by date, in ISO 8601 format.
            },
          },
        ],
        "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "id": "A String", # The REST id of the order. Globally unique.
      },
    ],
  }
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.
refund(merchantId, orderId, body) 
Refund a portion of the order, up to the full amount paid.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order to refund. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "amount": { # The amount that is refunded.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "reasonText": "A String", # The explanation of the reason.
    "reason": "A String", # The reason for the refund.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".
    "executionStatus": "A String", # The status of the execution.
  }
returnlineitem(merchantId, orderId, body) 
Returns a line item.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "reason": "A String", # The reason for the return.
    "quantity": 42, # The quantity to return.
    "reasonText": "A String", # The explanation of the reason.
    "lineItemId": "A String", # The ID of the line item to return.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".
    "executionStatus": "A String", # The status of the execution.
  }
shiplineitems(merchantId, orderId, body) 
Marks line item(s) as shipped.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "lineItems": [ # Line items to ship.
      {
        "lineItemId": "A String", # The id of the line item that is shipped.
        "quantity": 42, # The quantity that is shipped.
      },
    ],
    "carrier": "A String", # The carrier handling the shipment.
    "shipmentId": "A String", # The ID of the shipment.
    "trackingId": "A String", # The tracking id for the shipment.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
    "executionStatus": "A String", # The status of the execution.
  }
updatemerchantorderid(merchantId, orderId, body) 
Updates the merchant order ID for a given order.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
    "executionStatus": "A String", # The status of the execution.
  }
updateshipment(merchantId, orderId, body) 
Updates a shipment's status, carrier, and/or tracking ID.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "status": "A String", # New status for the shipment. Not updated if missing.
    "shipmentId": "A String", # The ID of the shipment.
    "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
    "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
    "executionStatus": "A String", # The status of the execution.
  }
google-api-python-client-1.5.5/docs/dyn/content_v2.products.html000066400000000000000000002507401300622755700247120ustar00rootroot00000000000000

Content API for Shopping . products

Instance Methods

custombatch(body, dryRun=None)

Retrieves, inserts, and deletes multiple products in a single request.

delete(merchantId, productId, dryRun=None)

Deletes a product from your Merchant Center account.

get(merchantId, productId)

Retrieves a product from your Merchant Center account.

insert(merchantId, body, dryRun=None)

Uploads a product to your Merchant Center account.

list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None)

Lists the products in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

custombatch(body, dryRun=None) 
Retrieves, inserts, and deletes multiple products in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch products request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "product": { # Product data. # The product to insert. Only required if the method is insert.
            "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
            "color": "A String", # Color of the item.
            "availability": "A String", # Availability status of the item.
            "additionalImageLinks": [ # Additional URLs of images of the item.
              "A String",
            ],
            "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
              "A String",
            ],
            "itemGroupId": "A String", # Shared identifier for all variants of the same product.
            "promotionIds": [ # The unique ID of a promotion.
              "A String",
            ],
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
            "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
            "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
            "id": "A String", # The REST id of the product.
            "multipack": "A String", # The number of identical products in a merchant-defined multipack.
            "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
            "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
            "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
            "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
            "destinations": [ # Specifies the intended destinations for the product.
              {
                "intention": "A String", # Whether the destination is required, excluded or should be validated.
                "destinationName": "A String", # The name of the destination.
              },
            ],
            "targetCountry": "A String", # The CLDR territory code for the item.
            "sizeType": "A String", # The cut of the item. Recommended for apparel items.
            "offerId": "A String", # An identifier of the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.
            "shippingWidth": { # Width of the item for shipping.
              "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
                  #
                  # Acceptable values are:
                  # - "cm"
                  # - "in"
            },
            "additionalProductTypes": [ # Additional categories of the item (formatted as in products feed specification).
              "A String",
            ],
            "unitPricingMeasure": { # The measure and dimension of an item.
              "value": 3.14, # The measure of an item.
              "unit": "A String", # The unit of the measure.
            },
            "imageLink": "A String", # URL of an image of the item.
            "validatedDestinations": [ # The read-only list of intended destinations which passed validation.
              "A String",
            ],
            "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
            "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
            "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
            "mobileLink": "A String", # Link to a mobile-optimized version of the landing page.
            "price": { # Price of the item.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "channel": "A String", # The item's channel (online or local).
            "onlineOnly": True or False, # Whether an item is available for purchase only online.
            "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
              "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
              "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
              "pointsValue": "A String", # The retailer's loyalty points in absolute value.
            },
            "aspects": [ # Specifies the intended aspects for the product.
              {
                "intention": "A String", # Whether the aspect is required, excluded or should be validated.
                "aspectName": "A String", # The name of the aspect.
                "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
              },
            ],
            "description": "A String", # Description of the item.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "warnings": [ # Read-only warnings.
              { # An error returned by the API.
                "reason": "A String", # The error code.
                "domain": "A String", # The domain of the error.
                "message": "A String", # A description of the error.
              },
            ],
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
            "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products feed specification).
            "brand": "A String", # Brand of the item.
            "material": "A String", # The material of which the item is made.
            "shippingLength": { # Length of the item for shipping.
              "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
                  #
                  # Acceptable values are:
                  # - "cm"
                  # - "in"
            },
            "taxes": [ # Tax information.
              {
                "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
                "region": "A String", # The geographic region to which the tax rate applies.
                "rate": 3.14, # The percentage of tax rate that applies to the item price.
                "locationId": "A String", # The numeric id of a location that the tax rate applies to as defined in the AdWords API.
                "postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
                "taxShip": True or False, # Set to true if tax is charged on shipping.
              },
            ],
            "shippingHeight": { # Height of the item for shipping.
              "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
                  #
                  # Acceptable values are:
                  # - "cm"
                  # - "in"
            },
            "sellOnGoogleQuantity": "A String", # The quantity of the product that is reserved for sell-on-google ads.
            "link": "A String", # URL directly linking to your item's page on your website.
            "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
            "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
            "energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
            "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
            "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
            "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
            "customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
              {
                "attributes": [ # The sub-attributes.
                  {
                    "value": "A String", # The value of the attribute.
                    "type": "A String", # The type of the attribute.
                    "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                    "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
                  },
                ],
                "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
              },
            ],
            "condition": "A String", # Condition or state of the item.
            "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
            "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
            "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "content#product".
            "unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
              "value": "A String", # The denominator of the unit price.
              "unit": "A String", # The unit of the denominator.
            },
            "installment": { # Number and amount of installments to pay for an item. Brazil only.
              "amount": { # The amount the buyer has to pay per month.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "months": "A String", # The number of installments the buyer has to pay.
            },
            "sizes": [ # Size of the item.
              "A String",
            ],
            "gender": "A String", # Target gender of the item.
            "title": "A String", # Title of the item.
            "shipping": [ # Shipping rules.
              {
                "service": "A String", # A free-form description of the service class or delivery speed.
                "country": "A String", # The CLDR territory code of the country to which an item will ship.
                "price": { # Fixed shipping price, represented as a number.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "locationId": "A String", # The numeric id of a location that the shipping rate applies to as defined in the AdWords API.
                "postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
                "region": "A String", # The geographic region to which a shipping rate applies (e.g. zip code).
                "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
              },
            ],
            "shippingWeight": { # Weight of the item for shipping.
              "value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
            },
            "identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
            "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
              {
                "value": "A String", # The value of the attribute.
                "type": "A String", # The type of the attribute.
                "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
              },
            ],
            "salePrice": { # Advertised sale price of the item.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "productType": "A String", # Your category of the item (formatted as in products feed specification).
            "pattern": "A String", # The item's pattern (e.g. polka dots).
            "displayAdsSimilarIds": [ # Advertiser-specified recommendations.
              "A String",
            ],
            "ageGroup": "A String", # Target age group of the item.
            "adult": True or False, # Set to true if the item is targeted towards adults.
          },
        "productId": "A String", # The ID of the product to get or delete. Only defined if the method is get or delete.
        "merchantId": "A String", # The ID of the managing account.
        "method": "A String",
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#productsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch products response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "kind": "content#productsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "product": { # Product data. # The inserted product. Only defined if the method is insert and if the request was successful.
            "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
            "color": "A String", # Color of the item.
            "availability": "A String", # Availability status of the item.
            "additionalImageLinks": [ # Additional URLs of images of the item.
              "A String",
            ],
            "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
              "A String",
            ],
            "itemGroupId": "A String", # Shared identifier for all variants of the same product.
            "promotionIds": [ # The unique ID of a promotion.
              "A String",
            ],
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
            "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
            "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
            "id": "A String", # The REST id of the product.
            "multipack": "A String", # The number of identical products in a merchant-defined multipack.
            "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
            "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
            "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
            "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
            "destinations": [ # Specifies the intended destinations for the product.
              {
                "intention": "A String", # Whether the destination is required, excluded or should be validated.
                "destinationName": "A String", # The name of the destination.
              },
            ],
            "targetCountry": "A String", # The CLDR territory code for the item.
            "sizeType": "A String", # The cut of the item. Recommended for apparel items.
            "offerId": "A String", # An identifier of the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.
            "shippingWidth": { # Width of the item for shipping.
              "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
                  #
                  # Acceptable values are:
                  # - "cm"
                  # - "in"
            },
            "additionalProductTypes": [ # Additional categories of the item (formatted as in products feed specification).
              "A String",
            ],
            "unitPricingMeasure": { # The measure and dimension of an item.
              "value": 3.14, # The measure of an item.
              "unit": "A String", # The unit of the measure.
            },
            "imageLink": "A String", # URL of an image of the item.
            "validatedDestinations": [ # The read-only list of intended destinations which passed validation.
              "A String",
            ],
            "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
            "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
            "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
            "mobileLink": "A String", # Link to a mobile-optimized version of the landing page.
            "price": { # Price of the item.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "channel": "A String", # The item's channel (online or local).
            "onlineOnly": True or False, # Whether an item is available for purchase only online.
            "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
              "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
              "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
              "pointsValue": "A String", # The retailer's loyalty points in absolute value.
            },
            "aspects": [ # Specifies the intended aspects for the product.
              {
                "intention": "A String", # Whether the aspect is required, excluded or should be validated.
                "aspectName": "A String", # The name of the aspect.
                "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
              },
            ],
            "description": "A String", # Description of the item.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "warnings": [ # Read-only warnings.
              { # An error returned by the API.
                "reason": "A String", # The error code.
                "domain": "A String", # The domain of the error.
                "message": "A String", # A description of the error.
              },
            ],
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
            "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products feed specification).
            "brand": "A String", # Brand of the item.
            "material": "A String", # The material of which the item is made.
            "shippingLength": { # Length of the item for shipping.
              "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
                  #
                  # Acceptable values are:
                  # - "cm"
                  # - "in"
            },
            "taxes": [ # Tax information.
              {
                "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
                "region": "A String", # The geographic region to which the tax rate applies.
                "rate": 3.14, # The percentage of tax rate that applies to the item price.
                "locationId": "A String", # The numeric id of a location that the tax rate applies to as defined in the AdWords API.
                "postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
                "taxShip": True or False, # Set to true if tax is charged on shipping.
              },
            ],
            "shippingHeight": { # Height of the item for shipping.
              "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
                  #
                  # Acceptable values are:
                  # - "cm"
                  # - "in"
            },
            "sellOnGoogleQuantity": "A String", # The quantity of the product that is reserved for sell-on-google ads.
            "link": "A String", # URL directly linking to your item's page on your website.
            "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
            "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
            "energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
            "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
            "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
            "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
            "customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
              {
                "attributes": [ # The sub-attributes.
                  {
                    "value": "A String", # The value of the attribute.
                    "type": "A String", # The type of the attribute.
                    "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                    "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
                  },
                ],
                "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
              },
            ],
            "condition": "A String", # Condition or state of the item.
            "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
            "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
            "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "content#product".
            "unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
              "value": "A String", # The denominator of the unit price.
              "unit": "A String", # The unit of the denominator.
            },
            "installment": { # Number and amount of installments to pay for an item. Brazil only.
              "amount": { # The amount the buyer has to pay per month.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "months": "A String", # The number of installments the buyer has to pay.
            },
            "sizes": [ # Size of the item.
              "A String",
            ],
            "gender": "A String", # Target gender of the item.
            "title": "A String", # Title of the item.
            "shipping": [ # Shipping rules.
              {
                "service": "A String", # A free-form description of the service class or delivery speed.
                "country": "A String", # The CLDR territory code of the country to which an item will ship.
                "price": { # Fixed shipping price, represented as a number.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "locationId": "A String", # The numeric id of a location that the shipping rate applies to as defined in the AdWords API.
                "postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
                "region": "A String", # The geographic region to which a shipping rate applies (e.g. zip code).
                "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
              },
            ],
            "shippingWeight": { # Weight of the item for shipping.
              "value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
              "unit": "A String", # The unit of value.
            },
            "identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
            "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
              {
                "value": "A String", # The value of the attribute.
                "type": "A String", # The type of the attribute.
                "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
              },
            ],
            "salePrice": { # Advertised sale price of the item.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "productType": "A String", # Your category of the item (formatted as in products feed specification).
            "pattern": "A String", # The item's pattern (e.g. polka dots).
            "displayAdsSimilarIds": [ # Advertiser-specified recommendations.
              "A String",
            ],
            "ageGroup": "A String", # Target age group of the item.
            "adult": True or False, # Set to true if the item is targeted towards adults.
          },
      },
    ],
  }
delete(merchantId, productId, dryRun=None) 
Deletes a product from your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  productId: string, The ID of the product. (required)
  dryRun: boolean, Flag to run the request in dry-run mode.
get(merchantId, productId) 
Retrieves a product from your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  productId: string, The ID of the product. (required)

Returns:
  An object of the form:

    { # Product data.
      "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
      "color": "A String", # Color of the item.
      "availability": "A String", # Availability status of the item.
      "additionalImageLinks": [ # Additional URLs of images of the item.
        "A String",
      ],
      "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
        "A String",
      ],
      "itemGroupId": "A String", # Shared identifier for all variants of the same product.
      "promotionIds": [ # The unique ID of a promotion.
        "A String",
      ],
      "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
      "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
      "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
      "id": "A String", # The REST id of the product.
      "multipack": "A String", # The number of identical products in a merchant-defined multipack.
      "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
      "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
      "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
      "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
      "destinations": [ # Specifies the intended destinations for the product.
        {
          "intention": "A String", # Whether the destination is required, excluded or should be validated.
          "destinationName": "A String", # The name of the destination.
        },
      ],
      "targetCountry": "A String", # The CLDR territory code for the item.
      "sizeType": "A String", # The cut of the item. Recommended for apparel items.
      "offerId": "A String", # An identifier of the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.
      "shippingWidth": { # Width of the item for shipping.
        "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
            #
            # Acceptable values are:
            # - "cm"
            # - "in"
      },
      "additionalProductTypes": [ # Additional categories of the item (formatted as in products feed specification).
        "A String",
      ],
      "unitPricingMeasure": { # The measure and dimension of an item.
        "value": 3.14, # The measure of an item.
        "unit": "A String", # The unit of the measure.
      },
      "imageLink": "A String", # URL of an image of the item.
      "validatedDestinations": [ # The read-only list of intended destinations which passed validation.
        "A String",
      ],
      "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
      "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
      "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
      "mobileLink": "A String", # Link to a mobile-optimized version of the landing page.
      "price": { # Price of the item.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "channel": "A String", # The item's channel (online or local).
      "onlineOnly": True or False, # Whether an item is available for purchase only online.
      "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
        "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
        "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
        "pointsValue": "A String", # The retailer's loyalty points in absolute value.
      },
      "aspects": [ # Specifies the intended aspects for the product.
        {
          "intention": "A String", # Whether the aspect is required, excluded or should be validated.
          "aspectName": "A String", # The name of the aspect.
          "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
        },
      ],
      "description": "A String", # Description of the item.
      "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
      "warnings": [ # Read-only warnings.
        { # An error returned by the API.
          "reason": "A String", # The error code.
          "domain": "A String", # The domain of the error.
          "message": "A String", # A description of the error.
        },
      ],
      "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
      "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products feed specification).
      "brand": "A String", # Brand of the item.
      "material": "A String", # The material of which the item is made.
      "shippingLength": { # Length of the item for shipping.
        "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
            #
            # Acceptable values are:
            # - "cm"
            # - "in"
      },
      "taxes": [ # Tax information.
        {
          "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
          "region": "A String", # The geographic region to which the tax rate applies.
          "rate": 3.14, # The percentage of tax rate that applies to the item price.
          "locationId": "A String", # The numeric id of a location that the tax rate applies to as defined in the AdWords API.
          "postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
          "taxShip": True or False, # Set to true if tax is charged on shipping.
        },
      ],
      "shippingHeight": { # Height of the item for shipping.
        "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
            #
            # Acceptable values are:
            # - "cm"
            # - "in"
      },
      "sellOnGoogleQuantity": "A String", # The quantity of the product that is reserved for sell-on-google ads.
      "link": "A String", # URL directly linking to your item's page on your website.
      "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
      "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
      "energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
      "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
      "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
      "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
      "customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
        {
          "attributes": [ # The sub-attributes.
            {
              "value": "A String", # The value of the attribute.
              "type": "A String", # The type of the attribute.
              "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
              "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
            },
          ],
          "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
        },
      ],
      "condition": "A String", # Condition or state of the item.
      "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
      "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
      "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "content#product".
      "unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
        "value": "A String", # The denominator of the unit price.
        "unit": "A String", # The unit of the denominator.
      },
      "installment": { # Number and amount of installments to pay for an item. Brazil only.
        "amount": { # The amount the buyer has to pay per month.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "months": "A String", # The number of installments the buyer has to pay.
      },
      "sizes": [ # Size of the item.
        "A String",
      ],
      "gender": "A String", # Target gender of the item.
      "title": "A String", # Title of the item.
      "shipping": [ # Shipping rules.
        {
          "service": "A String", # A free-form description of the service class or delivery speed.
          "country": "A String", # The CLDR territory code of the country to which an item will ship.
          "price": { # Fixed shipping price, represented as a number.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "locationId": "A String", # The numeric id of a location that the shipping rate applies to as defined in the AdWords API.
          "postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
          "region": "A String", # The geographic region to which a shipping rate applies (e.g. zip code).
          "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
        },
      ],
      "shippingWeight": { # Weight of the item for shipping.
        "value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
      },
      "identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
      "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
        {
          "value": "A String", # The value of the attribute.
          "type": "A String", # The type of the attribute.
          "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
          "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
        },
      ],
      "salePrice": { # Advertised sale price of the item.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "productType": "A String", # Your category of the item (formatted as in products feed specification).
      "pattern": "A String", # The item's pattern (e.g. polka dots).
      "displayAdsSimilarIds": [ # Advertiser-specified recommendations.
        "A String",
      ],
      "ageGroup": "A String", # Target age group of the item.
      "adult": True or False, # Set to true if the item is targeted towards adults.
    }
insert(merchantId, body, dryRun=None) 
Uploads a product to your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Product data.
    "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
    "color": "A String", # Color of the item.
    "availability": "A String", # Availability status of the item.
    "additionalImageLinks": [ # Additional URLs of images of the item.
      "A String",
    ],
    "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
      "A String",
    ],
    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
    "promotionIds": [ # The unique ID of a promotion.
      "A String",
    ],
    "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
    "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
    "id": "A String", # The REST id of the product.
    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
    "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
    "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
    "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
    "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
    "destinations": [ # Specifies the intended destinations for the product.
      {
        "intention": "A String", # Whether the destination is required, excluded or should be validated.
        "destinationName": "A String", # The name of the destination.
      },
    ],
    "targetCountry": "A String", # The CLDR territory code for the item.
    "sizeType": "A String", # The cut of the item. Recommended for apparel items.
    "offerId": "A String", # An identifier of the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.
    "shippingWidth": { # Width of the item for shipping.
      "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
      "unit": "A String", # The unit of value.
          #
          # Acceptable values are:
          # - "cm"
          # - "in"
    },
    "additionalProductTypes": [ # Additional categories of the item (formatted as in products feed specification).
      "A String",
    ],
    "unitPricingMeasure": { # The measure and dimension of an item.
      "value": 3.14, # The measure of an item.
      "unit": "A String", # The unit of the measure.
    },
    "imageLink": "A String", # URL of an image of the item.
    "validatedDestinations": [ # The read-only list of intended destinations which passed validation.
      "A String",
    ],
    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
    "mobileLink": "A String", # Link to a mobile-optimized version of the landing page.
    "price": { # Price of the item.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "channel": "A String", # The item's channel (online or local).
    "onlineOnly": True or False, # Whether an item is available for purchase only online.
    "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
      "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
      "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
      "pointsValue": "A String", # The retailer's loyalty points in absolute value.
    },
    "aspects": [ # Specifies the intended aspects for the product.
      {
        "intention": "A String", # Whether the aspect is required, excluded or should be validated.
        "aspectName": "A String", # The name of the aspect.
        "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
      },
    ],
    "description": "A String", # Description of the item.
    "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
    "warnings": [ # Read-only warnings.
      { # An error returned by the API.
        "reason": "A String", # The error code.
        "domain": "A String", # The domain of the error.
        "message": "A String", # A description of the error.
      },
    ],
    "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
    "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products feed specification).
    "brand": "A String", # Brand of the item.
    "material": "A String", # The material of which the item is made.
    "shippingLength": { # Length of the item for shipping.
      "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
      "unit": "A String", # The unit of value.
          #
          # Acceptable values are:
          # - "cm"
          # - "in"
    },
    "taxes": [ # Tax information.
      {
        "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
        "region": "A String", # The geographic region to which the tax rate applies.
        "rate": 3.14, # The percentage of tax rate that applies to the item price.
        "locationId": "A String", # The numeric id of a location that the tax rate applies to as defined in the AdWords API.
        "postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
        "taxShip": True or False, # Set to true if tax is charged on shipping.
      },
    ],
    "shippingHeight": { # Height of the item for shipping.
      "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
      "unit": "A String", # The unit of value.
          #
          # Acceptable values are:
          # - "cm"
          # - "in"
    },
    "sellOnGoogleQuantity": "A String", # The quantity of the product that is reserved for sell-on-google ads.
    "link": "A String", # URL directly linking to your item's page on your website.
    "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
    "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
    "energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
    "customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
      {
        "attributes": [ # The sub-attributes.
          {
            "value": "A String", # The value of the attribute.
            "type": "A String", # The type of the attribute.
            "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
            "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
          },
        ],
        "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
      },
    ],
    "condition": "A String", # Condition or state of the item.
    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
    "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
    "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "content#product".
    "unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
      "value": "A String", # The denominator of the unit price.
      "unit": "A String", # The unit of the denominator.
    },
    "installment": { # Number and amount of installments to pay for an item. Brazil only.
      "amount": { # The amount the buyer has to pay per month.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "months": "A String", # The number of installments the buyer has to pay.
    },
    "sizes": [ # Size of the item.
      "A String",
    ],
    "gender": "A String", # Target gender of the item.
    "title": "A String", # Title of the item.
    "shipping": [ # Shipping rules.
      {
        "service": "A String", # A free-form description of the service class or delivery speed.
        "country": "A String", # The CLDR territory code of the country to which an item will ship.
        "price": { # Fixed shipping price, represented as a number.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "locationId": "A String", # The numeric id of a location that the shipping rate applies to as defined in the AdWords API.
        "postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
        "region": "A String", # The geographic region to which a shipping rate applies (e.g. zip code).
        "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
      },
    ],
    "shippingWeight": { # Weight of the item for shipping.
      "value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
      "unit": "A String", # The unit of value.
    },
    "identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
    "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
      {
        "value": "A String", # The value of the attribute.
        "type": "A String", # The type of the attribute.
        "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
        "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
      },
    ],
    "salePrice": { # Advertised sale price of the item.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "productType": "A String", # Your category of the item (formatted as in products feed specification).
    "pattern": "A String", # The item's pattern (e.g. polka dots).
    "displayAdsSimilarIds": [ # Advertiser-specified recommendations.
      "A String",
    ],
    "ageGroup": "A String", # Target age group of the item.
    "adult": True or False, # Set to true if the item is targeted towards adults.
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # Product data.
      "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
      "color": "A String", # Color of the item.
      "availability": "A String", # Availability status of the item.
      "additionalImageLinks": [ # Additional URLs of images of the item.
        "A String",
      ],
      "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
        "A String",
      ],
      "itemGroupId": "A String", # Shared identifier for all variants of the same product.
      "promotionIds": [ # The unique ID of a promotion.
        "A String",
      ],
      "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
      "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
      "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
      "id": "A String", # The REST id of the product.
      "multipack": "A String", # The number of identical products in a merchant-defined multipack.
      "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
      "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
      "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
      "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
      "destinations": [ # Specifies the intended destinations for the product.
        {
          "intention": "A String", # Whether the destination is required, excluded or should be validated.
          "destinationName": "A String", # The name of the destination.
        },
      ],
      "targetCountry": "A String", # The CLDR territory code for the item.
      "sizeType": "A String", # The cut of the item. Recommended for apparel items.
      "offerId": "A String", # An identifier of the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.
      "shippingWidth": { # Width of the item for shipping.
        "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
            #
            # Acceptable values are:
            # - "cm"
            # - "in"
      },
      "additionalProductTypes": [ # Additional categories of the item (formatted as in products feed specification).
        "A String",
      ],
      "unitPricingMeasure": { # The measure and dimension of an item.
        "value": 3.14, # The measure of an item.
        "unit": "A String", # The unit of the measure.
      },
      "imageLink": "A String", # URL of an image of the item.
      "validatedDestinations": [ # The read-only list of intended destinations which passed validation.
        "A String",
      ],
      "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
      "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
      "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
      "mobileLink": "A String", # Link to a mobile-optimized version of the landing page.
      "price": { # Price of the item.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "channel": "A String", # The item's channel (online or local).
      "onlineOnly": True or False, # Whether an item is available for purchase only online.
      "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
        "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
        "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
        "pointsValue": "A String", # The retailer's loyalty points in absolute value.
      },
      "aspects": [ # Specifies the intended aspects for the product.
        {
          "intention": "A String", # Whether the aspect is required, excluded or should be validated.
          "aspectName": "A String", # The name of the aspect.
          "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
        },
      ],
      "description": "A String", # Description of the item.
      "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
      "warnings": [ # Read-only warnings.
        { # An error returned by the API.
          "reason": "A String", # The error code.
          "domain": "A String", # The domain of the error.
          "message": "A String", # A description of the error.
        },
      ],
      "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
      "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products feed specification).
      "brand": "A String", # Brand of the item.
      "material": "A String", # The material of which the item is made.
      "shippingLength": { # Length of the item for shipping.
        "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
            #
            # Acceptable values are:
            # - "cm"
            # - "in"
      },
      "taxes": [ # Tax information.
        {
          "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
          "region": "A String", # The geographic region to which the tax rate applies.
          "rate": 3.14, # The percentage of tax rate that applies to the item price.
          "locationId": "A String", # The numeric id of a location that the tax rate applies to as defined in the AdWords API.
          "postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
          "taxShip": True or False, # Set to true if tax is charged on shipping.
        },
      ],
      "shippingHeight": { # Height of the item for shipping.
        "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
            #
            # Acceptable values are:
            # - "cm"
            # - "in"
      },
      "sellOnGoogleQuantity": "A String", # The quantity of the product that is reserved for sell-on-google ads.
      "link": "A String", # URL directly linking to your item's page on your website.
      "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
      "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
      "energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
      "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
      "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
      "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
      "customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
        {
          "attributes": [ # The sub-attributes.
            {
              "value": "A String", # The value of the attribute.
              "type": "A String", # The type of the attribute.
              "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
              "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
            },
          ],
          "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
        },
      ],
      "condition": "A String", # Condition or state of the item.
      "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
      "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
      "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "content#product".
      "unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
        "value": "A String", # The denominator of the unit price.
        "unit": "A String", # The unit of the denominator.
      },
      "installment": { # Number and amount of installments to pay for an item. Brazil only.
        "amount": { # The amount the buyer has to pay per month.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "months": "A String", # The number of installments the buyer has to pay.
      },
      "sizes": [ # Size of the item.
        "A String",
      ],
      "gender": "A String", # Target gender of the item.
      "title": "A String", # Title of the item.
      "shipping": [ # Shipping rules.
        {
          "service": "A String", # A free-form description of the service class or delivery speed.
          "country": "A String", # The CLDR territory code of the country to which an item will ship.
          "price": { # Fixed shipping price, represented as a number.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "locationId": "A String", # The numeric id of a location that the shipping rate applies to as defined in the AdWords API.
          "postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
          "region": "A String", # The geographic region to which a shipping rate applies (e.g. zip code).
          "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
        },
      ],
      "shippingWeight": { # Weight of the item for shipping.
        "value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
        "unit": "A String", # The unit of value.
      },
      "identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
      "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
        {
          "value": "A String", # The value of the attribute.
          "type": "A String", # The type of the attribute.
          "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
          "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
        },
      ],
      "salePrice": { # Advertised sale price of the item.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "productType": "A String", # Your category of the item (formatted as in products feed specification).
      "pattern": "A String", # The item's pattern (e.g. polka dots).
      "displayAdsSimilarIds": [ # Advertiser-specified recommendations.
        "A String",
      ],
      "ageGroup": "A String", # Target age group of the item.
      "adult": True or False, # Set to true if the item is targeted towards adults.
    }
list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None) 
Lists the products in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  includeInvalidInsertedItems: boolean, Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of products to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of products.
    "kind": "content#productsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".
    "resources": [
      { # Product data.
          "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
          "color": "A String", # Color of the item.
          "availability": "A String", # Availability status of the item.
          "additionalImageLinks": [ # Additional URLs of images of the item.
            "A String",
          ],
          "adwordsLabels": [ # Similar to adwords_grouping, but only works on CPC.
            "A String",
          ],
          "itemGroupId": "A String", # Shared identifier for all variants of the same product.
          "promotionIds": [ # The unique ID of a promotion.
            "A String",
          ],
          "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
          "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
          "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy).
          "id": "A String", # The REST id of the product.
          "multipack": "A String", # The number of identical products in a merchant-defined multipack.
          "displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
          "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
          "availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
          "adwordsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
          "destinations": [ # Specifies the intended destinations for the product.
            {
              "intention": "A String", # Whether the destination is required, excluded or should be validated.
              "destinationName": "A String", # The name of the destination.
            },
          ],
          "targetCountry": "A String", # The CLDR territory code for the item.
          "sizeType": "A String", # The cut of the item. Recommended for apparel items.
          "offerId": "A String", # An identifier of the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.
          "shippingWidth": { # Width of the item for shipping.
            "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
            "unit": "A String", # The unit of value.
                #
                # Acceptable values are:
                # - "cm"
                # - "in"
          },
          "additionalProductTypes": [ # Additional categories of the item (formatted as in products feed specification).
            "A String",
          ],
          "unitPricingMeasure": { # The measure and dimension of an item.
            "value": 3.14, # The measure of an item.
            "unit": "A String", # The unit of the measure.
          },
          "imageLink": "A String", # URL of an image of the item.
          "validatedDestinations": [ # The read-only list of intended destinations which passed validation.
            "A String",
          ],
          "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
          "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
          "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
          "mobileLink": "A String", # Link to a mobile-optimized version of the landing page.
          "price": { # Price of the item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "channel": "A String", # The item's channel (online or local).
          "onlineOnly": True or False, # Whether an item is available for purchase only online.
          "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
            "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
            "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
            "pointsValue": "A String", # The retailer's loyalty points in absolute value.
          },
          "aspects": [ # Specifies the intended aspects for the product.
            {
              "intention": "A String", # Whether the aspect is required, excluded or should be validated.
              "aspectName": "A String", # The name of the aspect.
              "destinationName": "A String", # The name of the destination. Leave out to apply to all destinations.
            },
          ],
          "description": "A String", # Description of the item.
          "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
          "warnings": [ # Read-only warnings.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
          "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
          "salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see products feed specification).
          "brand": "A String", # Brand of the item.
          "material": "A String", # The material of which the item is made.
          "shippingLength": { # Length of the item for shipping.
            "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
            "unit": "A String", # The unit of value.
                #
                # Acceptable values are:
                # - "cm"
                # - "in"
          },
          "taxes": [ # Tax information.
            {
              "country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
              "region": "A String", # The geographic region to which the tax rate applies.
              "rate": 3.14, # The percentage of tax rate that applies to the item price.
              "locationId": "A String", # The numeric id of a location that the tax rate applies to as defined in the AdWords API.
              "postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
              "taxShip": True or False, # Set to true if tax is charged on shipping.
            },
          ],
          "shippingHeight": { # Height of the item for shipping.
            "value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
            "unit": "A String", # The unit of value.
                #
                # Acceptable values are:
                # - "cm"
                # - "in"
          },
          "sellOnGoogleQuantity": "A String", # The quantity of the product that is reserved for sell-on-google ads.
          "link": "A String", # URL directly linking to your item's page on your website.
          "adwordsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
          "displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
          "energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
          "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
          "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
          "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
          "customGroups": [ # A list of custom (merchant-provided) custom attribute groups.
            {
              "attributes": [ # The sub-attributes.
                {
                  "value": "A String", # The value of the attribute.
                  "type": "A String", # The type of the attribute.
                  "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
                  "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
                },
              ],
              "name": "A String", # The name of the group. Underscores will be replaced by spaces upon insertion.
            },
          ],
          "condition": "A String", # Condition or state of the item.
          "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
          "shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
          "kind": "content#product", # Identifies what kind of resource this is. Value: the fixed string "content#product".
          "unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
            "value": "A String", # The denominator of the unit price.
            "unit": "A String", # The unit of the denominator.
          },
          "installment": { # Number and amount of installments to pay for an item. Brazil only.
            "amount": { # The amount the buyer has to pay per month.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "months": "A String", # The number of installments the buyer has to pay.
          },
          "sizes": [ # Size of the item.
            "A String",
          ],
          "gender": "A String", # Target gender of the item.
          "title": "A String", # Title of the item.
          "shipping": [ # Shipping rules.
            {
              "service": "A String", # A free-form description of the service class or delivery speed.
              "country": "A String", # The CLDR territory code of the country to which an item will ship.
              "price": { # Fixed shipping price, represented as a number.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "locationId": "A String", # The numeric id of a location that the shipping rate applies to as defined in the AdWords API.
              "postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
              "region": "A String", # The geographic region to which a shipping rate applies (e.g. zip code).
              "locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
            },
          ],
          "shippingWeight": { # Weight of the item for shipping.
            "value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
            "unit": "A String", # The unit of value.
          },
          "identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
          "customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
            {
              "value": "A String", # The value of the attribute.
              "type": "A String", # The type of the attribute.
              "name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
              "unit": "A String", # Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT.
            },
          ],
          "salePrice": { # Advertised sale price of the item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "productType": "A String", # Your category of the item (formatted as in products feed specification).
          "pattern": "A String", # The item's pattern (e.g. polka dots).
          "displayAdsSimilarIds": [ # Advertiser-specified recommendations.
            "A String",
          ],
          "ageGroup": "A String", # Target age group of the item.
          "adult": True or False, # Set to true if the item is targeted towards adults.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/content_v2.productstatuses.html000066400000000000000000000264711300622755700263250ustar00rootroot00000000000000

Content API for Shopping . productstatuses

Instance Methods

custombatch(body)

Gets the statuses of multiple products in a single request.

get(merchantId, productId)

Gets the status of a product from your Merchant Center account.

list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None)

Lists the statuses of the products in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

custombatch(body) 
Gets the statuses of multiple products in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch productstatuses request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "productId": "A String", # The ID of the product whose status to get.
        "merchantId": "A String", # The ID of the managing account.
        "method": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#productstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch productstatuses response.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "kind": "content#productstatusesCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors, if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "productStatus": { # The status of a product, i.e., information about a product computed asynchronously by the data quality analysis. # The requested product status. Only defined if the request was successful.
          "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
          "destinationStatuses": [ # The intended destinations for the product.
            {
              "approvalStatus": "A String", # The destination's approval status.
              "destination": "A String", # The name of the destination
              "intention": "A String", # Whether the destination is required, excluded, selected by default or should be validated.
            },
          ],
          "title": "A String", # The title of the product.
          "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
          "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
          "link": "A String", # The link to the product.
          "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
          "dataQualityIssues": [ # A list of data quality issues associated with the product.
            {
              "valueProvided": "A String", # The value the attribute had at time of evaluation.
              "severity": "A String", # The severity of the data quality issue.
              "timestamp": "A String", # The time stamp of the data quality issue.
              "detail": "A String", # A more detailed error string.
              "location": "A String", # The attribute name that is relevant for the issue.
              "valueOnLandingPage": "A String", # The value of that attribute that was found on the landing page
              "id": "A String", # The id of the data quality issue.
              "fetchStatus": "A String", # The fetch status for landing_page_errors.
            },
          ],
          "productId": "A String", # The id of the product for which status is reported.
        },
      },
    ],
  }
get(merchantId, productId) 
Gets the status of a product from your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  productId: string, The ID of the product. (required)

Returns:
  An object of the form:

    { # The status of a product, i.e., information about a product computed asynchronously by the data quality analysis.
    "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
    "destinationStatuses": [ # The intended destinations for the product.
      {
        "approvalStatus": "A String", # The destination's approval status.
        "destination": "A String", # The name of the destination
        "intention": "A String", # Whether the destination is required, excluded, selected by default or should be validated.
      },
    ],
    "title": "A String", # The title of the product.
    "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
    "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
    "link": "A String", # The link to the product.
    "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
    "dataQualityIssues": [ # A list of data quality issues associated with the product.
      {
        "valueProvided": "A String", # The value the attribute had at time of evaluation.
        "severity": "A String", # The severity of the data quality issue.
        "timestamp": "A String", # The time stamp of the data quality issue.
        "detail": "A String", # A more detailed error string.
        "location": "A String", # The attribute name that is relevant for the issue.
        "valueOnLandingPage": "A String", # The value of that attribute that was found on the landing page
        "id": "A String", # The id of the data quality issue.
        "fetchStatus": "A String", # The fetch status for landing_page_errors.
      },
    ],
    "productId": "A String", # The id of the product for which status is reported.
  }
list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None) 
Lists the statuses of the products in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  includeInvalidInsertedItems: boolean, Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of product statuses to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of products statuses.
    "kind": "content#productstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".
    "resources": [
      { # The status of a product, i.e., information about a product computed asynchronously by the data quality analysis.
        "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
        "destinationStatuses": [ # The intended destinations for the product.
          {
            "approvalStatus": "A String", # The destination's approval status.
            "destination": "A String", # The name of the destination
            "intention": "A String", # Whether the destination is required, excluded, selected by default or should be validated.
          },
        ],
        "title": "A String", # The title of the product.
        "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
        "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
        "link": "A String", # The link to the product.
        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
        "dataQualityIssues": [ # A list of data quality issues associated with the product.
          {
            "valueProvided": "A String", # The value the attribute had at time of evaluation.
            "severity": "A String", # The severity of the data quality issue.
            "timestamp": "A String", # The time stamp of the data quality issue.
            "detail": "A String", # A more detailed error string.
            "location": "A String", # The attribute name that is relevant for the issue.
            "valueOnLandingPage": "A String", # The value of that attribute that was found on the landing page
            "id": "A String", # The id of the data quality issue.
            "fetchStatus": "A String", # The fetch status for landing_page_errors.
          },
        ],
        "productId": "A String", # The id of the product for which status is reported.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/content_v2.shippingsettings.html000066400000000000000000005017711300622755700264540ustar00rootroot00000000000000

Content API for Shopping . shippingsettings

Instance Methods

custombatch(body, dryRun=None)

Retrieves and updates the shipping settings of multiple accounts in a single request.

get(merchantId, accountId)

Retrieves the shipping settings of the account.

getsupportedcarriers(merchantId)

Retrieves supported carriers and carrier services for an account.

list(merchantId, pageToken=None, maxResults=None)

Lists the shipping settings of the sub-accounts in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(merchantId, accountId, body, dryRun=None)

Updates the shipping settings of the account. This method supports patch semantics.

update(merchantId, accountId, body, dryRun=None)

Updates the shipping settings of the account.

Method Details

custombatch(body, dryRun=None) 
Retrieves and updates the shipping settings of multiple accounts in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      { # A batch entry encoding a single non-batch accountshipping request.
        "batchId": 42, # An entry ID, unique within the batch request.
        "method": "A String",
        "merchantId": "A String", # The ID of the managing account.
        "shippingSettings": { # The merchant account's shipping settings. # The account shipping settings to update. Only defined if the method is update.
          "services": [ # The target account's list of services. Optional.
            {
              "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
              "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
                "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
                "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
              },
              "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
              "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
                {
                  "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
                    "A String",
                  ],
                  "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
                    {
                      "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
                      "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
                      "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                      "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
                      "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
                      "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
                    },
                  ],
                  "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
                    "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                    "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                    "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                    "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  },
                  "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
                    "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                      "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      ],
                      "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                      "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "value": "A String", # The weight represented as a number.
                          "unit": "A String", # The weight unit.
                        },
                      ],
                      "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                            "A String",
                          ],
                        },
                      ],
                      "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                    },
                    "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                      {
                        "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                          { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                            "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                            "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                            "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                            "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                              "currency": "A String", # The currency of the price.
                              "value": "A String", # The price represented as a number.
                            },
                          },
                        ],
                      },
                    ],
                    "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                      "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      ],
                      "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                      "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "value": "A String", # The weight represented as a number.
                          "unit": "A String", # The weight unit.
                        },
                      ],
                      "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                            "A String",
                          ],
                        },
                      ],
                      "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                    },
                    "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
                  },
                  "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
                    {
                      "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                        "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "currency": "A String", # The currency of the price.
                            "value": "A String", # The price represented as a number.
                          },
                        ],
                        "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                        "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "value": "A String", # The weight represented as a number.
                            "unit": "A String", # The weight unit.
                          },
                        ],
                        "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                              "A String",
                            ],
                          },
                        ],
                        "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                      },
                      "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                        {
                          "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                            { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                              "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                              "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                              "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                              "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                              "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                                "currency": "A String", # The currency of the price.
                                "value": "A String", # The price represented as a number.
                              },
                            },
                          ],
                        },
                      ],
                      "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                        "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "currency": "A String", # The currency of the price.
                            "value": "A String", # The price represented as a number.
                          },
                        ],
                        "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                        "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "value": "A String", # The weight represented as a number.
                            "unit": "A String", # The weight unit.
                          },
                        ],
                        "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                              "A String",
                            ],
                          },
                        ],
                        "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                      },
                      "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
                    },
                  ],
                },
              ],
              "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
              "active": True or False, # A boolean exposing the active status of the shipping service. Required.
            },
          ],
          "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
            {
              "postalCodeRanges": [ # A range of postal codes. Required.
                {
                  "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
                  "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
                },
              ],
              "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
              "name": "A String", # The name of the postal code group, referred to in headers. Required.
            },
          ],
          "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
        },
        "accountId": "A String", # The ID of the account for which to get/update account shipping settings.
      },
    ],
  }

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    {
    "kind": "content#shippingsettingsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      { # A batch entry encoding a single non-batch shipping settings response.
        "batchId": 42, # The ID of the request entry to which this entry responds.
        "kind": "content#shippingsettingsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "shippingSettings": { # The merchant account's shipping settings. # The retrieved or updated account shipping settings.
          "services": [ # The target account's list of services. Optional.
            {
              "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
              "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
                "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
                "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
              },
              "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
              "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
                {
                  "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
                    "A String",
                  ],
                  "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
                    {
                      "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
                      "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
                      "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                      "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
                      "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
                      "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
                    },
                  ],
                  "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
                    "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                    "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                    "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                    "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  },
                  "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
                    "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                      "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      ],
                      "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                      "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "value": "A String", # The weight represented as a number.
                          "unit": "A String", # The weight unit.
                        },
                      ],
                      "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                            "A String",
                          ],
                        },
                      ],
                      "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                    },
                    "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                      {
                        "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                          { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                            "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                            "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                            "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                            "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                              "currency": "A String", # The currency of the price.
                              "value": "A String", # The price represented as a number.
                            },
                          },
                        ],
                      },
                    ],
                    "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                      "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      ],
                      "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                      "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "value": "A String", # The weight represented as a number.
                          "unit": "A String", # The weight unit.
                        },
                      ],
                      "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                            "A String",
                          ],
                        },
                      ],
                      "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                    },
                    "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
                  },
                  "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
                    {
                      "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                        "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "currency": "A String", # The currency of the price.
                            "value": "A String", # The price represented as a number.
                          },
                        ],
                        "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                        "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "value": "A String", # The weight represented as a number.
                            "unit": "A String", # The weight unit.
                          },
                        ],
                        "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                              "A String",
                            ],
                          },
                        ],
                        "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                      },
                      "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                        {
                          "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                            { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                              "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                              "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                              "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                              "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                              "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                                "currency": "A String", # The currency of the price.
                                "value": "A String", # The price represented as a number.
                              },
                            },
                          ],
                        },
                      ],
                      "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                        "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "currency": "A String", # The currency of the price.
                            "value": "A String", # The price represented as a number.
                          },
                        ],
                        "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                        "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "value": "A String", # The weight represented as a number.
                            "unit": "A String", # The weight unit.
                          },
                        ],
                        "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                          {
                            "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                              "A String",
                            ],
                          },
                        ],
                        "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                          "A String",
                        ],
                      },
                      "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
                    },
                  ],
                },
              ],
              "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
              "active": True or False, # A boolean exposing the active status of the shipping service. Required.
            },
          ],
          "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
            {
              "postalCodeRanges": [ # A range of postal codes. Required.
                {
                  "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
                  "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
                },
              ],
              "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
              "name": "A String", # The name of the postal code group, referred to in headers. Required.
            },
          ],
          "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
        },
      },
    ],
  }
get(merchantId, accountId) 
Retrieves the shipping settings of the account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update shipping settings. (required)

Returns:
  An object of the form:

    { # The merchant account's shipping settings.
    "services": [ # The target account's list of services. Optional.
      {
        "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
        "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
          "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
          "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
        },
        "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
        "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
          {
            "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
              "A String",
            ],
            "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
              {
                "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
                "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
                "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
                "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
                "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
              },
            ],
            "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
              "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
              "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
              "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
              "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
              "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
            },
            "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                {
                  "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                      "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                      "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                      "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                      "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    },
                  ],
                },
              ],
              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
            },
            "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
              {
                "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                  "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  ],
                  "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                  "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                  ],
                  "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                        "A String",
                      ],
                    },
                  ],
                  "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                },
                "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                  {
                    "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                      { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                        "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                        "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                        "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                        "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                        "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      },
                    ],
                  },
                ],
                "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                  "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  ],
                  "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                  "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                  ],
                  "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                        "A String",
                      ],
                    },
                  ],
                  "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                },
                "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
              },
            ],
          },
        ],
        "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
        "active": True or False, # A boolean exposing the active status of the shipping service. Required.
      },
    ],
    "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
      {
        "postalCodeRanges": [ # A range of postal codes. Required.
          {
            "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
            "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
          },
        ],
        "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
        "name": "A String", # The name of the postal code group, referred to in headers. Required.
      },
    ],
    "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
  }
getsupportedcarriers(merchantId) 
Retrieves supported carriers and carrier services for an account.

Args:
  merchantId: string, The ID of the account for which to retrieve the supported carriers. (required)

Returns:
  An object of the form:

    {
    "kind": "content#shippingsettingsGetSupportedCarriersResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".
    "carriers": [ # A list of supported carriers. May be empty.
      {
        "services": [ # A list of supported services (e.g., "ground") for that carrier. Contains at least one service.
          "A String",
        ],
        "country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present.
        "name": "A String", # The name of the carrier (e.g., "UPS"). Always present.
      },
    ],
  }
list(merchantId, pageToken=None, maxResults=None) 
Lists the shipping settings of the sub-accounts in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of shipping settings to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of shipping settings.
    "kind": "content#shippingsettingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
    "resources": [
      { # The merchant account's shipping settings.
        "services": [ # The target account's list of services. Optional.
          {
            "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
            "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
              "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
              "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
            },
            "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
            "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
              {
                "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
                  "A String",
                ],
                "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
                  {
                    "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
                    "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
                    "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                    "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
                    "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
                    "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
                  },
                ],
                "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
                  "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                  "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                  "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                  "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                  "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                },
                "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
                  "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                    "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                      {
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    ],
                    "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                      "A String",
                    ],
                    "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                      {
                        "value": "A String", # The weight represented as a number.
                        "unit": "A String", # The weight unit.
                      },
                    ],
                    "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                      {
                        "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                          "A String",
                        ],
                      },
                    ],
                    "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                      "A String",
                    ],
                  },
                  "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                    {
                      "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                        { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                          "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                          "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                          "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                          "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                          "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                            "currency": "A String", # The currency of the price.
                            "value": "A String", # The price represented as a number.
                          },
                        },
                      ],
                    },
                  ],
                  "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                    "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                      {
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    ],
                    "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                      "A String",
                    ],
                    "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                      {
                        "value": "A String", # The weight represented as a number.
                        "unit": "A String", # The weight unit.
                      },
                    ],
                    "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                      {
                        "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                          "A String",
                        ],
                      },
                    ],
                    "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                      "A String",
                    ],
                  },
                  "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
                },
                "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
                  {
                    "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                      "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      ],
                      "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                      "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "value": "A String", # The weight represented as a number.
                          "unit": "A String", # The weight unit.
                        },
                      ],
                      "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                            "A String",
                          ],
                        },
                      ],
                      "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                    },
                    "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                      {
                        "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                          { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                            "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                            "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                            "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                            "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                              "currency": "A String", # The currency of the price.
                              "value": "A String", # The price represented as a number.
                            },
                          },
                        ],
                      },
                    ],
                    "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                      "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      ],
                      "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                      "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "value": "A String", # The weight represented as a number.
                          "unit": "A String", # The weight unit.
                        },
                      ],
                      "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                        {
                          "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                            "A String",
                          ],
                        },
                      ],
                      "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                        "A String",
                      ],
                    },
                    "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
                  },
                ],
              },
            ],
            "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
            "active": True or False, # A boolean exposing the active status of the shipping service. Required.
          },
        ],
        "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
          {
            "postalCodeRanges": [ # A range of postal codes. Required.
              {
                "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
                "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
              },
            ],
            "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
            "name": "A String", # The name of the postal code group, referred to in headers. Required.
          },
        ],
        "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
      },
    ],
  }
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(merchantId, accountId, body, dryRun=None) 
Updates the shipping settings of the account. This method supports patch semantics.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update shipping settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The merchant account's shipping settings.
  "services": [ # The target account's list of services. Optional.
    {
      "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
      "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
        "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
        "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
      },
      "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
      "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
        {
          "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
            "A String",
          ],
          "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
            {
              "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
              "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
              "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
              "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
              "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
            },
          ],
          "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
            "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
            "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
            "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
            "flatRate": { # A flat rate. Can only be set if all other fields are not set.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
          },
          "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
            "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
              "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              ],
              "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
              "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "value": "A String", # The weight represented as a number.
                  "unit": "A String", # The weight unit.
                },
              ],
              "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                    "A String",
                  ],
                },
              ],
              "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
            },
            "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
              {
                "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                  { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                    "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                    "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                    "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                    "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  },
                ],
              },
            ],
            "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
              "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              ],
              "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
              "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "value": "A String", # The weight represented as a number.
                  "unit": "A String", # The weight unit.
                },
              ],
              "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                    "A String",
                  ],
                },
              ],
              "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
            },
            "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
          },
          "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
            {
              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                {
                  "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                      "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                      "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                      "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                      "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    },
                  ],
                },
              ],
              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
            },
          ],
        },
      ],
      "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
      "active": True or False, # A boolean exposing the active status of the shipping service. Required.
    },
  ],
  "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
    {
      "postalCodeRanges": [ # A range of postal codes. Required.
        {
          "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
          "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
        },
      ],
      "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
      "name": "A String", # The name of the postal code group, referred to in headers. Required.
    },
  ],
  "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
}

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # The merchant account's shipping settings.
    "services": [ # The target account's list of services. Optional.
      {
        "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
        "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
          "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
          "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
        },
        "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
        "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
          {
            "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
              "A String",
            ],
            "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
              {
                "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
                "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
                "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
                "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
                "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
              },
            ],
            "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
              "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
              "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
              "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
              "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
              "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
            },
            "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                {
                  "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                      "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                      "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                      "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                      "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    },
                  ],
                },
              ],
              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
            },
            "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
              {
                "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                  "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  ],
                  "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                  "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                  ],
                  "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                        "A String",
                      ],
                    },
                  ],
                  "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                },
                "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                  {
                    "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                      { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                        "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                        "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                        "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                        "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                        "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      },
                    ],
                  },
                ],
                "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                  "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  ],
                  "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                  "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                  ],
                  "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                        "A String",
                      ],
                    },
                  ],
                  "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                },
                "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
              },
            ],
          },
        ],
        "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
        "active": True or False, # A boolean exposing the active status of the shipping service. Required.
      },
    ],
    "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
      {
        "postalCodeRanges": [ # A range of postal codes. Required.
          {
            "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
            "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
          },
        ],
        "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
        "name": "A String", # The name of the postal code group, referred to in headers. Required.
      },
    ],
    "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
  }
update(merchantId, accountId, body, dryRun=None) 
Updates the shipping settings of the account.

Args:
  merchantId: string, The ID of the managing account. (required)
  accountId: string, The ID of the account for which to get/update shipping settings. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The merchant account's shipping settings.
  "services": [ # The target account's list of services. Optional.
    {
      "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
      "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
        "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
        "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
      },
      "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
      "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
        {
          "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
            "A String",
          ],
          "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
            {
              "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
              "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
              "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
              "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
              "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
            },
          ],
          "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
            "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
            "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
            "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
            "flatRate": { # A flat rate. Can only be set if all other fields are not set.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
          },
          "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
            "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
              "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              ],
              "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
              "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "value": "A String", # The weight represented as a number.
                  "unit": "A String", # The weight unit.
                },
              ],
              "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                    "A String",
                  ],
                },
              ],
              "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
            },
            "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
              {
                "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                  { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                    "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                    "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                    "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                    "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  },
                ],
              },
            ],
            "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
              "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
              ],
              "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
              "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "value": "A String", # The weight represented as a number.
                  "unit": "A String", # The weight unit.
                },
              ],
              "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                {
                  "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                    "A String",
                  ],
                },
              ],
              "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                "A String",
              ],
            },
            "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
          },
          "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
            {
              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                {
                  "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                      "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                      "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                      "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                      "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    },
                  ],
                },
              ],
              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
            },
          ],
        },
      ],
      "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
      "active": True or False, # A boolean exposing the active status of the shipping service. Required.
    },
  ],
  "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
    {
      "postalCodeRanges": [ # A range of postal codes. Required.
        {
          "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
          "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
        },
      ],
      "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
      "name": "A String", # The name of the postal code group, referred to in headers. Required.
    },
  ],
  "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
}

  dryRun: boolean, Flag to run the request in dry-run mode.

Returns:
  An object of the form:

    { # The merchant account's shipping settings.
    "services": [ # The target account's list of services. Optional.
      {
        "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
        "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
          "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
          "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
        },
        "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
        "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
          {
            "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
              "A String",
            ],
            "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
              {
                "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
                "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
                "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
                "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
                "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
              },
            ],
            "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
              "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
              "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
              "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
              "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
              "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
            },
            "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                {
                  "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                      "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                      "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                      "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                      "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                        "currency": "A String", # The currency of the price.
                        "value": "A String", # The price represented as a number.
                      },
                    },
                  ],
                },
              ],
              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                ],
                "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
                "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "value": "A String", # The weight represented as a number.
                    "unit": "A String", # The weight unit.
                  },
                ],
                "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                  {
                    "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                      "A String",
                    ],
                  },
                ],
                "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                  "A String",
                ],
              },
              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
            },
            "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
              {
                "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
                  "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  ],
                  "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                  "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                  ],
                  "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                        "A String",
                      ],
                    },
                  ],
                  "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                },
                "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
                  {
                    "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
                      { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
                        "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
                        "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
                        "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
                        "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
                        "flatRate": { # A flat rate. Can only be set if all other fields are not set.
                          "currency": "A String", # The currency of the price.
                          "value": "A String", # The price represented as a number.
                        },
                      },
                    ],
                  },
                ],
                "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
                  "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "currency": "A String", # The currency of the price.
                      "value": "A String", # The price represented as a number.
                    },
                  ],
                  "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                  "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "value": "A String", # The weight represented as a number.
                      "unit": "A String", # The weight unit.
                    },
                  ],
                  "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
                    {
                      "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
                        "A String",
                      ],
                    },
                  ],
                  "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
                    "A String",
                  ],
                },
                "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
              },
            ],
          },
        ],
        "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
        "active": True or False, # A boolean exposing the active status of the shipping service. Required.
      },
    ],
    "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
      {
        "postalCodeRanges": [ # A range of postal codes. Required.
          {
            "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
            "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
          },
        ],
        "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
        "name": "A String", # The name of the postal code group, referred to in headers. Required.
      },
    ],
    "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
  }
google-api-python-client-1.5.5/docs/dyn/content_v2sandbox.html000066400000000000000000000041371300622755700244240ustar00rootroot00000000000000

Content API for Shopping

Instance Methods

orders()

Returns the orders Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/content_v2sandbox.orders.html000066400000000000000000002613251300622755700257250ustar00rootroot00000000000000

Content API for Shopping . orders

Instance Methods

acknowledge(merchantId, orderId, body)

Marks an order as acknowledged.

advancetestorder(merchantId, orderId)

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

cancel(merchantId, orderId, body)

Cancels all line items in an order.

cancellineitem(merchantId, orderId, body)

Cancels a line item.

createtestorder(merchantId, body)

Sandbox only. Creates a test order.

custombatch(body)

Retrieves or modifies multiple orders in a single request.

get(merchantId, orderId)

Retrieves an order from your Merchant Center account.

getbymerchantorderid(merchantId, merchantOrderId)

Retrieves an order using merchant order id.

gettestordertemplate(merchantId, templateName)

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)

Lists the orders in your Merchant Center account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

refund(merchantId, orderId, body)

Refund a portion of the order, up to the full amount paid.

returnlineitem(merchantId, orderId, body)

Returns a line item.

shiplineitems(merchantId, orderId, body)

Marks line item(s) as shipped.

updatemerchantorderid(merchantId, orderId, body)

Updates the merchant order ID for a given order.

updateshipment(merchantId, orderId, body)

Updates a shipment's status, carrier, and/or tracking ID.

Method Details

acknowledge(merchantId, orderId, body) 
Marks an order as acknowledged.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
    "executionStatus": "A String", # The status of the execution.
  }
advancetestorder(merchantId, orderId) 
Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the test order to modify. (required)

Returns:
  An object of the form:

    {
    "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
  }
cancel(merchantId, orderId, body) 
Cancels all line items in an order.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order to cancel. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "reason": "A String", # The reason for the cancellation.
    "reasonText": "A String", # The explanation of the reason.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
    "executionStatus": "A String", # The status of the execution.
  }
cancellineitem(merchantId, orderId, body) 
Cancels a line item.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "reason": "A String", # The reason for the cancellation.
    "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "reasonText": "A String", # The explanation of the reason.
    "lineItemId": "A String", # The ID of the line item to cancel.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
    "quantity": 42, # The quantity to cancel.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
    "executionStatus": "A String", # The status of the execution.
  }
createtestorder(merchantId, body) 
Sandbox only. Creates a test order.

Args:
  merchantId: string, The ID of the managing account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "testOrder": { # The test order to create.
      "customer": { # The details of the customer who placed the order.
        "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
        "fullName": "A String", # Full name of the customer.
        "email": "A String", # Email address of the customer.
      },
      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
        {
          "benefits": [
            {
              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                "A String",
              ],
              "discount": { # The discount in the order price when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
              "taxImpact": { # The impact on tax when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
            },
          ],
          "longTitle": "A String", # The full title of the promotion.
          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
          "id": "A String", # The unique ID of the promotion.
        },
      ],
      "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
      "shippingCostTax": { # The tax for the total shipping cost.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
      "shippingCost": { # The total cost of shipping for all items.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "shippingOption": "A String", # The requested shipping option.
      "lineItems": [ # Line items that are ordered. At least one line item must be provided.
        {
          "returnInfo": { # Details of the return policy for the line item.
            "policyUrl": "A String", # URL of the item return policy.
            "isReturnable": True or False, # Whether the item is returnable.
            "daysToReturn": 42, # How many days later the item can be returned.
          },
          "product": { # Product data from the time of the order placement.
            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "title": "A String", # The title of the product.
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
            "variantAttributes": [ # Variant attributes for the item. Optional.
              {
                "dimension": "A String", # The dimension of the variant.
                "value": "A String", # The value for the dimension.
              },
            ],
            "brand": "A String", # Brand of the item.
            "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
            "offerId": "A String", # An identifier of the item.
            "imageLink": "A String", # URL of an image of the item.
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
            "channel": "A String", # The item's channel.
            "price": { # The price for the product.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": "A String", # Condition or state of the item.
          },
          "unitTax": { # Unit tax for the line item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantityOrdered": 42, # Number of items ordered.
          "shippingDetails": { # Details of the requested shipping for the line item.
            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
            "method": { # Details of the shipping method.
              "minDaysInTransit": 42, # Minimum transit time.
              "carrier": "A String", # The carrier for the shipping. Optional.
              "methodName": "A String", # The name of the shipping method.
              "maxDaysInTransit": 42, # Maximum transit time.
            },
            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
          },
        },
      ],
      "paymentMethod": { # The details of the payment method.
        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
        "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
        "lastFourDigits": "A String", # The last four digits of the card number.
        "predefinedBillingAddress": "A String", # The billing address.
      },
    },
    "templateName": "A String", # The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template.
  }


Returns:
  An object of the form:

    {
    "orderId": "A String", # The ID of the newly created test order.
    "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
  }
custombatch(body) 
Retrieves or modifies multiple orders in a single request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [ # The request entries to be processed in the batch.
      {
        "orderId": "A String", # The ID of the order. Required for all methods beside getByMerchantOrderId.
        "merchantOrderId": "A String", # The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods.
        "shipLineItems": { # Required for shipLineItems method.
          "lineItems": [ # Line items to ship.
            {
              "lineItemId": "A String", # The id of the line item that is shipped.
              "quantity": 42, # The quantity that is shipped.
            },
          ],
          "carrier": "A String", # The carrier handling the shipment.
          "trackingId": "A String", # The tracking id for the shipment.
          "shipmentId": "A String", # The ID of the shipment.
        },
        "updateShipment": { # Required for updateShipment method.
          "status": "A String", # New status for the shipment. Not updated if missing.
          "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
          "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
          "shipmentId": "A String", # The ID of the shipment.
        },
        "method": "A String", # The method to apply.
        "batchId": 42, # An entry ID, unique within the batch request.
        "cancelLineItem": { # Required for cancelLineItem method.
          "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "reasonText": "A String", # The explanation of the reason.
          "reason": "A String", # The reason for the cancellation.
          "lineItemId": "A String", # The ID of the line item to cancel.
          "quantity": 42, # The quantity to cancel.
        },
        "refund": { # Required for refund method.
          "amount": { # The amount that is refunded.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "reasonText": "A String", # The explanation of the reason.
          "reason": "A String", # The reason for the refund.
        },
        "cancel": { # Required for cancel method.
          "reason": "A String", # The reason for the cancellation.
          "reasonText": "A String", # The explanation of the reason.
        },
        "returnLineItem": { # Required for returnLineItem method.
          "reason": "A String", # The reason for the return.
          "reasonText": "A String", # The explanation of the reason.
          "lineItemId": "A String", # The ID of the line item to return.
          "quantity": 42, # The quantity to return.
        },
        "merchantId": "A String", # The ID of the managing account.
        "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      {
        "batchId": 42, # The ID of the request entry this entry responds to.
        "kind": "content#ordersCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "order": { # The retrieved order. Only defined if the method is get and if the request was successful.
          "customer": { # The details of the customer who placed the order.
            "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
            "fullName": "A String", # Full name of the customer.
            "email": "A String", # Email address of the customer.
          },
          "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
            {
              "benefits": [
                {
                  "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                    "A String",
                  ],
                  "discount": { # The discount in the order price when the promotion is applied.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
                  "taxImpact": { # The impact on tax when the promotion is applied.
                    "currency": "A String", # The currency of the price.
                    "value": "A String", # The price represented as a number.
                  },
                  "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
                },
              ],
              "longTitle": "A String", # The full title of the promotion.
              "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
              "redemptionChannel": "A String", # Indicates that the promotion is valid online.
              "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
              "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
                  # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
              "id": "A String", # The unique ID of the promotion.
            },
          ],
          "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
          "shippingCostTax": { # The tax for the total shipping cost.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "shipments": [ # Shipments of the order.
            {
              "status": "A String", # The status of the shipment.
              "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
              "carrier": "A String", # The carrier handling the shipment.
              "trackingId": "A String", # The tracking id for the shipment.
              "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
              "lineItems": [ # The line items that are shipped.
                {
                  "lineItemId": "A String", # The id of the line item that is shipped.
                  "quantity": 42, # The quantity that is shipped.
                },
              ],
              "id": "A String", # The id of the shipment.
            },
          ],
          "refunds": [ # Refunds for the order.
            {
              "amount": { # The amount that is refunded.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
              "reason": "A String", # The reason for the refund.
              "actor": "A String", # The actor that created the refund.
              "reasonText": "A String", # The explanation of the reason.
            },
          ],
          "paymentMethod": { # The details of the payment method.
            "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
            "lastFourDigits": "A String", # The last four digits of the card number.
            "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
            "phoneNumber": "A String", # The billing phone number.
            "billingAddress": { # The billing address.
              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
              "country": "A String", # CLDR country code (e.g. "US").
              "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                  # John Smith
                  # 1600 Amphitheatre Parkway
                  # Mountain View, CA, 94043
                  # United States
                "A String",
              ],
              "streetAddress": [ # Street-level part of the address.
                "A String",
              ],
              "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
              "recipientName": "A String", # Name of the recipient.
              "isPostOfficeBox": True or False, # Whether the address is a post office box.
              "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
            },
            "type": "A String", # The type of instrument (VISA, Mastercard, etc).
          },
          "shippingCost": { # The total cost of shipping for all items.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "acknowledged": True or False, # Whether the order was acknowledged.
          "paymentStatus": "A String", # The status of the payment.
          "merchantId": "A String",
          "merchantOrderId": "A String", # Merchant-provided id of the order.
          "shippingOption": "A String", # The requested shipping option.
          "status": "A String", # The status of the order.
          "deliveryDetails": { # The details for the delivery.
            "phoneNumber": "A String", # The phone number of the person receiving the delivery.
            "address": { # The delivery address
              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
              "country": "A String", # CLDR country code (e.g. "US").
              "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                  # John Smith
                  # 1600 Amphitheatre Parkway
                  # Mountain View, CA, 94043
                  # United States
                "A String",
              ],
              "streetAddress": [ # Street-level part of the address.
                "A String",
              ],
              "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
              "recipientName": "A String", # Name of the recipient.
              "isPostOfficeBox": True or False, # Whether the address is a post office box.
              "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
            },
          },
          "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
          "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
          "lineItems": [ # Line items that are ordered.
            {
              "product": { # Product data from the time of the order placement.
                "targetCountry": "A String", # The CLDR territory code of the target country of the product.
                "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
                "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
                "title": "A String", # The title of the product.
                "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
                "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
                  {
                    "dimension": "A String", # The dimension of the variant.
                    "value": "A String", # The value for the dimension.
                  },
                ],
                "brand": "A String", # Brand of the item.
                "itemGroupId": "A String", # Shared identifier for all variants of the same product.
                "offerId": "A String", # An identifier of the item.
                "price": { # Price of the item.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "imageLink": "A String", # URL of an image of the item.
                "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
                "channel": "A String", # The item's channel (online or local).
                "id": "A String", # The REST id of the product.
                "condition": "A String", # Condition or state of the item.
              },
              "quantityDelivered": 42, # Number of items delivered.
              "returnInfo": { # Details of the return policy for the line item.
                "policyUrl": "A String", # URL of the item return policy.
                "isReturnable": True or False, # Whether the item is returnable.
                "daysToReturn": 42, # How many days later the item can be returned.
              },
              "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "quantityPending": 42, # Number of items pending.
              "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "cancellations": [ # Cancellations of the line item.
                {
                  "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
                  "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
                  "reasonText": "A String", # The explanation of the reason.
                  "actor": "A String", # The actor that created the cancellation.
                  "quantity": 42, # The quantity that was canceled.
                },
              ],
              "quantityCanceled": 42, # Number of items canceled.
              "quantityOrdered": 42, # Number of items ordered.
              "returns": [ # Returns of the line item.
                {
                  "reason": "A String", # The reason for the return.
                  "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
                  "reasonText": "A String", # The explanation of the reason.
                  "actor": "A String", # The actor that created the refund.
                  "quantity": 42, # Quantity that is returned.
                },
              ],
              "quantityShipped": 42, # Number of items shipped.
              "quantityReturned": 42, # Number of items returned.
              "id": "A String", # The id of the line item.
              "shippingDetails": { # Details of the requested shipping for the line item.
                "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
                "method": { # Details of the shipping method.
                  "minDaysInTransit": 42, # Minimum transit time.
                  "carrier": "A String", # The carrier for the shipping. Optional.
                  "methodName": "A String", # The name of the shipping method.
                  "maxDaysInTransit": 42, # Maximum transit time.
                },
                "shipByDate": "A String", # The ship by date, in ISO 8601 format.
              },
            },
          ],
          "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "id": "A String", # The REST id of the order. Globally unique.
        },
        "executionStatus": "A String", # The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful.
      },
    ],
  }
get(merchantId, orderId) 
Retrieves an order from your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)

Returns:
  An object of the form:

    {
    "customer": { # The details of the customer who placed the order.
      "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
      "fullName": "A String", # Full name of the customer.
      "email": "A String", # Email address of the customer.
    },
    "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
      {
        "benefits": [
          {
            "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
              "A String",
            ],
            "discount": { # The discount in the order price when the promotion is applied.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
            "taxImpact": { # The impact on tax when the promotion is applied.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
          },
        ],
        "longTitle": "A String", # The full title of the promotion.
        "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
        "redemptionChannel": "A String", # Indicates that the promotion is valid online.
        "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
        "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
            # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
        "id": "A String", # The unique ID of the promotion.
      },
    ],
    "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
    "shippingCostTax": { # The tax for the total shipping cost.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "shipments": [ # Shipments of the order.
      {
        "status": "A String", # The status of the shipment.
        "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
        "carrier": "A String", # The carrier handling the shipment.
        "trackingId": "A String", # The tracking id for the shipment.
        "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
        "lineItems": [ # The line items that are shipped.
          {
            "lineItemId": "A String", # The id of the line item that is shipped.
            "quantity": 42, # The quantity that is shipped.
          },
        ],
        "id": "A String", # The id of the shipment.
      },
    ],
    "refunds": [ # Refunds for the order.
      {
        "amount": { # The amount that is refunded.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
        "reason": "A String", # The reason for the refund.
        "actor": "A String", # The actor that created the refund.
        "reasonText": "A String", # The explanation of the reason.
      },
    ],
    "paymentMethod": { # The details of the payment method.
      "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
      "lastFourDigits": "A String", # The last four digits of the card number.
      "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
      "phoneNumber": "A String", # The billing phone number.
      "billingAddress": { # The billing address.
        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
        "country": "A String", # CLDR country code (e.g. "US").
        "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
            # John Smith
            # 1600 Amphitheatre Parkway
            # Mountain View, CA, 94043
            # United States
          "A String",
        ],
        "streetAddress": [ # Street-level part of the address.
          "A String",
        ],
        "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
        "recipientName": "A String", # Name of the recipient.
        "isPostOfficeBox": True or False, # Whether the address is a post office box.
        "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
      },
      "type": "A String", # The type of instrument (VISA, Mastercard, etc).
    },
    "shippingCost": { # The total cost of shipping for all items.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "acknowledged": True or False, # Whether the order was acknowledged.
    "paymentStatus": "A String", # The status of the payment.
    "merchantId": "A String",
    "merchantOrderId": "A String", # Merchant-provided id of the order.
    "shippingOption": "A String", # The requested shipping option.
    "status": "A String", # The status of the order.
    "deliveryDetails": { # The details for the delivery.
      "phoneNumber": "A String", # The phone number of the person receiving the delivery.
      "address": { # The delivery address
        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
        "country": "A String", # CLDR country code (e.g. "US").
        "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
            # John Smith
            # 1600 Amphitheatre Parkway
            # Mountain View, CA, 94043
            # United States
          "A String",
        ],
        "streetAddress": [ # Street-level part of the address.
          "A String",
        ],
        "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
        "recipientName": "A String", # Name of the recipient.
        "isPostOfficeBox": True or False, # Whether the address is a post office box.
        "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
      },
    },
    "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
    "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
    "lineItems": [ # Line items that are ordered.
      {
        "product": { # Product data from the time of the order placement.
          "targetCountry": "A String", # The CLDR territory code of the target country of the product.
          "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
          "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
          "title": "A String", # The title of the product.
          "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
          "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
            {
              "dimension": "A String", # The dimension of the variant.
              "value": "A String", # The value for the dimension.
            },
          ],
          "brand": "A String", # Brand of the item.
          "itemGroupId": "A String", # Shared identifier for all variants of the same product.
          "offerId": "A String", # An identifier of the item.
          "price": { # Price of the item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "imageLink": "A String", # URL of an image of the item.
          "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
          "channel": "A String", # The item's channel (online or local).
          "id": "A String", # The REST id of the product.
          "condition": "A String", # Condition or state of the item.
        },
        "quantityDelivered": 42, # Number of items delivered.
        "returnInfo": { # Details of the return policy for the line item.
          "policyUrl": "A String", # URL of the item return policy.
          "isReturnable": True or False, # Whether the item is returnable.
          "daysToReturn": 42, # How many days later the item can be returned.
        },
        "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "quantityPending": 42, # Number of items pending.
        "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "cancellations": [ # Cancellations of the line item.
          {
            "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
            "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
            "reasonText": "A String", # The explanation of the reason.
            "actor": "A String", # The actor that created the cancellation.
            "quantity": 42, # The quantity that was canceled.
          },
        ],
        "quantityCanceled": 42, # Number of items canceled.
        "quantityOrdered": 42, # Number of items ordered.
        "returns": [ # Returns of the line item.
          {
            "reason": "A String", # The reason for the return.
            "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
            "reasonText": "A String", # The explanation of the reason.
            "actor": "A String", # The actor that created the refund.
            "quantity": 42, # Quantity that is returned.
          },
        ],
        "quantityShipped": 42, # Number of items shipped.
        "quantityReturned": 42, # Number of items returned.
        "id": "A String", # The id of the line item.
        "shippingDetails": { # Details of the requested shipping for the line item.
          "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
          "method": { # Details of the shipping method.
            "minDaysInTransit": 42, # Minimum transit time.
            "carrier": "A String", # The carrier for the shipping. Optional.
            "methodName": "A String", # The name of the shipping method.
            "maxDaysInTransit": 42, # Maximum transit time.
          },
          "shipByDate": "A String", # The ship by date, in ISO 8601 format.
        },
      },
    ],
    "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "id": "A String", # The REST id of the order. Globally unique.
  }
getbymerchantorderid(merchantId, merchantOrderId) 
Retrieves an order using merchant order id.

Args:
  merchantId: string, The ID of the managing account. (required)
  merchantOrderId: string, The merchant order id to be looked for. (required)

Returns:
  An object of the form:

    {
    "kind": "content#ordersGetByMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
    "order": { # The requested order.
      "customer": { # The details of the customer who placed the order.
        "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
        "fullName": "A String", # Full name of the customer.
        "email": "A String", # Email address of the customer.
      },
      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
        {
          "benefits": [
            {
              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                "A String",
              ],
              "discount": { # The discount in the order price when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
              "taxImpact": { # The impact on tax when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
            },
          ],
          "longTitle": "A String", # The full title of the promotion.
          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
          "id": "A String", # The unique ID of the promotion.
        },
      ],
      "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
      "shippingCostTax": { # The tax for the total shipping cost.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "shipments": [ # Shipments of the order.
        {
          "status": "A String", # The status of the shipment.
          "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
          "carrier": "A String", # The carrier handling the shipment.
          "trackingId": "A String", # The tracking id for the shipment.
          "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
          "lineItems": [ # The line items that are shipped.
            {
              "lineItemId": "A String", # The id of the line item that is shipped.
              "quantity": 42, # The quantity that is shipped.
            },
          ],
          "id": "A String", # The id of the shipment.
        },
      ],
      "refunds": [ # Refunds for the order.
        {
          "amount": { # The amount that is refunded.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
          "reason": "A String", # The reason for the refund.
          "actor": "A String", # The actor that created the refund.
          "reasonText": "A String", # The explanation of the reason.
        },
      ],
      "paymentMethod": { # The details of the payment method.
        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
        "lastFourDigits": "A String", # The last four digits of the card number.
        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
        "phoneNumber": "A String", # The billing phone number.
        "billingAddress": { # The billing address.
          "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
          "country": "A String", # CLDR country code (e.g. "US").
          "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
              # John Smith
              # 1600 Amphitheatre Parkway
              # Mountain View, CA, 94043
              # United States
            "A String",
          ],
          "streetAddress": [ # Street-level part of the address.
            "A String",
          ],
          "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
          "recipientName": "A String", # Name of the recipient.
          "isPostOfficeBox": True or False, # Whether the address is a post office box.
          "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
        },
        "type": "A String", # The type of instrument (VISA, Mastercard, etc).
      },
      "shippingCost": { # The total cost of shipping for all items.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "acknowledged": True or False, # Whether the order was acknowledged.
      "paymentStatus": "A String", # The status of the payment.
      "merchantId": "A String",
      "merchantOrderId": "A String", # Merchant-provided id of the order.
      "shippingOption": "A String", # The requested shipping option.
      "status": "A String", # The status of the order.
      "deliveryDetails": { # The details for the delivery.
        "phoneNumber": "A String", # The phone number of the person receiving the delivery.
        "address": { # The delivery address
          "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
          "country": "A String", # CLDR country code (e.g. "US").
          "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
              # John Smith
              # 1600 Amphitheatre Parkway
              # Mountain View, CA, 94043
              # United States
            "A String",
          ],
          "streetAddress": [ # Street-level part of the address.
            "A String",
          ],
          "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
          "recipientName": "A String", # Name of the recipient.
          "isPostOfficeBox": True or False, # Whether the address is a post office box.
          "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
        },
      },
      "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
      "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
      "lineItems": [ # Line items that are ordered.
        {
          "product": { # Product data from the time of the order placement.
            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
            "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "title": "A String", # The title of the product.
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
            "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
              {
                "dimension": "A String", # The dimension of the variant.
                "value": "A String", # The value for the dimension.
              },
            ],
            "brand": "A String", # Brand of the item.
            "itemGroupId": "A String", # Shared identifier for all variants of the same product.
            "offerId": "A String", # An identifier of the item.
            "price": { # Price of the item.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "imageLink": "A String", # URL of an image of the item.
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
            "channel": "A String", # The item's channel (online or local).
            "id": "A String", # The REST id of the product.
            "condition": "A String", # Condition or state of the item.
          },
          "quantityDelivered": 42, # Number of items delivered.
          "returnInfo": { # Details of the return policy for the line item.
            "policyUrl": "A String", # URL of the item return policy.
            "isReturnable": True or False, # Whether the item is returnable.
            "daysToReturn": 42, # How many days later the item can be returned.
          },
          "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantityPending": 42, # Number of items pending.
          "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "cancellations": [ # Cancellations of the line item.
            {
              "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
              "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
              "reasonText": "A String", # The explanation of the reason.
              "actor": "A String", # The actor that created the cancellation.
              "quantity": 42, # The quantity that was canceled.
            },
          ],
          "quantityCanceled": 42, # Number of items canceled.
          "quantityOrdered": 42, # Number of items ordered.
          "returns": [ # Returns of the line item.
            {
              "reason": "A String", # The reason for the return.
              "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
              "reasonText": "A String", # The explanation of the reason.
              "actor": "A String", # The actor that created the refund.
              "quantity": 42, # Quantity that is returned.
            },
          ],
          "quantityShipped": 42, # Number of items shipped.
          "quantityReturned": 42, # Number of items returned.
          "id": "A String", # The id of the line item.
          "shippingDetails": { # Details of the requested shipping for the line item.
            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
            "method": { # Details of the shipping method.
              "minDaysInTransit": 42, # Minimum transit time.
              "carrier": "A String", # The carrier for the shipping. Optional.
              "methodName": "A String", # The name of the shipping method.
              "maxDaysInTransit": 42, # Maximum transit time.
            },
            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
          },
        },
      ],
      "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "id": "A String", # The REST id of the order. Globally unique.
    },
  }
gettestordertemplate(merchantId, templateName) 
Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Args:
  merchantId: string, The ID of the managing account. (required)
  templateName: string, The name of the template to retrieve. (required)
    Allowed values
      template1 - 
      template1a - 
      template1b - 
      template2 - 

Returns:
  An object of the form:

    {
    "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
    "template": { # The requested test order template.
      "customer": { # The details of the customer who placed the order.
        "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
        "fullName": "A String", # Full name of the customer.
        "email": "A String", # Email address of the customer.
      },
      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
        {
          "benefits": [
            {
              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                "A String",
              ],
              "discount": { # The discount in the order price when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
              "taxImpact": { # The impact on tax when the promotion is applied.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
            },
          ],
          "longTitle": "A String", # The full title of the promotion.
          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
          "id": "A String", # The unique ID of the promotion.
        },
      ],
      "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
      "shippingCostTax": { # The tax for the total shipping cost.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
      "shippingCost": { # The total cost of shipping for all items.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "shippingOption": "A String", # The requested shipping option.
      "lineItems": [ # Line items that are ordered. At least one line item must be provided.
        {
          "returnInfo": { # Details of the return policy for the line item.
            "policyUrl": "A String", # URL of the item return policy.
            "isReturnable": True or False, # Whether the item is returnable.
            "daysToReturn": 42, # How many days later the item can be returned.
          },
          "product": { # Product data from the time of the order placement.
            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
            "title": "A String", # The title of the product.
            "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
            "variantAttributes": [ # Variant attributes for the item. Optional.
              {
                "dimension": "A String", # The dimension of the variant.
                "value": "A String", # The value for the dimension.
              },
            ],
            "brand": "A String", # Brand of the item.
            "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
            "offerId": "A String", # An identifier of the item.
            "imageLink": "A String", # URL of an image of the item.
            "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
            "channel": "A String", # The item's channel.
            "price": { # The price for the product.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "condition": "A String", # Condition or state of the item.
          },
          "unitTax": { # Unit tax for the line item.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "quantityOrdered": 42, # Number of items ordered.
          "shippingDetails": { # Details of the requested shipping for the line item.
            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
            "method": { # Details of the shipping method.
              "minDaysInTransit": 42, # Minimum transit time.
              "carrier": "A String", # The carrier for the shipping. Optional.
              "methodName": "A String", # The name of the shipping method.
              "maxDaysInTransit": 42, # Maximum transit time.
            },
            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
          },
        },
      ],
      "paymentMethod": { # The details of the payment method.
        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
        "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
        "lastFourDigits": "A String", # The last four digits of the card number.
        "predefinedBillingAddress": "A String", # The billing address.
      },
    },
  }
list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None) 
Lists the orders in your Merchant Center account.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderBy: string, The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.
    Allowed values
      placedDate asc - 
      placedDate desc - 
  pageToken: string, The token returned by the previous request.
  placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format.
  acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.
  maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
Known issue: All List calls will return all Orders without limit regardless of the value of this field.
  placedDateStart: string, Obtains orders placed after this date (inclusively), in ISO 8601 format.
  statuses: string, Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. (repeated)
    Allowed values
      active - 
      canceled - 
      completed - 
      delivered - 
      inProgress - 
      partiallyDelivered - 
      partiallyReturned - 
      partiallyShipped - 
      pendingShipment - 
      returned - 
      shipped - 

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
    "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
    "resources": [
      {
        "customer": { # The details of the customer who placed the order.
          "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
          "fullName": "A String", # Full name of the customer.
          "email": "A String", # Email address of the customer.
        },
        "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
          {
            "benefits": [
              {
                "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
                  "A String",
                ],
                "discount": { # The discount in the order price when the promotion is applied.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
                "taxImpact": { # The impact on tax when the promotion is applied.
                  "currency": "A String", # The currency of the price.
                  "value": "A String", # The price represented as a number.
                },
                "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
              },
            ],
            "longTitle": "A String", # The full title of the promotion.
            "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
            "redemptionChannel": "A String", # Indicates that the promotion is valid online.
            "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
            "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
                # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
            "id": "A String", # The unique ID of the promotion.
          },
        ],
        "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
        "shippingCostTax": { # The tax for the total shipping cost.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "shipments": [ # Shipments of the order.
          {
            "status": "A String", # The status of the shipment.
            "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
            "carrier": "A String", # The carrier handling the shipment.
            "trackingId": "A String", # The tracking id for the shipment.
            "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
            "lineItems": [ # The line items that are shipped.
              {
                "lineItemId": "A String", # The id of the line item that is shipped.
                "quantity": 42, # The quantity that is shipped.
              },
            ],
            "id": "A String", # The id of the shipment.
          },
        ],
        "refunds": [ # Refunds for the order.
          {
            "amount": { # The amount that is refunded.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
            "reason": "A String", # The reason for the refund.
            "actor": "A String", # The actor that created the refund.
            "reasonText": "A String", # The explanation of the reason.
          },
        ],
        "paymentMethod": { # The details of the payment method.
          "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
          "lastFourDigits": "A String", # The last four digits of the card number.
          "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
          "phoneNumber": "A String", # The billing phone number.
          "billingAddress": { # The billing address.
            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
            "country": "A String", # CLDR country code (e.g. "US").
            "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                # John Smith
                # 1600 Amphitheatre Parkway
                # Mountain View, CA, 94043
                # United States
              "A String",
            ],
            "streetAddress": [ # Street-level part of the address.
              "A String",
            ],
            "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
            "recipientName": "A String", # Name of the recipient.
            "isPostOfficeBox": True or False, # Whether the address is a post office box.
            "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
          },
          "type": "A String", # The type of instrument (VISA, Mastercard, etc).
        },
        "shippingCost": { # The total cost of shipping for all items.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "acknowledged": True or False, # Whether the order was acknowledged.
        "paymentStatus": "A String", # The status of the payment.
        "merchantId": "A String",
        "merchantOrderId": "A String", # Merchant-provided id of the order.
        "shippingOption": "A String", # The requested shipping option.
        "status": "A String", # The status of the order.
        "deliveryDetails": { # The details for the delivery.
          "phoneNumber": "A String", # The phone number of the person receiving the delivery.
          "address": { # The delivery address
            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
            "country": "A String", # CLDR country code (e.g. "US").
            "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
                # John Smith
                # 1600 Amphitheatre Parkway
                # Mountain View, CA, 94043
                # United States
              "A String",
            ],
            "streetAddress": [ # Street-level part of the address.
              "A String",
            ],
            "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
            "recipientName": "A String", # Name of the recipient.
            "isPostOfficeBox": True or False, # Whether the address is a post office box.
            "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
          },
        },
        "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
        "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
        "lineItems": [ # Line items that are ordered.
          {
            "product": { # Product data from the time of the order placement.
              "targetCountry": "A String", # The CLDR territory code of the target country of the product.
              "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
              "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
              "title": "A String", # The title of the product.
              "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
              "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
                {
                  "dimension": "A String", # The dimension of the variant.
                  "value": "A String", # The value for the dimension.
                },
              ],
              "brand": "A String", # Brand of the item.
              "itemGroupId": "A String", # Shared identifier for all variants of the same product.
              "offerId": "A String", # An identifier of the item.
              "price": { # Price of the item.
                "currency": "A String", # The currency of the price.
                "value": "A String", # The price represented as a number.
              },
              "imageLink": "A String", # URL of an image of the item.
              "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
              "channel": "A String", # The item's channel (online or local).
              "id": "A String", # The REST id of the product.
              "condition": "A String", # Condition or state of the item.
            },
            "quantityDelivered": 42, # Number of items delivered.
            "returnInfo": { # Details of the return policy for the line item.
              "policyUrl": "A String", # URL of the item return policy.
              "isReturnable": True or False, # Whether the item is returnable.
              "daysToReturn": 42, # How many days later the item can be returned.
            },
            "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "quantityPending": 42, # Number of items pending.
            "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
              "currency": "A String", # The currency of the price.
              "value": "A String", # The price represented as a number.
            },
            "cancellations": [ # Cancellations of the line item.
              {
                "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
                "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
                "reasonText": "A String", # The explanation of the reason.
                "actor": "A String", # The actor that created the cancellation.
                "quantity": 42, # The quantity that was canceled.
              },
            ],
            "quantityCanceled": 42, # Number of items canceled.
            "quantityOrdered": 42, # Number of items ordered.
            "returns": [ # Returns of the line item.
              {
                "reason": "A String", # The reason for the return.
                "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
                "reasonText": "A String", # The explanation of the reason.
                "actor": "A String", # The actor that created the refund.
                "quantity": 42, # Quantity that is returned.
              },
            ],
            "quantityShipped": 42, # Number of items shipped.
            "quantityReturned": 42, # Number of items returned.
            "id": "A String", # The id of the line item.
            "shippingDetails": { # Details of the requested shipping for the line item.
              "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
              "method": { # Details of the shipping method.
                "minDaysInTransit": 42, # Minimum transit time.
                "carrier": "A String", # The carrier for the shipping. Optional.
                "methodName": "A String", # The name of the shipping method.
                "maxDaysInTransit": 42, # Maximum transit time.
              },
              "shipByDate": "A String", # The ship by date, in ISO 8601 format.
            },
          },
        ],
        "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "id": "A String", # The REST id of the order. Globally unique.
      },
    ],
  }
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.
refund(merchantId, orderId, body) 
Refund a portion of the order, up to the full amount paid.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order to refund. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "amount": { # The amount that is refunded.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "reasonText": "A String", # The explanation of the reason.
    "reason": "A String", # The reason for the refund.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".
    "executionStatus": "A String", # The status of the execution.
  }
returnlineitem(merchantId, orderId, body) 
Returns a line item.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "reason": "A String", # The reason for the return.
    "quantity": 42, # The quantity to return.
    "reasonText": "A String", # The explanation of the reason.
    "lineItemId": "A String", # The ID of the line item to return.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".
    "executionStatus": "A String", # The status of the execution.
  }
shiplineitems(merchantId, orderId, body) 
Marks line item(s) as shipped.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "lineItems": [ # Line items to ship.
      {
        "lineItemId": "A String", # The id of the line item that is shipped.
        "quantity": 42, # The quantity that is shipped.
      },
    ],
    "carrier": "A String", # The carrier handling the shipment.
    "shipmentId": "A String", # The ID of the shipment.
    "trackingId": "A String", # The tracking id for the shipment.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
    "executionStatus": "A String", # The status of the execution.
  }
updatemerchantorderid(merchantId, orderId, body) 
Updates the merchant order ID for a given order.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
    "executionStatus": "A String", # The status of the execution.
  }
updateshipment(merchantId, orderId, body) 
Updates a shipment's status, carrier, and/or tracking ID.

Args:
  merchantId: string, The ID of the managing account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "status": "A String", # New status for the shipment. Not updated if missing.
    "shipmentId": "A String", # The ID of the shipment.
    "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
    "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
  }


Returns:
  An object of the form:

    {
    "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
    "executionStatus": "A String", # The status of the execution.
  }
google-api-python-client-1.5.5/docs/dyn/customsearch_v1.cse.html000066400000000000000000000257111300622755700246440ustar00rootroot00000000000000

CustomSearch API . cse

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": [
          {
            "label_with_op": "A String",
            "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": [
        [
          {
            "label_with_op": "A String",
            "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,
    },
  }
google-api-python-client-1.5.5/docs/dyn/customsearch_v1.html000066400000000000000000000041121300622755700240630ustar00rootroot00000000000000

CustomSearch API

Instance Methods

cse()

Returns the cse Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.html000066400000000000000000000041301300622755700234110ustar00rootroot00000000000000

Google Dataflow API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.projects.html000066400000000000000000000140761300622755700252530ustar00rootroot00000000000000

Google Dataflow API . projects

Instance Methods

jobs()

Returns the jobs Resource.

templates()

Returns the templates Resource.

workerMessages(projectId, body, x__xgafv=None)

Send a worker_message to the service.

Method Details

workerMessages(projectId, body, x__xgafv=None) 
Send a worker_message to the service.

Args:
  projectId: string, The project to send the WorkerMessages to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request for sending worker messages to the service.
    "workerMessages": [ # The WorkerMessages to send.
      { # WorkerMessage provides information to the backend about a worker.
        "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. # The health of a worker.
          "pods": [ # The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker.
            {
              "a_key": "", # Properties of the object.
            },
          ],
          "reportInterval": "A String", # The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker.
          "vmStartupTime": "A String", # The time the VM was booted.
          "vmIsHealthy": True or False, # Whether the VM is healthy.
        },
        "labels": { # Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.
          "a_key": "A String",
        },
        "workerMessageCode": { # A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). # A worker message code.
          "code": "A String", # The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change.
          "parameters": { # Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.
            "a_key": "", # Properties of the object.
          },
        },
        "time": "A String", # The timestamp of the worker_message.
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response to the worker messages.
    "workerMessageResponses": [ # The servers response to the worker messages.
      { # A worker_message response allows the server to pass information to the sender.
        "workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker in response to a health ping. # The service's response to a worker's health report.
          "reportInterval": "A String", # A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server.
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.projects.jobs.debug.html000066400000000000000000000062261300622755700272720ustar00rootroot00000000000000

Google Dataflow API . projects . jobs . debug

Instance Methods

getConfig(projectId, jobId, body, x__xgafv=None)

Get encoded debug configuration for component. Not cacheable.

sendCapture(projectId, jobId, body, x__xgafv=None)

Send encoded debug capture data for component.

Method Details

getConfig(projectId, jobId, body, x__xgafv=None) 
Get encoded debug configuration for component. Not cacheable.

Args:
  projectId: string, The project id. (required)
  jobId: string, The job id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to get updated debug configuration for component.
    "workerId": "A String", # The worker id, i.e., VM hostname.
    "componentId": "A String", # The internal component id for which debug configuration is requested.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response to a get debug configuration request.
    "config": "A String", # The encoded debug configuration for the requested component.
  }
sendCapture(projectId, jobId, body, x__xgafv=None) 
Send encoded debug capture data for component.

Args:
  projectId: string, The project id. (required)
  jobId: string, The job id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to send encoded debug information.
    "workerId": "A String", # The worker id, i.e., VM hostname.
    "data": "A String", # The encoded debug information.
    "componentId": "A String", # The internal component id for which debug information is sent.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response to a send capture request. nothing
  }
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.projects.jobs.html000066400000000000000000003437731300622755700262200ustar00rootroot00000000000000

Google Dataflow API . projects . jobs

Instance Methods

debug()

Returns the debug Resource.

messages()

Returns the messages Resource.

workItems()

Returns the workItems Resource.

create(projectId, body, x__xgafv=None, replaceJobId=None, view=None)

Creates a dataflow job.

get(projectId, jobId, x__xgafv=None, view=None)

Gets the state of the specified dataflow job.

getMetrics(projectId, jobId, startTime=None, x__xgafv=None)

Request the job status.

list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None, view=None)

List the jobs of a project

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(projectId, jobId, body, x__xgafv=None)

Updates the state of an existing dataflow job.

Method Details

create(projectId, body, x__xgafv=None, replaceJobId=None, view=None) 
Creates a dataflow job.

Args:
  projectId: string, The project which owns the job. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines a job to be run by the Dataflow service.
    "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
    "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
    "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
    "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
    "projectId": "A String", # The project which owns the job.
    "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
      "a_key": "A String",
    },
    "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
      "a_key": "A String",
    },
    "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
    "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
      "version": { # A structure describing which components and their versions of the service are required in order to run the job.
        "a_key": "", # Properties of the object.
      },
      "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
      "internalExperiments": { # Experimental settings.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
      "experiments": [ # The list of experiments to enable.
        "A String",
      ],
      "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
      "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
        "a_key": "", # Properties of the object.
      },
      "userAgent": { # A description of the process that generated the request.
        "a_key": "", # Properties of the object.
      },
      "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
      "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
        { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
          "diskSourceImage": "A String", # Fully qualified source image for disks.
          "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
            "workflowFileName": "A String", # Store the workflow in this file.
            "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            "commandlinesFileName": "A String", # Store preprocessing commands in this file.
            "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
              "reportingEnabled": True or False, # Send work progress updates to service.
              "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
              "workerId": "A String", # ID of the worker running this pipeline.
              "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
              "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
              "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            },
            "vmId": "A String", # ID string of VM.
            "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
            "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
            "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
            "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
            "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
            "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
              "A String",
            ],
            "languageHint": "A String", # Suggested backend language.
            "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
            "streamingWorkerMainClass": "A String", # Streaming worker main class name.
            "logDir": "A String", # Directory on the VM to store logs.
            "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
            "harnessCommand": "A String", # Command to launch the worker harness.
            "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
          },
          "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
          "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
          "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
          "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
          "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
          "ipConfiguration": "A String", # Configuration for VM IPs.
          "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
          "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
          "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
          "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
          "metadata": { # Metadata to set on the Google Compute Engine VMs.
            "a_key": "A String",
          },
          "poolArgs": { # Extra arguments for this worker pool.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
          "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
          "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
          "packages": [ # Packages to be installed on workers.
            { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
              "name": "A String", # The name of the package.
              "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
            },
          ],
          "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
            "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
            "algorithm": "A String", # The algorithm to use for autoscaling.
          },
          "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
          "dataDisks": [ # Data disks that are used by a VM in this workflow.
            { # Describes the data disk used by a workflow job.
              "mountPoint": "A String", # Directory in a VM where disk is mounted.
              "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
              "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                  # /zones//diskTypes/pd-standard
            },
          ],
        },
      ],
    },
    "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
    "steps": [ # The top-level steps that constitute the entire job.
      { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
        "kind": "A String", # The kind of step in the dataflow Job.
        "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
        "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
          "a_key": "", # Properties of the object.
        },
      },
    ],
    "currentStateTime": "A String", # The timestamp associated with the current state.
    "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
      "A String",
    ],
    "type": "A String", # The type of dataflow job.
    "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
    "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
    "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
      "stages": { # A mapping from each stage to the information about that stage.
        "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
          "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
            "A String",
          ],
        },
      },
    },
  }

  x__xgafv: string, V1 error format.
  replaceJobId: string, DEPRECATED. This field is now on the Job message.
  view: string, Level of information requested in response.

Returns:
  An object of the form:

    { # Defines a job to be run by the Dataflow service.
      "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
      "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
      "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
      "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
      "projectId": "A String", # The project which owns the job.
      "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
        "a_key": "A String",
      },
      "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
        "a_key": "A String",
      },
      "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
      "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
        "version": { # A structure describing which components and their versions of the service are required in order to run the job.
          "a_key": "", # Properties of the object.
        },
        "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "internalExperiments": { # Experimental settings.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
        "experiments": [ # The list of experiments to enable.
          "A String",
        ],
        "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
        "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
          "a_key": "", # Properties of the object.
        },
        "userAgent": { # A description of the process that generated the request.
          "a_key": "", # Properties of the object.
        },
        "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
        "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
          { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
            "diskSourceImage": "A String", # Fully qualified source image for disks.
            "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
              "workflowFileName": "A String", # Store the workflow in this file.
              "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "commandlinesFileName": "A String", # Store preprocessing commands in this file.
              "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
                "reportingEnabled": True or False, # Send work progress updates to service.
                "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
                "workerId": "A String", # ID of the worker running this pipeline.
                "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
                "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
                "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              },
              "vmId": "A String", # ID string of VM.
              "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
              "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
              "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
              "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
              "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
              "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
                "A String",
              ],
              "languageHint": "A String", # Suggested backend language.
              "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
              "streamingWorkerMainClass": "A String", # Streaming worker main class name.
              "logDir": "A String", # Directory on the VM to store logs.
              "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
              "harnessCommand": "A String", # Command to launch the worker harness.
              "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
            },
            "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
            "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
            "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
            "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
            "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
            "ipConfiguration": "A String", # Configuration for VM IPs.
            "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
            "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
            "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
            "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
            "metadata": { # Metadata to set on the Google Compute Engine VMs.
              "a_key": "A String",
            },
            "poolArgs": { # Extra arguments for this worker pool.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
            "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
            "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
            "packages": [ # Packages to be installed on workers.
              { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
                "name": "A String", # The name of the package.
                "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
              },
            ],
            "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
              "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
              "algorithm": "A String", # The algorithm to use for autoscaling.
            },
            "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
            "dataDisks": [ # Data disks that are used by a VM in this workflow.
              { # Describes the data disk used by a workflow job.
                "mountPoint": "A String", # Directory in a VM where disk is mounted.
                "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
                "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                    # /zones//diskTypes/pd-standard
              },
            ],
          },
        ],
      },
      "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
      "steps": [ # The top-level steps that constitute the entire job.
        { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
          "kind": "A String", # The kind of step in the dataflow Job.
          "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
          "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
            "a_key": "", # Properties of the object.
          },
        },
      ],
      "currentStateTime": "A String", # The timestamp associated with the current state.
      "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "A String",
      ],
      "type": "A String", # The type of dataflow job.
      "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
      "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
      "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
        "stages": { # A mapping from each stage to the information about that stage.
          "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
            "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
              "A String",
            ],
          },
        },
      },
    }
get(projectId, jobId, x__xgafv=None, view=None) 
Gets the state of the specified dataflow job.

Args:
  projectId: string, The project which owns the job. (required)
  jobId: string, Identifies a single job. (required)
  x__xgafv: string, V1 error format.
  view: string, Level of information requested in response.

Returns:
  An object of the form:

    { # Defines a job to be run by the Dataflow service.
      "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
      "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
      "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
      "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
      "projectId": "A String", # The project which owns the job.
      "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
        "a_key": "A String",
      },
      "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
        "a_key": "A String",
      },
      "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
      "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
        "version": { # A structure describing which components and their versions of the service are required in order to run the job.
          "a_key": "", # Properties of the object.
        },
        "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "internalExperiments": { # Experimental settings.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
        "experiments": [ # The list of experiments to enable.
          "A String",
        ],
        "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
        "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
          "a_key": "", # Properties of the object.
        },
        "userAgent": { # A description of the process that generated the request.
          "a_key": "", # Properties of the object.
        },
        "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
        "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
          { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
            "diskSourceImage": "A String", # Fully qualified source image for disks.
            "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
              "workflowFileName": "A String", # Store the workflow in this file.
              "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "commandlinesFileName": "A String", # Store preprocessing commands in this file.
              "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
                "reportingEnabled": True or False, # Send work progress updates to service.
                "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
                "workerId": "A String", # ID of the worker running this pipeline.
                "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
                "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
                "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              },
              "vmId": "A String", # ID string of VM.
              "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
              "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
              "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
              "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
              "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
              "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
                "A String",
              ],
              "languageHint": "A String", # Suggested backend language.
              "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
              "streamingWorkerMainClass": "A String", # Streaming worker main class name.
              "logDir": "A String", # Directory on the VM to store logs.
              "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
              "harnessCommand": "A String", # Command to launch the worker harness.
              "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
            },
            "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
            "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
            "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
            "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
            "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
            "ipConfiguration": "A String", # Configuration for VM IPs.
            "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
            "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
            "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
            "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
            "metadata": { # Metadata to set on the Google Compute Engine VMs.
              "a_key": "A String",
            },
            "poolArgs": { # Extra arguments for this worker pool.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
            "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
            "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
            "packages": [ # Packages to be installed on workers.
              { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
                "name": "A String", # The name of the package.
                "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
              },
            ],
            "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
              "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
              "algorithm": "A String", # The algorithm to use for autoscaling.
            },
            "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
            "dataDisks": [ # Data disks that are used by a VM in this workflow.
              { # Describes the data disk used by a workflow job.
                "mountPoint": "A String", # Directory in a VM where disk is mounted.
                "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
                "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                    # /zones//diskTypes/pd-standard
              },
            ],
          },
        ],
      },
      "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
      "steps": [ # The top-level steps that constitute the entire job.
        { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
          "kind": "A String", # The kind of step in the dataflow Job.
          "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
          "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
            "a_key": "", # Properties of the object.
          },
        },
      ],
      "currentStateTime": "A String", # The timestamp associated with the current state.
      "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "A String",
      ],
      "type": "A String", # The type of dataflow job.
      "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
      "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
      "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
        "stages": { # A mapping from each stage to the information about that stage.
          "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
            "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
              "A String",
            ],
          },
        },
      },
    }
getMetrics(projectId, jobId, startTime=None, x__xgafv=None) 
Request the job status.

Args:
  projectId: string, A project id. (required)
  jobId: string, The job to get messages for. (required)
  startTime: string, Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # JobMetrics contains a collection of metrics descibing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
    "metrics": [ # All metrics for this job.
      { # Describes the state of a metric.
        "meanCount": "", # Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
        "kind": "A String", # Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", and "Or". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
        "set": "", # Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
        "name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric.
          "origin": "A String", # Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.
          "name": "A String", # Worker-defined metric name.
          "context": { # Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] =
              # .
            "a_key": "A String",
          },
        },
        "cumulative": True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
        "updateTime": "A String", # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
        "scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
        "meanSum": "", # Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
        "internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.
      },
    ],
    "metricTime": "A String", # Timestamp as of which metric values are current.
  }
list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None, view=None) 
List the jobs of a project

Args:
  projectId: string, The project which owns the jobs. (required)
  pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
  filter: string, The kind of filter to use.
  pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
  x__xgafv: string, V1 error format.
  view: string, Level of information requested in response. Default is SUMMARY.

Returns:
  An object of the form:

    { # Response to a request to list Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest.
    "nextPageToken": "A String", # Set if there may be more results than fit in this response.
    "jobs": [ # A subset of the requested job information.
      { # Defines a job to be run by the Dataflow service.
          "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
          "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
          "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
          "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
          "projectId": "A String", # The project which owns the job.
          "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
            "a_key": "A String",
          },
          "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
            "a_key": "A String",
          },
          "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
          "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
            "version": { # A structure describing which components and their versions of the service are required in order to run the job.
              "a_key": "", # Properties of the object.
            },
            "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            "internalExperiments": { # Experimental settings.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
            "experiments": [ # The list of experiments to enable.
              "A String",
            ],
            "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
            "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
              "a_key": "", # Properties of the object.
            },
            "userAgent": { # A description of the process that generated the request.
              "a_key": "", # Properties of the object.
            },
            "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
            "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
              { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
                "diskSourceImage": "A String", # Fully qualified source image for disks.
                "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
                  "workflowFileName": "A String", # Store the workflow in this file.
                  "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
                  "commandlinesFileName": "A String", # Store preprocessing commands in this file.
                  "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
                    "reportingEnabled": True or False, # Send work progress updates to service.
                    "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
                    "workerId": "A String", # ID of the worker running this pipeline.
                    "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
                    "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
                    "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
                  },
                  "vmId": "A String", # ID string of VM.
                  "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
                  "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
                  "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
                  "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
                  "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
                  "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
                    "A String",
                  ],
                  "languageHint": "A String", # Suggested backend language.
                  "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
                  "streamingWorkerMainClass": "A String", # Streaming worker main class name.
                  "logDir": "A String", # Directory on the VM to store logs.
                  "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
                  "harnessCommand": "A String", # Command to launch the worker harness.
                  "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
                  "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
                },
                "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
                "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
                "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
                "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
                "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
                "ipConfiguration": "A String", # Configuration for VM IPs.
                "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
                "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
                "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
                "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
                "metadata": { # Metadata to set on the Google Compute Engine VMs.
                  "a_key": "A String",
                },
                "poolArgs": { # Extra arguments for this worker pool.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
                "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
                "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
                "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
                "packages": [ # Packages to be installed on workers.
                  { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
                    "name": "A String", # The name of the package.
                    "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
                  },
                ],
                "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
                  "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
                  "algorithm": "A String", # The algorithm to use for autoscaling.
                },
                "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
                "dataDisks": [ # Data disks that are used by a VM in this workflow.
                  { # Describes the data disk used by a workflow job.
                    "mountPoint": "A String", # Directory in a VM where disk is mounted.
                    "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
                    "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                        # /zones//diskTypes/pd-standard
                  },
                ],
              },
            ],
          },
          "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
          "steps": [ # The top-level steps that constitute the entire job.
            { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
              "kind": "A String", # The kind of step in the dataflow Job.
              "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
              "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
                "a_key": "", # Properties of the object.
              },
            },
          ],
          "currentStateTime": "A String", # The timestamp associated with the current state.
          "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            "A String",
          ],
          "type": "A String", # The type of dataflow job.
          "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
          "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
          "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
            "stages": { # A mapping from each stage to the information about that stage.
              "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
                "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
                  "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.
update(projectId, jobId, body, x__xgafv=None) 
Updates the state of an existing dataflow job.

Args:
  projectId: string, The project which owns the job. (required)
  jobId: string, Identifies a single job. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines a job to be run by the Dataflow service.
    "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
    "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
    "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
    "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
    "projectId": "A String", # The project which owns the job.
    "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
      "a_key": "A String",
    },
    "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
      "a_key": "A String",
    },
    "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
    "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
      "version": { # A structure describing which components and their versions of the service are required in order to run the job.
        "a_key": "", # Properties of the object.
      },
      "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
      "internalExperiments": { # Experimental settings.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
      "experiments": [ # The list of experiments to enable.
        "A String",
      ],
      "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
      "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
        "a_key": "", # Properties of the object.
      },
      "userAgent": { # A description of the process that generated the request.
        "a_key": "", # Properties of the object.
      },
      "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
      "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
        { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
          "diskSourceImage": "A String", # Fully qualified source image for disks.
          "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
            "workflowFileName": "A String", # Store the workflow in this file.
            "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            "commandlinesFileName": "A String", # Store preprocessing commands in this file.
            "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
              "reportingEnabled": True or False, # Send work progress updates to service.
              "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
              "workerId": "A String", # ID of the worker running this pipeline.
              "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
              "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
              "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            },
            "vmId": "A String", # ID string of VM.
            "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
            "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
            "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
            "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
            "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
            "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
              "A String",
            ],
            "languageHint": "A String", # Suggested backend language.
            "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
            "streamingWorkerMainClass": "A String", # Streaming worker main class name.
            "logDir": "A String", # Directory on the VM to store logs.
            "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
            "harnessCommand": "A String", # Command to launch the worker harness.
            "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
            "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
          },
          "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
          "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
          "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
          "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
          "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
          "ipConfiguration": "A String", # Configuration for VM IPs.
          "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
          "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
          "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
          "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
          "metadata": { # Metadata to set on the Google Compute Engine VMs.
            "a_key": "A String",
          },
          "poolArgs": { # Extra arguments for this worker pool.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
          "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
          "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
          "packages": [ # Packages to be installed on workers.
            { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
              "name": "A String", # The name of the package.
              "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
            },
          ],
          "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
            "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
            "algorithm": "A String", # The algorithm to use for autoscaling.
          },
          "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
          "dataDisks": [ # Data disks that are used by a VM in this workflow.
            { # Describes the data disk used by a workflow job.
              "mountPoint": "A String", # Directory in a VM where disk is mounted.
              "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
              "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                  # /zones//diskTypes/pd-standard
            },
          ],
        },
      ],
    },
    "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
    "steps": [ # The top-level steps that constitute the entire job.
      { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
        "kind": "A String", # The kind of step in the dataflow Job.
        "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
        "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
          "a_key": "", # Properties of the object.
        },
      },
    ],
    "currentStateTime": "A String", # The timestamp associated with the current state.
    "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
      "A String",
    ],
    "type": "A String", # The type of dataflow job.
    "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
    "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
    "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
      "stages": { # A mapping from each stage to the information about that stage.
        "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
          "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
            "A String",
          ],
        },
      },
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines a job to be run by the Dataflow service.
      "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
      "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
      "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
      "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
      "projectId": "A String", # The project which owns the job.
      "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
        "a_key": "A String",
      },
      "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
        "a_key": "A String",
      },
      "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
      "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
        "version": { # A structure describing which components and their versions of the service are required in order to run the job.
          "a_key": "", # Properties of the object.
        },
        "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "internalExperiments": { # Experimental settings.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
        "experiments": [ # The list of experiments to enable.
          "A String",
        ],
        "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
        "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
          "a_key": "", # Properties of the object.
        },
        "userAgent": { # A description of the process that generated the request.
          "a_key": "", # Properties of the object.
        },
        "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
        "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
          { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
            "diskSourceImage": "A String", # Fully qualified source image for disks.
            "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
              "workflowFileName": "A String", # Store the workflow in this file.
              "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "commandlinesFileName": "A String", # Store preprocessing commands in this file.
              "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
                "reportingEnabled": True or False, # Send work progress updates to service.
                "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
                "workerId": "A String", # ID of the worker running this pipeline.
                "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
                "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
                "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              },
              "vmId": "A String", # ID string of VM.
              "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
              "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
              "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
              "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
              "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
              "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
                "A String",
              ],
              "languageHint": "A String", # Suggested backend language.
              "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
              "streamingWorkerMainClass": "A String", # Streaming worker main class name.
              "logDir": "A String", # Directory on the VM to store logs.
              "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
              "harnessCommand": "A String", # Command to launch the worker harness.
              "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
            },
            "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
            "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
            "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
            "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
            "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
            "ipConfiguration": "A String", # Configuration for VM IPs.
            "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
            "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
            "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
            "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
            "metadata": { # Metadata to set on the Google Compute Engine VMs.
              "a_key": "A String",
            },
            "poolArgs": { # Extra arguments for this worker pool.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
            "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
            "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
            "packages": [ # Packages to be installed on workers.
              { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
                "name": "A String", # The name of the package.
                "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
              },
            ],
            "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
              "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
              "algorithm": "A String", # The algorithm to use for autoscaling.
            },
            "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
            "dataDisks": [ # Data disks that are used by a VM in this workflow.
              { # Describes the data disk used by a workflow job.
                "mountPoint": "A String", # Directory in a VM where disk is mounted.
                "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
                "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                    # /zones//diskTypes/pd-standard
              },
            ],
          },
        ],
      },
      "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
      "steps": [ # The top-level steps that constitute the entire job.
        { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
          "kind": "A String", # The kind of step in the dataflow Job.
          "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
          "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
            "a_key": "", # Properties of the object.
          },
        },
      ],
      "currentStateTime": "A String", # The timestamp associated with the current state.
      "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "A String",
      ],
      "type": "A String", # The type of dataflow job.
      "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
      "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
      "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
        "stages": { # A mapping from each stage to the information about that stage.
          "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
            "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
              "A String",
            ],
          },
        },
      },
    }
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.projects.jobs.messages.html000066400000000000000000000075351300622755700300170ustar00rootroot00000000000000

Google Dataflow API . projects . jobs . messages

Instance Methods

list(projectId, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, minimumImportance=None, endTime=None)

Request the job status.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(projectId, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, minimumImportance=None, endTime=None) 
Request the job status.

Args:
  projectId: string, A project id. (required)
  jobId: string, The job to get messages about. (required)
  startTime: string, If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
  pageSize: integer, If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
  x__xgafv: string, V1 error format.
  pageToken: string, If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
  minimumImportance: string, Filter to only get messages with importance >= level
  endTime: string, Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

Returns:
  An object of the form:

    { # Response to a request to list job messages.
    "nextPageToken": "A String", # The token to obtain the next page of results if there are more.
    "jobMessages": [ # Messages in ascending timestamp order.
      { # A particular message pertaining to a Dataflow job.
        "messageImportance": "A String", # Importance level of the message.
        "messageText": "A String", # The text of the message.
        "id": "A String", # Identifies the message. This is automatically generated by the service; the caller should treat it as an opaque string.
        "time": "A String", # The timestamp of the message.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html000066400000000000000000003471271300622755700302000ustar00rootroot00000000000000

Google Dataflow API . projects . jobs . workItems

Instance Methods

lease(projectId, jobId, body, x__xgafv=None)

Leases a dataflow WorkItem to run.

reportStatus(projectId, jobId, body, x__xgafv=None)

Reports the status of dataflow WorkItems leased by a worker.

Method Details

lease(projectId, jobId, body, x__xgafv=None) 
Leases a dataflow WorkItem to run.

Args:
  projectId: string, Identifies the project this worker belongs to. (required)
  jobId: string, Identifies the workflow job this worker belongs to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to lease WorkItems.
    "workItemTypes": [ # Filter for WorkItem type.
      "A String",
    ],
    "requestedLeaseDuration": "A String", # The initial lease period.
    "workerCapabilities": [ # Worker capabilities. WorkItems might be limited to workers with specific capabilities.
      "A String",
    ],
    "currentWorkerTime": "A String", # The current timestamp at the worker.
    "workerId": "A String", # Identifies the worker leasing work -- typically the ID of the virtual machine running the worker.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response to a request to lease WorkItems.
    "workItems": [ # A list of the leased WorkItems.
      { # WorkItem represents basic information about a WorkItem to be executed in the cloud.
        "reportStatusInterval": "A String", # Recommended reporting interval.
        "leaseExpireTime": "A String", # Time when the lease on this Work will expire.
        "seqMapTask": { # Describes a particular function to invoke. # Additional information for SeqMapTask WorkItems.
          "inputs": [ # Information about each of the inputs.
            { # Information about a side input of a DoFn or an input of a SeqDoFn.
              "sources": [ # The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.
                { # A source that records can be read and decoded from.
                  "codec": { # The codec to use to decode data read from the source.
                    "a_key": "", # Properties of the object.
                  },
                  "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                    {
                      "a_key": "", # Properties of the object.
                    },
                  ],
                  "spec": { # The source to read from, plus its parameters.
                    "a_key": "", # Properties of the object.
                  },
                  "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                  "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                    "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                    "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                    "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                  },
                },
              ],
              "kind": { # How to interpret the source element(s) as a side input value.
                "a_key": "", # Properties of the object.
              },
              "tag": "A String", # The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.
            },
          ],
          "outputInfos": [ # Information about each of the outputs.
            { # Information about an output of a SeqMapTask.
              "tag": "A String", # The id of the TupleTag the user code will tag the output value by.
              "sink": { # A sink that records can be encoded and written to. # The sink to write the output value to.
                "codec": { # The codec to use to encode data written to the sink.
                  "a_key": "", # Properties of the object.
                },
                "spec": { # The sink to write to, plus its parameters.
                  "a_key": "", # Properties of the object.
                },
              },
            },
          ],
          "stageName": "A String", # System-defined name of the stage containing the SeqDo operation. Unique across the workflow.
          "systemName": "A String", # System-defined name of the SeqDo operation. Unique across the workflow.
          "userFn": { # The user function to invoke.
            "a_key": "", # Properties of the object.
          },
          "name": "A String", # The user-provided name of the SeqDo operation.
        },
        "projectId": "A String", # Identifies the cloud project this WorkItem belongs to.
        "sourceOperationTask": { # A work item that represents the different operations that can be performed on a user-defined Source specification. # Additional information for source operation WorkItems.
          "getMetadata": { # A request to compute the SourceMetadata of a Source. # Information about a request to get metadata about a source.
            "source": { # A source that records can be read and decoded from. # Specification of the source whose metadata should be computed.
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
          "split": { # Represents the operation to split a high-level Source specification into bundles (parts for parallel processing). At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource. As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it. # Information about a request to split a source.
            "source": { # A source that records can be read and decoded from. # Specification of the source to be split.
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
            "options": { # Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest. # Hints for tuning the splitting process.
              "desiredShardSizeBytes": "A String", # DEPRECATED in favor of desired_bundle_size_bytes.
              "desiredBundleSizeBytes": "A String", # The source should be split into a set of bundles where the estimated size of each is approximately this many bytes.
            },
          },
        },
        "initialReportIndex": "A String", # The initial index to use when reporting the status of the WorkItem.
        "mapTask": { # MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output. # Additional information for MapTask WorkItems.
          "systemName": "A String", # System-defined name of this MapTask. Unique across the workflow.
          "stageName": "A String", # System-defined name of the stage containing this MapTask. Unique across the workflow.
          "instructions": [ # The instructions in the MapTask.
            { # Describes a particular operation comprising a MapTask.
              "name": "A String", # User-provided name of this operation.
              "read": { # An instruction that reads records. Takes no inputs, produces one output. # Additional information for Read instructions.
                "source": { # A source that records can be read and decoded from. # The source to read from.
                  "codec": { # The codec to use to decode data read from the source.
                    "a_key": "", # Properties of the object.
                  },
                  "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                    {
                      "a_key": "", # Properties of the object.
                    },
                  ],
                  "spec": { # The source to read from, plus its parameters.
                    "a_key": "", # Properties of the object.
                  },
                  "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                  "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                    "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                    "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                    "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                  },
                },
              },
              "outputs": [ # Describes the outputs of the instruction.
                { # An output of an instruction.
                  "name": "A String", # The user-provided name of this output.
                  "onlyCountKeyBytes": True or False, # For system-generated byte and mean byte metrics, certain instructions should only report the key size.
                  "codec": { # The codec to use to encode data being written via this output.
                    "a_key": "", # Properties of the object.
                  },
                  "systemName": "A String", # System-defined name of this output. Unique across the workflow.
                  "originalName": "A String", # System-defined name for this output in the original workflow graph. Outputs that do not contribute to an original instruction do not set this.
                  "onlyCountValueBytes": True or False, # For system-generated byte and mean byte metrics, certain instructions should only report the value size.
                },
              ],
              "partialGroupByKey": { # An instruction that does a partial group-by-key. One input and one output. # Additional information for PartialGroupByKey instructions.
                "sideInputs": [ # Zero or more side inputs.
                  { # Information about a side input of a DoFn or an input of a SeqDoFn.
                    "sources": [ # The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.
                      { # A source that records can be read and decoded from.
                        "codec": { # The codec to use to decode data read from the source.
                          "a_key": "", # Properties of the object.
                        },
                        "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                          {
                            "a_key": "", # Properties of the object.
                          },
                        ],
                        "spec": { # The source to read from, plus its parameters.
                          "a_key": "", # Properties of the object.
                        },
                        "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                        "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                          "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                          "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                          "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                        },
                      },
                    ],
                    "kind": { # How to interpret the source element(s) as a side input value.
                      "a_key": "", # Properties of the object.
                    },
                    "tag": "A String", # The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.
                  },
                ],
                "originalCombineValuesInputStoreName": "A String", # If this instruction includes a combining function this is the name of the intermediate store between the GBK and the CombineValues.
                "originalCombineValuesStepName": "A String", # If this instruction includes a combining function, this is the name of the CombineValues instruction lifted into this instruction.
                "valueCombiningFn": { # The value combining function to invoke.
                  "a_key": "", # Properties of the object.
                },
                "input": { # An input of an instruction, as a reference to an output of a producer instruction. # Describes the input to the partial group-by-key instruction.
                  "outputNum": 42, # The output index (origin zero) within the producer.
                  "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                },
                "inputElementCodec": { # The codec to use for interpreting an element in the input PTable.
                  "a_key": "", # Properties of the object.
                },
              },
              "write": { # An instruction that writes records. Takes one input, produces no outputs. # Additional information for Write instructions.
                "input": { # An input of an instruction, as a reference to an output of a producer instruction. # The input.
                  "outputNum": 42, # The output index (origin zero) within the producer.
                  "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                },
                "sink": { # A sink that records can be encoded and written to. # The sink to write to.
                  "codec": { # The codec to use to encode data written to the sink.
                    "a_key": "", # Properties of the object.
                  },
                  "spec": { # The sink to write to, plus its parameters.
                    "a_key": "", # Properties of the object.
                  },
                },
              },
              "systemName": "A String", # System-defined name of this operation. Unique across the workflow.
              "flatten": { # An instruction that copies its inputs (zero or more) to its (single) output. # Additional information for Flatten instructions.
                "inputs": [ # Describes the inputs to the flatten instruction.
                  { # An input of an instruction, as a reference to an output of a producer instruction.
                    "outputNum": 42, # The output index (origin zero) within the producer.
                    "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                  },
                ],
              },
              "originalName": "A String", # System-defined name for the operation in the original workflow graph.
              "parDo": { # An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code. # Additional information for ParDo instructions.
                "sideInputs": [ # Zero or more side inputs.
                  { # Information about a side input of a DoFn or an input of a SeqDoFn.
                    "sources": [ # The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.
                      { # A source that records can be read and decoded from.
                        "codec": { # The codec to use to decode data read from the source.
                          "a_key": "", # Properties of the object.
                        },
                        "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                          {
                            "a_key": "", # Properties of the object.
                          },
                        ],
                        "spec": { # The source to read from, plus its parameters.
                          "a_key": "", # Properties of the object.
                        },
                        "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                        "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                          "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                          "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                          "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                        },
                      },
                    ],
                    "kind": { # How to interpret the source element(s) as a side input value.
                      "a_key": "", # Properties of the object.
                    },
                    "tag": "A String", # The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.
                  },
                ],
                "input": { # An input of an instruction, as a reference to an output of a producer instruction. # The input.
                  "outputNum": 42, # The output index (origin zero) within the producer.
                  "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                },
                "multiOutputInfos": [ # Information about each of the outputs, if user_fn is a MultiDoFn.
                  { # Information about an output of a multi-output DoFn.
                    "tag": "A String", # The id of the tag the user code will emit to this output by; this should correspond to the tag of some SideInputInfo.
                  },
                ],
                "numOutputs": 42, # The number of outputs.
                "userFn": { # The user function to invoke.
                  "a_key": "", # Properties of the object.
                },
              },
            },
          ],
        },
        "jobId": "A String", # Identifies the workflow job this WorkItem belongs to.
        "streamingComputationTask": { # A task which describes what action should be performed for the specified streaming computation ranges. # Additional information for StreamingComputationTask WorkItems.
          "dataDisks": [ # Describes the set of data disks this task should apply to.
            { # Describes mounted data disk.
              "dataDisk": "A String", # The name of the data disk. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
            },
          ],
          "computationRanges": [ # Contains ranges of a streaming computation this task should apply to.
            { # Describes full or partial data disk assignment information of the computation ranges.
              "rangeAssignments": [ # Data disk assignments for ranges from this computation.
                { # Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.
                  "start": "A String", # The start (inclusive) of the key range.
                  "end": "A String", # The end (exclusive) of the key range.
                  "dataDisk": "A String", # The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
                },
              ],
              "computationId": "A String", # The ID of the computation.
            },
          ],
          "taskType": "A String", # A type of streaming computation task.
        },
        "configuration": "A String", # Work item-specific configuration as an opaque blob.
        "streamingSetupTask": { # A task which initializes part of a streaming Dataflow job. # Additional information for StreamingSetupTask WorkItems.
          "workerHarnessPort": 42, # The TCP port used by the worker to communicate with the Dataflow worker harness.
          "drain": True or False, # The user has requested drain.
          "streamingComputationTopology": { # Global topology of the streaming Dataflow job, including all computations and their sharded locations. # The global topology of the streaming Dataflow job.
            "computations": [ # The computations associated with a streaming Dataflow job.
              { # All configuration data for a particular Computation.
                "inputs": [ # The inputs to the computation.
                  { # Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.
                    "streamingStageLocation": { # Identifies the location of a streaming computation stage, for stage-to-stage communication. # The stream is part of another computation within the current streaming Dataflow job.
                      "streamId": "A String", # Identifies the particular stream within the streaming Dataflow job.
                    },
                    "pubsubLocation": { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
                      "idLabel": "A String", # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
                      "timestampLabel": "A String", # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
                      "dropLateData": True or False, # Indicates whether the pipeline allows late-arriving data.
                      "topic": "A String", # A pubsub topic, in the form of "pubsub.googleapis.com/topics/
                          # /"
                      "trackingSubscription": "A String", # If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
                      "subscription": "A String", # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/
                          # /"
                    },
                    "customSourceLocation": { # Identifies the location of a custom souce. # The stream is a custom source.
                      "stateful": True or False, # Whether this source is stateful.
                    },
                    "sideInputLocation": { # Identifies the location of a streaming side input. # The stream is a streaming side input.
                      "stateFamily": "A String", # Identifies the state family where this side input is stored.
                      "tag": "A String", # Identifies the particular side input within the streaming Dataflow job.
                    },
                  },
                ],
                "systemStageName": "A String", # The system stage name.
                "keyRanges": [ # The key ranges processed by the computation.
                  { # Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.
                    "start": "A String", # The start (inclusive) of the key range.
                    "deliveryEndpoint": "A String", # The physical location of this range assignment to be used for streaming computation cross-worker message delivery.
                    "end": "A String", # The end (exclusive) of the key range.
                    "persistentDirectory": "A String", # The location of the persistent state for this range, as a persistent directory in the worker local filesystem.
                    "dataDisk": "A String", # The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
                  },
                ],
                "computationId": "A String", # The ID of the computation.
                "outputs": [ # The outputs from the computation.
                  { # Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.
                    "streamingStageLocation": { # Identifies the location of a streaming computation stage, for stage-to-stage communication. # The stream is part of another computation within the current streaming Dataflow job.
                      "streamId": "A String", # Identifies the particular stream within the streaming Dataflow job.
                    },
                    "pubsubLocation": { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
                      "idLabel": "A String", # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
                      "timestampLabel": "A String", # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
                      "dropLateData": True or False, # Indicates whether the pipeline allows late-arriving data.
                      "topic": "A String", # A pubsub topic, in the form of "pubsub.googleapis.com/topics/
                          # /"
                      "trackingSubscription": "A String", # If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
                      "subscription": "A String", # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/
                          # /"
                    },
                    "customSourceLocation": { # Identifies the location of a custom souce. # The stream is a custom source.
                      "stateful": True or False, # Whether this source is stateful.
                    },
                    "sideInputLocation": { # Identifies the location of a streaming side input. # The stream is a streaming side input.
                      "stateFamily": "A String", # Identifies the state family where this side input is stored.
                      "tag": "A String", # Identifies the particular side input within the streaming Dataflow job.
                    },
                  },
                ],
                "userStageName": "A String", # The user stage name.
                "stateFamilies": [ # The state family values.
                  { # State family configuration.
                    "stateFamily": "A String", # The state family value.
                    "isRead": True or False, # If true, this family corresponds to a read operation.
                  },
                ],
              },
            ],
            "dataDiskAssignments": [ # The disks assigned to a streaming Dataflow job.
              { # Data disk assignment for a given VM instance.
                "vmInstance": "A String", # VM instance name the data disks mounted to, for example "myproject-1014-104817-4c2-harness-0".
                "dataDisks": [ # Mounted data disks. The order is important a data disk's 0-based index in this list defines which persistent directory the disk is mounted to, for example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" }, { "myproject-1014-104817-4c2-harness-0-disk-1" }.
                  "A String",
                ],
              },
            ],
            "persistentStateVersion": 42, # Version number for persistent state.
            "userStageToComputationNameMap": { # Maps user stage names to stable computation names.
              "a_key": "A String",
            },
            "forwardingKeyBits": 42, # The size (in bits) of keys that will be assigned to source messages.
          },
          "receiveWorkPort": 42, # The TCP port on which the worker should listen for messages from other streaming computation workers.
        },
        "streamingConfigTask": { # A task that carries configuration information for streaming computations. # Additional information for StreamingConfigTask WorkItems.
          "userStepToStateFamilyNameMap": { # Map from user step names to state families.
            "a_key": "A String",
          },
          "streamingComputationConfigs": [ # Set of computation configuration information.
            { # Configuration information for a single streaming computation.
              "computationId": "A String", # Unique identifier for this computation.
              "systemName": "A String", # System defined name for this computation.
              "stageName": "A String", # Stage name of this computation.
              "instructions": [ # Instructions that comprise the computation.
                { # Describes a particular operation comprising a MapTask.
                  "name": "A String", # User-provided name of this operation.
                  "read": { # An instruction that reads records. Takes no inputs, produces one output. # Additional information for Read instructions.
                    "source": { # A source that records can be read and decoded from. # The source to read from.
                      "codec": { # The codec to use to decode data read from the source.
                        "a_key": "", # Properties of the object.
                      },
                      "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                        {
                          "a_key": "", # Properties of the object.
                        },
                      ],
                      "spec": { # The source to read from, plus its parameters.
                        "a_key": "", # Properties of the object.
                      },
                      "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                      "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                        "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                        "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                        "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                      },
                    },
                  },
                  "outputs": [ # Describes the outputs of the instruction.
                    { # An output of an instruction.
                      "name": "A String", # The user-provided name of this output.
                      "onlyCountKeyBytes": True or False, # For system-generated byte and mean byte metrics, certain instructions should only report the key size.
                      "codec": { # The codec to use to encode data being written via this output.
                        "a_key": "", # Properties of the object.
                      },
                      "systemName": "A String", # System-defined name of this output. Unique across the workflow.
                      "originalName": "A String", # System-defined name for this output in the original workflow graph. Outputs that do not contribute to an original instruction do not set this.
                      "onlyCountValueBytes": True or False, # For system-generated byte and mean byte metrics, certain instructions should only report the value size.
                    },
                  ],
                  "partialGroupByKey": { # An instruction that does a partial group-by-key. One input and one output. # Additional information for PartialGroupByKey instructions.
                    "sideInputs": [ # Zero or more side inputs.
                      { # Information about a side input of a DoFn or an input of a SeqDoFn.
                        "sources": [ # The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.
                          { # A source that records can be read and decoded from.
                            "codec": { # The codec to use to decode data read from the source.
                              "a_key": "", # Properties of the object.
                            },
                            "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                              {
                                "a_key": "", # Properties of the object.
                              },
                            ],
                            "spec": { # The source to read from, plus its parameters.
                              "a_key": "", # Properties of the object.
                            },
                            "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                            "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                              "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                              "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                              "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                            },
                          },
                        ],
                        "kind": { # How to interpret the source element(s) as a side input value.
                          "a_key": "", # Properties of the object.
                        },
                        "tag": "A String", # The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.
                      },
                    ],
                    "originalCombineValuesInputStoreName": "A String", # If this instruction includes a combining function this is the name of the intermediate store between the GBK and the CombineValues.
                    "originalCombineValuesStepName": "A String", # If this instruction includes a combining function, this is the name of the CombineValues instruction lifted into this instruction.
                    "valueCombiningFn": { # The value combining function to invoke.
                      "a_key": "", # Properties of the object.
                    },
                    "input": { # An input of an instruction, as a reference to an output of a producer instruction. # Describes the input to the partial group-by-key instruction.
                      "outputNum": 42, # The output index (origin zero) within the producer.
                      "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                    },
                    "inputElementCodec": { # The codec to use for interpreting an element in the input PTable.
                      "a_key": "", # Properties of the object.
                    },
                  },
                  "write": { # An instruction that writes records. Takes one input, produces no outputs. # Additional information for Write instructions.
                    "input": { # An input of an instruction, as a reference to an output of a producer instruction. # The input.
                      "outputNum": 42, # The output index (origin zero) within the producer.
                      "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                    },
                    "sink": { # A sink that records can be encoded and written to. # The sink to write to.
                      "codec": { # The codec to use to encode data written to the sink.
                        "a_key": "", # Properties of the object.
                      },
                      "spec": { # The sink to write to, plus its parameters.
                        "a_key": "", # Properties of the object.
                      },
                    },
                  },
                  "systemName": "A String", # System-defined name of this operation. Unique across the workflow.
                  "flatten": { # An instruction that copies its inputs (zero or more) to its (single) output. # Additional information for Flatten instructions.
                    "inputs": [ # Describes the inputs to the flatten instruction.
                      { # An input of an instruction, as a reference to an output of a producer instruction.
                        "outputNum": 42, # The output index (origin zero) within the producer.
                        "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                      },
                    ],
                  },
                  "originalName": "A String", # System-defined name for the operation in the original workflow graph.
                  "parDo": { # An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code. # Additional information for ParDo instructions.
                    "sideInputs": [ # Zero or more side inputs.
                      { # Information about a side input of a DoFn or an input of a SeqDoFn.
                        "sources": [ # The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.
                          { # A source that records can be read and decoded from.
                            "codec": { # The codec to use to decode data read from the source.
                              "a_key": "", # Properties of the object.
                            },
                            "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                              {
                                "a_key": "", # Properties of the object.
                              },
                            ],
                            "spec": { # The source to read from, plus its parameters.
                              "a_key": "", # Properties of the object.
                            },
                            "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                            "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                              "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                              "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                              "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                            },
                          },
                        ],
                        "kind": { # How to interpret the source element(s) as a side input value.
                          "a_key": "", # Properties of the object.
                        },
                        "tag": "A String", # The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.
                      },
                    ],
                    "input": { # An input of an instruction, as a reference to an output of a producer instruction. # The input.
                      "outputNum": 42, # The output index (origin zero) within the producer.
                      "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
                    },
                    "multiOutputInfos": [ # Information about each of the outputs, if user_fn is a MultiDoFn.
                      { # Information about an output of a multi-output DoFn.
                        "tag": "A String", # The id of the tag the user code will emit to this output by; this should correspond to the tag of some SideInputInfo.
                      },
                    ],
                    "numOutputs": 42, # The number of outputs.
                    "userFn": { # The user function to invoke.
                      "a_key": "", # Properties of the object.
                    },
                  },
                },
              ],
            },
          ],
        },
        "packages": [ # Any required packages that need to be fetched in order to execute this WorkItem.
          { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
            "name": "A String", # The name of the package.
            "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
          },
        ],
        "shellTask": { # A task which consists of a shell command for the worker to execute. # Additional information for ShellTask WorkItems.
          "command": "A String", # The shell command to run.
          "exitCode": 42, # Exit code for the task.
        },
        "id": "A String", # Identifies this WorkItem.
      },
    ],
  }
reportStatus(projectId, jobId, body, x__xgafv=None) 
Reports the status of dataflow WorkItems leased by a worker.

Args:
  projectId: string, The project which owns the WorkItem's job. (required)
  jobId: string, The job which the WorkItem is part of. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to report the status of WorkItems.
    "workerId": "A String", # The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service believes currently has the lease on the WorkItem, the report will be dropped (with an error response).
    "currentWorkerTime": "A String", # The current timestamp at the worker.
    "workItemStatuses": [ # The order is unimportant, except that the order of the WorkItemServiceState messages in the ReportWorkItemStatusResponse corresponds to the order of WorkItemStatus messages here.
      { # Conveys a worker's progress through the work described by a WorkItem.
        "reportIndex": "A String", # The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service.
        "errors": [ # Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed.
          { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
          },
        ],
        "sourceOperationResponse": { # The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed. # If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.
          "getMetadata": { # The result of a SourceGetMetadataOperation. # A response to a request to get metadata about a source.
            "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # The computed metadata.
              "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
              "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
              "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
            },
          },
          "split": { # The response to a SourceSplitRequest. # A response to a request to split a source.
            "outcome": "A String", # Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split.
            "bundles": [ # If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input.
              { # Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split.
                "derivationMode": "A String", # What source to base the produced source on (if any).
                "source": { # A source that records can be read and decoded from. # Specification of the source.
                  "codec": { # The codec to use to decode data read from the source.
                    "a_key": "", # Properties of the object.
                  },
                  "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                    {
                      "a_key": "", # Properties of the object.
                    },
                  ],
                  "spec": { # The source to read from, plus its parameters.
                    "a_key": "", # Properties of the object.
                  },
                  "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                  "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                    "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                    "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                    "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                  },
                },
              },
            ],
            "shards": [ # DEPRECATED in favor of bundles.
              { # DEPRECATED in favor of DerivedSource.
                "derivationMode": "A String", # DEPRECATED
                "source": { # A source that records can be read and decoded from. # DEPRECATED
                  "codec": { # The codec to use to decode data read from the source.
                    "a_key": "", # Properties of the object.
                  },
                  "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                    {
                      "a_key": "", # Properties of the object.
                    },
                  ],
                  "spec": { # The source to read from, plus its parameters.
                    "a_key": "", # Properties of the object.
                  },
                  "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                  "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                    "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                    "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                    "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
                  },
                },
              },
            ],
          },
        },
        "stopPosition": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work. This event is called a "dynamic split" and is critical to the dynamic work rebalancing feature. The two obtained sub-tasks are called "parts" of the split. The parts, if concatenated, must represent the same input as would be read by the current task if the split did not happen. The exact way in which the original task is decomposed into the two parts is specified either as a position demarcating them (stop_position), or explicitly as two DerivedSources, if this task consumes a user-defined source type (dynamic_source_split). The "current" task is adjusted as a result of the split: after a task with range [A, B) sends a stop_position update at C, its range is considered to be [A, C), e.g.: * Progress should be interpreted relative to the new range, e.g. "75% completed" means "75% of [A, C) completed" * The worker should interpret proposed_stop_position relative to the new range, e.g. "split at 68%" should be interpreted as "split at 68% of [A, C)". * If the worker chooses to split again using stop_position, only stop_positions in [A, C) will be accepted. * Etc. dynamic_source_split has similar semantics: e.g., if a task with source S splits using dynamic_source_split into {P, R} (where P and R must be together equivalent to S), then subsequent progress and proposed_stop_position should be interpreted relative to P, and in a potential subsequent dynamic_source_split into {P', R'}, P' and R' must be together equivalent to P, etc.
          "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range.
          "recordIndex": "A String", # Position is a record index.
          "byteOffset": "A String", # Position is a byte offset.
          "key": "A String", # Position is a string key, ordered lexicographically.
          "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position.
            "index": 42, # Index of the inner source.
            "position": # Object with schema name: Position # Position within the inner source.
          },
          "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
        },
        "sourceFork": { # DEPRECATED in favor of DynamicSourceSplit. # DEPRECATED in favor of dynamic_source_split.
          "residualSource": { # Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. # DEPRECATED
            "derivationMode": "A String", # What source to base the produced source on (if any).
            "source": { # A source that records can be read and decoded from. # Specification of the source.
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
          "primarySource": { # Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. # DEPRECATED
            "derivationMode": "A String", # What source to base the produced source on (if any).
            "source": { # A source that records can be read and decoded from. # Specification of the source.
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
          "primary": { # DEPRECATED in favor of DerivedSource. # DEPRECATED
            "derivationMode": "A String", # DEPRECATED
            "source": { # A source that records can be read and decoded from. # DEPRECATED
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
          "residual": { # DEPRECATED in favor of DerivedSource. # DEPRECATED
            "derivationMode": "A String", # DEPRECATED
            "source": { # A source that records can be read and decoded from. # DEPRECATED
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
        },
        "requestedLeaseDuration": "A String", # Amount of time the worker requests for its lease.
        "completed": True or False, # True if the WorkItem was completed (successfully or unsuccessfully).
        "workItemId": "A String", # Identifies the WorkItem.
        "dynamicSourceSplit": { # When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input. # See documentation of stop_position.
          "primary": { # Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. # Primary part (continued to be processed by worker). Specified relative to the previously-current source. Becomes current.
            "derivationMode": "A String", # What source to base the produced source on (if any).
            "source": { # A source that records can be read and decoded from. # Specification of the source.
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
          "residual": { # Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. # Residual part (returned to the pool of work). Specified relative to the previously-current source.
            "derivationMode": "A String", # What source to base the produced source on (if any).
            "source": { # A source that records can be read and decoded from. # Specification of the source.
              "codec": { # The codec to use to decode data read from the source.
                "a_key": "", # Properties of the object.
              },
              "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
                {
                  "a_key": "", # Properties of the object.
                },
              ],
              "spec": { # The source to read from, plus its parameters.
                "a_key": "", # Properties of the object.
              },
              "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
              "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
                "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source).
                "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
                "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
              },
            },
          },
        },
        "counterUpdates": [ # Worker output counters for this WorkItem.
          { # An update to a Counter sent from a worker.
            "floatingPointList": { # A metric value representing a list of floating point numbers. # List of floating point numbers, for Set.
              "elements": [ # Elements of the list.
                3.14,
              ],
            },
            "floatingPoint": 3.14, # Floating point value for Sum, Max, Min.
            "integerMean": { # A representation of an integer mean metric contribution. # Integer mean aggregation value for Mean.
              "count": { # A representation of an int64, n, that is immune to precision loss when encoded in JSON. # The number of values being aggregated.
                "lowBits": 42, # The low order bits: n & 0xffffffff.
                "highBits": 42, # The high order bits, including the sign: n >> 32.
              },
              "sum": { # A representation of an int64, n, that is immune to precision loss when encoded in JSON. # The sum of all values being aggregated.
                "lowBits": 42, # The low order bits: n & 0xffffffff.
                "highBits": 42, # The high order bits, including the sign: n >> 32.
              },
            },
            "integerList": { # A metric value representing a list of integers. # List of integers, for Set.
              "elements": [ # Elements of the list.
                { # A representation of an int64, n, that is immune to precision loss when encoded in JSON.
                  "lowBits": 42, # The low order bits: n & 0xffffffff.
                  "highBits": 42, # The high order bits, including the sign: n >> 32.
                },
              ],
            },
            "cumulative": True or False, # True if this counter is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this counter is reported as a delta.
            "floatingPointMean": { # A representation of a floating point mean metric contribution. # Floating point mean aggregation value for Mean.
              "count": { # A representation of an int64, n, that is immune to precision loss when encoded in JSON. # The number of values being aggregated.
                "lowBits": 42, # The low order bits: n & 0xffffffff.
                "highBits": 42, # The high order bits, including the sign: n >> 32.
              },
              "sum": 3.14, # The sum of all values being aggregated.
            },
            "shortId": "A String", # The service-generated short identifier for this counter. The short_id -> (name, metadata) mapping is constant for the lifetime of a job.
            "boolean": True or False, # Boolean value for And, Or.
            "structuredNameAndMetadata": { # A single message which encapsulates structured name and metadata for a given counter. # Counter structured name and metadata.
              "name": { # Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job. # Structured name of the counter.
                "executionStepName": "A String", # Name of the stage. An execution step contains multiple component steps.
                "name": "A String", # Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required.
                "workerId": "A String", # ID of a particular worker.
                "originalStepName": "A String", # System generated name of the original step in the user's graph, before optimization.
                "standardOrigin": "A String", # One of the standard Origins defined above.
                "portion": "A String", # Portion of this counter, either key or value.
                "otherOrigin": "A String", # A string containing the origin of the counter.
                "componentStepName": "A String", # Name of the optimized step being executed by the workers.
              },
              "metadata": { # CounterMetadata includes all static non-name non-value counter attributes. # Metadata associated with a counter
                "standardUnits": "A String", # System defined Units, see above enum.
                "kind": "A String", # Counter aggregation kind.
                "description": "A String", # Human-readable description of the counter semantics.
                "otherUnits": "A String", # A string referring to the unit type.
              },
            },
            "internal": "", # Value for internally-defined counters used by the Dataflow service.
            "integer": { # A representation of an int64, n, that is immune to precision loss when encoded in JSON. # Integer value for Sum, Max, Min.
              "lowBits": 42, # The low order bits: n & 0xffffffff.
              "highBits": 42, # The high order bits, including the sign: n >> 32.
            },
            "nameAndKind": { # Basic metadata about a counter. # Counter name and aggregation type.
              "kind": "A String", # Counter aggregation kind.
              "name": "A String", # Name of the counter.
            },
            "stringList": { # A metric value representing a list of strings. # List of strings, for Set.
              "elements": [ # Elements of the list.
                "A String",
              ],
            },
          },
        ],
        "progress": { # Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. # DEPRECATED in favor of reported_progress.
          "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # Obsolete.
            "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range.
            "recordIndex": "A String", # Position is a record index.
            "byteOffset": "A String", # Position is a byte offset.
            "key": "A String", # Position is a string key, ordered lexicographically.
            "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position.
              "index": 42, # Index of the inner source.
              "position": # Object with schema name: Position # Position within the inner source.
            },
            "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
          },
          "remainingTime": "A String", # Obsolete.
          "percentComplete": 3.14, # Obsolete.
        },
        "metricUpdates": [ # DEPRECATED in favor of counter_updates.
          { # Describes the state of a metric.
            "meanCount": "", # Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
            "kind": "A String", # Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", and "Or". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
            "set": "", # Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
            "name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric.
              "origin": "A String", # Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.
              "name": "A String", # Worker-defined metric name.
              "context": { # Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] =
                  # .
                "a_key": "A String",
              },
            },
            "cumulative": True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
            "updateTime": "A String", # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
            "scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
            "meanSum": "", # Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
            "internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.
          },
        ],
        "reportedProgress": { # A progress measurement of a WorkItem by a worker. # The worker's progress through this WorkItem.
          "fractionConsumed": 3.14, # Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed).
          "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A Position within the work to represent a progress.
            "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range.
            "recordIndex": "A String", # Position is a record index.
            "byteOffset": "A String", # Position is a byte offset.
            "key": "A String", # Position is a string key, ordered lexicographically.
            "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position.
              "index": 42, # Index of the inner source.
              "position": # Object with schema name: Position # Position within the inner source.
            },
            "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
          },
          "remainingParallelism": { # Represents the level of parallelism in a WorkItem's input, reported by the worker. # Total amount of parallelism in the input of this task that remains, (i.e. can be delegated to this task and any new tasks via dynamic splitting). Always at least 1 for non-finished work items and 0 for finished. "Amount of parallelism" refers to how many non-empty parts of the input can be read in parallel. This does not necessarily equal number of records. An input that can be read in parallel down to the individual records is called "perfectly splittable". An example of non-perfectly parallelizable input is a block-compressed file format where a block of records has to be read as a whole, but different blocks can be read in parallel. Examples: * If we are processing record #30 (starting at 1) out of 50 in a perfectly splittable 50-record input, this value should be 21 (20 remaining + 1 current). * If we are reading through block 3 in a block-compressed file consisting of 5 blocks, this value should be 3 (since blocks 4 and 5 can be processed in parallel by new tasks via dynamic splitting and the current task remains processing block 3). * If we are reading through the last block in a block-compressed file, or reading or processing the last record in a perfectly splittable input, this value should be 1, because apart from the current task, no additional remainder can be split off.
            "isInfinite": True or False, # Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack.
            "value": 3.14, # Specifies the level of parallelism in case it is finite.
          },
          "consumedParallelism": { # Represents the level of parallelism in a WorkItem's input, reported by the worker. # Total amount of parallelism in the portion of input of this task that has already been consumed and is no longer active. In the first two examples above (see remaining_parallelism), the value should be 29 or 2 respectively. The sum of remaining_parallelism and consumed_parallelism should equal the total amount of parallelism in this work item. If specified, must be finite.
            "isInfinite": True or False, # Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack.
            "value": 3.14, # Specifies the level of parallelism in case it is finite.
          },
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response from a request to report the status of WorkItems.
    "workItemServiceStates": [ # A set of messages indicating the service-side state for each WorkItem whose status was reported, in the same order as the WorkItemStatus messages in the ReportWorkItemStatusRequest which resulting in this response.
      { # The Dataflow service's idea of the current state of a WorkItem being processed by a worker.
        "reportStatusInterval": "A String", # New recommended reporting interval.
        "suggestedStopPosition": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # Obsolete, always empty.
          "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range.
          "recordIndex": "A String", # Position is a record index.
          "byteOffset": "A String", # Position is a byte offset.
          "key": "A String", # Position is a string key, ordered lexicographically.
          "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position.
            "index": 42, # Index of the inner source.
            "position": # Object with schema name: Position # Position within the inner source.
          },
          "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
        },
        "harnessData": { # Other data returned by the service, specific to the particular worker harness.
          "a_key": "", # Properties of the object.
        },
        "nextReportIndex": "A String", # The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts.
        "leaseExpireTime": "A String", # Time at which the current lease will expire.
        "metricShortId": [ # The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics.
          { # The metric short id is returned to the user alongside an offset into ReportWorkItemStatusRequest
            "shortId": "A String", # The service-generated short identifier for the metric.
            "metricIndex": 42, # The index of the corresponding metric in the ReportWorkItemStatusRequest. Required.
          },
        ],
        "splitRequest": { # A suggestion by the service to the worker to dynamically split the WorkItem. # The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.
          "fractionConsumed": 3.14, # A fraction at which to split the work item, from 0.0 (beginning of the input) to 1.0 (end of the input).
          "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A Position at which to split the work item.
            "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range.
            "recordIndex": "A String", # Position is a record index.
            "byteOffset": "A String", # Position is a byte offset.
            "key": "A String", # Position is a string key, ordered lexicographically.
            "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position.
              "index": 42, # Index of the inner source.
              "position": # Object with schema name: Position # Position within the inner source.
            },
            "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
          },
        },
        "suggestedStopPoint": { # Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. # DEPRECATED in favor of split_request.
          "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # Obsolete.
            "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range.
            "recordIndex": "A String", # Position is a record index.
            "byteOffset": "A String", # Position is a byte offset.
            "key": "A String", # Position is a string key, ordered lexicographically.
            "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position.
              "index": 42, # Index of the inner source.
              "position": # Object with schema name: Position # Position within the inner source.
            },
            "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
          },
          "remainingTime": "A String", # Obsolete.
          "percentComplete": 3.14, # Obsolete.
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dataflow_v1b3.projects.templates.html000066400000000000000000000466371300622755700272600ustar00rootroot00000000000000

Google Dataflow API . projects . templates

Instance Methods

create(projectId, body, x__xgafv=None)

Creates a dataflow job from a template.

Method Details

create(projectId, body, x__xgafv=None) 
Creates a dataflow job from a template.

Args:
  projectId: string, The project which owns the job. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to create a Dataflow job.
    "gcsPath": "A String", # A path to the serialized JSON representation of the job.
    "parameters": { # Dynamic parameterization of the job's runtime environment.
      "a_key": "A String",
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines a job to be run by the Dataflow service.
      "clientRequestId": "A String", # Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
      "requestedState": "A String", # The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
      "name": "A String", # The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
      "replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
      "projectId": "A String", # The project which owns the job.
      "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
        "a_key": "A String",
      },
      "transformNameMapping": { # Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
        "a_key": "A String",
      },
      "createTime": "A String", # Timestamp when job was initially created. Immutable, set by the Dataflow service.
      "environment": { # Describes the environment in which a Dataflow Job runs. # Environment for the job.
        "version": { # A structure describing which components and their versions of the service are required in order to run the job.
          "a_key": "", # Properties of the object.
        },
        "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "internalExperiments": { # Experimental settings.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
        "experiments": [ # The list of experiments to enable.
          "A String",
        ],
        "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.
        "sdkPipelineOptions": { # The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
          "a_key": "", # Properties of the object.
        },
        "userAgent": { # A description of the process that generated the request.
          "a_key": "", # Properties of the object.
        },
        "clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
        "workerPools": [ # Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
          { # Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
            "diskSourceImage": "A String", # Fully qualified source image for disks.
            "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
              "workflowFileName": "A String", # Store the workflow in this file.
              "logUploadLocation": "A String", # Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "commandlinesFileName": "A String", # Store preprocessing commands in this file.
              "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # Settings to pass to the parallel worker harness.
                "reportingEnabled": True or False, # Send work progress updates to service.
                "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
                "workerId": "A String", # ID of the worker running this pipeline.
                "baseUrl": "A String", # The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
                "servicePath": "A String", # The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
                "tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              },
              "vmId": "A String", # ID string of VM.
              "baseTaskDir": "A String", # Location on the worker for task-specific subdirectories.
              "continueOnException": True or False, # Do we continue taskrunner if an exception is hit?
              "baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
              "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
              "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
              "oauthScopes": [ # OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
                "A String",
              ],
              "languageHint": "A String", # Suggested backend language.
              "logToSerialconsole": True or False, # Send taskrunner log into to Google Compute Engine VM serial console?
              "streamingWorkerMainClass": "A String", # Streaming worker main class name.
              "logDir": "A String", # Directory on the VM to store logs.
              "dataflowApiVersion": "A String", # API version of endpoint, e.g. "v1b3"
              "harnessCommand": "A String", # Command to launch the worker harness.
              "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
              "alsologtostderr": True or False, # Also send taskrunner log info to stderr?
            },
            "kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
            "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
            "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
            "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
            "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
            "ipConfiguration": "A String", # Configuration for VM IPs.
            "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.
            "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
            "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
            "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
            "metadata": { # Metadata to set on the Google Compute Engine VMs.
              "a_key": "A String",
            },
            "poolArgs": { # Extra arguments for this worker pool.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
            "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
            "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
            "packages": [ # Packages to be installed on workers.
              { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
                "name": "A String", # The name of the package.
                "location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
              },
            ],
            "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
              "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
              "algorithm": "A String", # The algorithm to use for autoscaling.
            },
            "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
            "dataDisks": [ # Data disks that are used by a VM in this workflow.
              { # Describes the data disk used by a workflow job.
                "mountPoint": "A String", # Directory in a VM where disk is mounted.
                "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
                "diskType": "A String", # Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/
                    # /zones//diskTypes/pd-standard
              },
            ],
          },
        ],
      },
      "replaceJobId": "A String", # If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
      "steps": [ # The top-level steps that constitute the entire job.
        { # Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
          "kind": "A String", # The kind of step in the dataflow Job.
          "name": "A String", # Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
          "properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties.
            "a_key": "", # Properties of the object.
          },
        },
      ],
      "currentStateTime": "A String", # The timestamp associated with the current state.
      "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
        "A String",
      ],
      "type": "A String", # The type of dataflow job.
      "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
      "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
      "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job.
        "stages": { # A mapping from each stage to the information about that stage.
          "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
            "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
              "A String",
            ],
          },
        },
      },
    }
google-api-python-client-1.5.5/docs/dyn/dataproc_v1.html000066400000000000000000000041321300622755700231620ustar00rootroot00000000000000

Google Cloud Dataproc API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dataproc_v1.projects.html000066400000000000000000000023441300622755700250150ustar00rootroot00000000000000

Google Cloud Dataproc API . projects

Instance Methods

regions()

Returns the regions Resource.

google-api-python-client-1.5.5/docs/dyn/dataproc_v1.projects.regions.clusters.html000066400000000000000000002233231300622755700303270ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions . clusters

Instance Methods

create(projectId, region, body, x__xgafv=None)

Creates a cluster in a project.

delete(projectId, region, clusterName, x__xgafv=None)

Deletes a cluster in a project.

diagnose(projectId, region, clusterName, body, x__xgafv=None)

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

get(projectId, region, clusterName, x__xgafv=None)

Gets the resource representation for a cluster in a project.

list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None)

Lists all regions/{region}/clusters in a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)

Updates a cluster in a project.

Method Details

create(projectId, region, body, x__xgafv=None) 
Creates a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
  "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
    "state": "A String", # The cluster's state.
    "stateStartTime": "A String", # Time when this state was entered.
    "detail": "A String", # Optional details of cluster's state.
  },
  "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
  "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
  "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
  "statusHistory": [ # [Output-only] The previous cluster status.
    { # The status of a cluster and its instances.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
  ],
  "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
    "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
      "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
      "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
        "a_key": "A String",
      },
    },
    "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
    "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
      "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
      "tags": [ # The Google Compute Engine tags to add to all instances.
        "A String",
      ],
      "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
      "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
      "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
        "A String",
      ],
      "metadata": { # The Google Compute Engine metadata entries to add to all instances.
        "a_key": "A String",
      },
    },
    "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
        "A String",
      ],
      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
    },
    "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
        "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
        "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
      },
    ],
    "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
        "A String",
      ],
      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
    },
    "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
        "A String",
      ],
      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
    },
  },
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
delete(projectId, region, clusterName, x__xgafv=None) 
Deletes a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
diagnose(projectId, region, clusterName, body, x__xgafv=None) 
Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to collect cluster diagnostic information.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
get(projectId, region, clusterName, x__xgafv=None) 
Gets the resource representation for a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
    "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
    "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
    "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
    "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
    "statusHistory": [ # [Output-only] The previous cluster status.
      { # The status of a cluster and its instances.
        "state": "A String", # The cluster's state.
        "stateStartTime": "A String", # Time when this state was entered.
        "detail": "A String", # Optional details of cluster's state.
      },
    ],
    "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
      "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
        "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
        "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
          "a_key": "A String",
        },
      },
      "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
      "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
        "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
        "tags": [ # The Google Compute Engine tags to add to all instances.
          "A String",
        ],
        "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
        "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
        "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
          "A String",
        ],
        "metadata": { # The Google Compute Engine metadata entries to add to all instances.
          "a_key": "A String",
        },
      },
      "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
        "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
          "A String",
        ],
        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
        },
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
      },
      "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
        { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
          "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
          "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
        },
      ],
      "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
        "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
          "A String",
        ],
        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
        },
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
      },
      "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
        "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
          "A String",
        ],
        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
        },
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
      },
    },
  }
list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all regions/{region}/clusters in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  pageSize: integer, The standard List page size.
  pageToken: string, The standard List page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The list of all clusters in a project.
    "nextPageToken": "A String", # [Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListClustersRequest.
    "clusters": [ # [Output-only] The clusters in the project.
      { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
        "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
          "state": "A String", # The cluster's state.
          "stateStartTime": "A String", # Time when this state was entered.
          "detail": "A String", # Optional details of cluster's state.
        },
        "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
        "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
        "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
        "statusHistory": [ # [Output-only] The previous cluster status.
          { # The status of a cluster and its instances.
            "state": "A String", # The cluster's state.
            "stateStartTime": "A String", # Time when this state was entered.
            "detail": "A String", # Optional details of cluster's state.
          },
        ],
        "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
          "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
            "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
            "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
              "a_key": "A String",
            },
          },
          "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
          "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
            "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
            "tags": [ # The Google Compute Engine tags to add to all instances.
              "A String",
            ],
            "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
            "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
            "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
              "A String",
            ],
            "metadata": { # The Google Compute Engine metadata entries to add to all instances.
              "a_key": "A String",
            },
          },
          "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
            "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
              "A String",
            ],
            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
            },
            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
          },
          "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
            { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
              "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
              "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
            },
          ],
          "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
            "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
              "A String",
            ],
            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
            },
            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
          },
          "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
            "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
              "A String",
            ],
            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
            },
            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
          },
        },
      },
    ],
  }
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, region, clusterName, body, updateMask=None, x__xgafv=None) 
Updates a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
  "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
    "state": "A String", # The cluster's state.
    "stateStartTime": "A String", # Time when this state was entered.
    "detail": "A String", # Optional details of cluster's state.
  },
  "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
  "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
  "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
  "statusHistory": [ # [Output-only] The previous cluster status.
    { # The status of a cluster and its instances.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
  ],
  "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
    "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
      "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
      "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
        "a_key": "A String",
      },
    },
    "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
    "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
      "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
      "tags": [ # The Google Compute Engine tags to add to all instances.
        "A String",
      ],
      "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
      "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
      "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
        "A String",
      ],
      "metadata": { # The Google Compute Engine metadata entries to add to all instances.
        "a_key": "A String",
      },
    },
    "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
        "A String",
      ],
      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
    },
    "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
        "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
        "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
      },
    ],
    "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
        "A String",
      ],
      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
    },
    "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
        "A String",
      ],
      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
    },
  },
}

  updateMask: string, [Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the `PATCH` request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the `PATCH` request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, config.worker_config.num_instances and config.secondary_worker_config.num_instances are the only fields that can be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/dataproc_v1.projects.regions.html000066400000000000000000000031651300622755700264640ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions

Instance Methods

clusters()

Returns the clusters Resource.

jobs()

Returns the jobs Resource.

operations()

Returns the operations Resource.

google-api-python-client-1.5.5/docs/dyn/dataproc_v1.projects.regions.jobs.html000066400000000000000000002243441300622755700274240ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions . jobs

Instance Methods

cancel(projectId, region, jobId, body, x__xgafv=None)

Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/reference/rest/v1/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/reference/rest/v1/projects.regions.jobs/get).

delete(projectId, region, jobId, x__xgafv=None)

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

get(projectId, region, jobId, x__xgafv=None)

Gets the resource representation for a job in a project.

list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None)

Lists regions/{region}/jobs in a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

submit(projectId, region, body, x__xgafv=None)

Submits a job to a cluster.

Method Details

cancel(projectId, region, jobId, body, x__xgafv=None) 
Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/reference/rest/v1/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/reference/rest/v1/projects.regions.jobs/get).

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  jobId: string, [Required] The job ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to cancel a job.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
    ],
    "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
        "a_key": "A String",
      },
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
        "a_key": "A String",
      },
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
  }
delete(projectId, region, jobId, x__xgafv=None) 
Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  jobId: string, [Required] The job ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(projectId, region, jobId, x__xgafv=None) 
Gets the resource representation for a job in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  jobId: string, [Required] The job ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
    ],
    "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
        "a_key": "A String",
      },
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
        "a_key": "A String",
      },
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
  }
list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None) 
Lists regions/{region}/jobs in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  pageSize: integer, [Optional] The number of results to return in each response.
  x__xgafv: string, V1 error format.
  jobStateMatcher: string, [Optional] Specifies enumerated categories of jobs to list.
  pageToken: string, [Optional] The page token, returned by a previous call, to request the next page of results.
  clusterName: string, [Optional] If set, the returned jobs list includes only jobs that were submitted to the named cluster.

Returns:
  An object of the form:

    { # A list of jobs in a project.
    "nextPageToken": "A String", # [Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListJobsRequest.
    "jobs": [ # [Output-only] Jobs list.
      { # A Cloud Dataproc job resource.
        "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
          "state": "A String", # [Required] A state message specifying the overall job state.
          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        },
        "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
          "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
            "A String",
          ],
          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
            "A String",
          ],
          "fileUris": [ # [Optional] HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
            "A String",
          ],
          "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
            "A String",
          ],
          "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
          "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
            "a_key": "A String",
          },
        },
        "statusHistory": [ # [Output-only] The previous job status.
          { # Cloud Dataproc job status.
            "state": "A String", # [Required] A state message specifying the overall job state.
            "stateStartTime": "A String", # [Output-only] The time when this state was entered.
            "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
          },
        ],
        "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
          "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
          "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
        },
        "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
          "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
          "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
        },
        "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
          "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
            "a_key": "A String",
          },
          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
            "A String",
          ],
          "queryList": { # A list of queries to run on a cluster. # A list of queries.
            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
              "A String",
            ],
          },
          "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
            "a_key": "A String",
          },
        },
        "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
          "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
            "a_key": "A String",
          },
          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
            "A String",
          ],
          "queryList": { # A list of queries to run on a cluster. # A list of queries.
            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
              "A String",
            ],
          },
          "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
          "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
            "a_key": "A String",
          },
        },
        "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
        "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
        "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
            "A String",
          ],
          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
            "A String",
          ],
          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
            "A String",
          ],
          "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
            "A String",
          ],
          "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
          "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
            "a_key": "A String",
          },
        },
        "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
          "mainPythonFileUri": "A String", # [Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file.
          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
            "A String",
          ],
          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
            "A String",
          ],
          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
            "A String",
          ],
          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
            "A String",
          ],
          "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
            "A String",
          ],
          "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
            "a_key": "A String",
          },
        },
        "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
          "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
            "a_key": "A String",
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
            "A String",
          ],
          "queryList": { # A list of queries to run on a cluster. # A list of queries.
            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
              "A String",
            ],
          },
          "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
          "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
            "a_key": "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.
submit(projectId, region, body, x__xgafv=None) 
Submits a job to a cluster.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to submit a job.
    "job": { # A Cloud Dataproc job resource. # [Required] The job resource.
      "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
      "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
        "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
          "A String",
        ],
        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "fileUris": [ # [Optional] HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
          "A String",
        ],
        "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
        "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
          "a_key": "A String",
        },
      },
      "statusHistory": [ # [Output-only] The previous job status.
        { # Cloud Dataproc job status.
          "state": "A String", # [Required] A state message specifying the overall job state.
          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        },
      ],
      "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
        "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
        "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
      },
      "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
        "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
        "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
      },
      "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
          "a_key": "A String",
        },
        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
          "a_key": "A String",
        },
      },
      "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
          "a_key": "A String",
        },
        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
        "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
          "a_key": "A String",
        },
      },
      "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
      "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
      "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
          "A String",
        ],
        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
          "A String",
        ],
        "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
        "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
          "a_key": "A String",
        },
      },
      "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
        "mainPythonFileUri": "A String", # [Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file.
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
          "A String",
        ],
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
          "A String",
        ],
        "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
          "A String",
        ],
        "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
          "a_key": "A String",
        },
      },
      "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
        "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
          "a_key": "A String",
        },
      },
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
    ],
    "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
        "a_key": "A String",
      },
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
        "a_key": "A String",
      },
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/dataproc_v1.projects.regions.operations.html000066400000000000000000000370371300622755700306530ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions . operations

Instance Methods

cancel(name, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.

delete(name, x__xgafv=None)

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @ype with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/dataproc_v1alpha1.html000066400000000000000000000044121300622755700242520ustar00rootroot00000000000000

Google Cloud Dataproc API

Instance Methods

operations()

Returns the operations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dataproc_v1alpha1.operations.html000066400000000000000000000361331300622755700264410ustar00rootroot00000000000000

Google Cloud Dataproc API . operations

Instance Methods

cancel(name, body, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients may use [Operations.GetOperation] or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.

delete(name, x__xgafv=None)

Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, body, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients may use [Operations.GetOperation] or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for Operations.CancelOperation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The operation resource name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
    "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
    "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
    "metadata": { # Service-specific metadata associated with the operation.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

Args:
  name: string, The operation collection name. (required)
  pageSize: integer, The standard List page size.
  filter: string, [Required] A JSON object that contains filters for the list operation, in the format {"key1":"value1","key2":"value2", ..., }. Possible keys include project_id, cluster_name, and operation_state_matcher. If project_id is set, requests the list of operations that belong to the specified Google Cloud Platform project ID. This key is required. If cluster_name is set, requests the list of operations that were submitted to the specified cluster name. This key is optional. If operation_state_matcher is set, requests the list of operations that match one of the following status options: ALL, ACTIVE, or NON_ACTIVE.
  pageToken: string, The standard List page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that match the specified filter in the request.
      { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
        "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @ype with type URL.
            },
          ],
        },
        "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
        "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
        "metadata": { # Service-specific metadata associated with the operation.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/dataproc_v1alpha1.projects.html000066400000000000000000000023661300622755700261100ustar00rootroot00000000000000

Google Cloud Dataproc API . projects

Instance Methods

regions()

Returns the regions Resource.

google-api-python-client-1.5.5/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html000066400000000000000000002431561300622755700314240ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions . clusters

Instance Methods

create(projectId, region, body, x__xgafv=None)

Request to create a cluster in a project.

delete(projectId, region, clusterName, x__xgafv=None)

Request to delete a cluster in a project.

get(projectId, region, clusterName, x__xgafv=None)

Request to get the resource representation for a cluster in a project.

list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None)

Request a list of all regions/{region}/clusters in a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)

Request to update a cluster in a project.

Method Details

create(projectId, region, body, x__xgafv=None) 
Request to create a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
    "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
    "statusHistory": [ # [Output-only] Previous cluster statuses.
      { # The status of a cluster and its instances.
        "state": "A String", # The cluster's state.
        "stateStartTime": "A String", # Time when this state was entered.
        "detail": "A String", # Optional details of cluster's state.
      },
    ],
    "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
    "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
    "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
    "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
      "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
        "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
        "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
          "a_key": "A String",
        },
      },
      "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
        "A String",
      ],
      "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
        },
      },
      "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
        "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
        "tags": [ # The Google Compute Engine tags to add to all instances.
          "A String",
        ],
        "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
        "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
        "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
          "A String",
        ],
        "metadata": { # The Google Compute Engine metadata entries to add to all instances.
          "a_key": "A String",
        },
      },
      "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
      "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
      "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
        "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
        "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
        "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
          "A String",
        ],
        "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
      },
      "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
        },
      },
      "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
      "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
        { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
          "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
          "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
        },
      ],
      "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
        },
      },
    },
    "createTime": "A String", # [Output-only] The timestamp of cluster creation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
    "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
    "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
    "metadata": { # Service-specific metadata associated with the operation.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
delete(projectId, region, clusterName, x__xgafv=None) 
Request to delete a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
    "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
    "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
    "metadata": { # Service-specific metadata associated with the operation.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
get(projectId, region, clusterName, x__xgafv=None) 
Request to get the resource representation for a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
      "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
        "state": "A String", # The cluster's state.
        "stateStartTime": "A String", # Time when this state was entered.
        "detail": "A String", # Optional details of cluster's state.
      },
      "statusHistory": [ # [Output-only] Previous cluster statuses.
        { # The status of a cluster and its instances.
          "state": "A String", # The cluster's state.
          "stateStartTime": "A String", # Time when this state was entered.
          "detail": "A String", # Optional details of cluster's state.
        },
      ],
      "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
      "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
      "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
      "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
        "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
          "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
          "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
            "a_key": "A String",
          },
        },
        "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
          "A String",
        ],
        "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
          "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
          "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
          "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
            "A String",
          ],
          "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
          "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
          "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
            "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
            "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
          },
          "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
            "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
            "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
          },
        },
        "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
          "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
          "tags": [ # The Google Compute Engine tags to add to all instances.
            "A String",
          ],
          "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
          "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
          "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
            "A String",
          ],
          "metadata": { # The Google Compute Engine metadata entries to add to all instances.
            "a_key": "A String",
          },
        },
        "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
        "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
        "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
          "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
          "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
          "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
          "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
            "A String",
          ],
          "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        },
        "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
          "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
          "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
          "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
            "A String",
          ],
          "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
          "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
          "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
            "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
            "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
          },
          "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
            "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
            "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
          },
        },
        "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
        "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
          { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
            "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
            "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
          },
        ],
        "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
          "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
          "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
          "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
            "A String",
          ],
          "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
          "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
          "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
            "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
            "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
          },
          "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
            "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
            "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
          },
        },
      },
      "createTime": "A String", # [Output-only] The timestamp of cluster creation.
    }
list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None) 
Request a list of all regions/{region}/clusters in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  pageSize: integer, The standard List page size.
  pageToken: string, The standard List page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The list of all clusters in a project.
    "nextPageToken": "A String", # The standard List next-page token.
    "clusters": [ # [Output-only] The clusters in the project.
      { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
          "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
            "state": "A String", # The cluster's state.
            "stateStartTime": "A String", # Time when this state was entered.
            "detail": "A String", # Optional details of cluster's state.
          },
          "statusHistory": [ # [Output-only] Previous cluster statuses.
            { # The status of a cluster and its instances.
              "state": "A String", # The cluster's state.
              "stateStartTime": "A String", # Time when this state was entered.
              "detail": "A String", # Optional details of cluster's state.
            },
          ],
          "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
          "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
          "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
          "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
            "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
              "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
              "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
                "a_key": "A String",
              },
            },
            "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
              "A String",
            ],
            "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
              "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
              "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
              "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
                "A String",
              ],
              "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
              "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
              "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
                "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
                "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
              },
              "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
                "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
                "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
              },
            },
            "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
              "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
              "tags": [ # The Google Compute Engine tags to add to all instances.
                "A String",
              ],
              "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
              "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
              "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
                "A String",
              ],
              "metadata": { # The Google Compute Engine metadata entries to add to all instances.
                "a_key": "A String",
              },
            },
            "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
            "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
            "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
              "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
              "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
              "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
              "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
                "A String",
              ],
              "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
            },
            "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
              "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
              "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
              "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
                "A String",
              ],
              "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
              "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
              "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
                "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
                "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
              },
              "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
                "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
                "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
              },
            },
            "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
            "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
              { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
                "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
                "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
              },
            ],
            "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
              "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
              "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
              "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
                "A String",
              ],
              "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
              "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
              "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
                "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
                "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
              },
              "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
                "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
                "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
              },
            },
          },
          "createTime": "A String", # [Output-only] The timestamp of cluster creation.
        },
    ],
  }
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, region, clusterName, body, updateMask=None, x__xgafv=None) 
Request to update a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  clusterName: string, [Required] The cluster name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
    "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
    "statusHistory": [ # [Output-only] Previous cluster statuses.
      { # The status of a cluster and its instances.
        "state": "A String", # The cluster's state.
        "stateStartTime": "A String", # Time when this state was entered.
        "detail": "A String", # Optional details of cluster's state.
      },
    ],
    "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
    "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
    "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
    "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
      "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
        "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
        "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
          "a_key": "A String",
        },
      },
      "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
        "A String",
      ],
      "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
        },
      },
      "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
        "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
        "tags": [ # The Google Compute Engine tags to add to all instances.
          "A String",
        ],
        "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
        "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
        "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
          "A String",
        ],
        "metadata": { # The Google Compute Engine metadata entries to add to all instances.
          "a_key": "A String",
        },
      },
      "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
      "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
      "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
        "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
        "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
        "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
          "A String",
        ],
        "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
      },
      "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
        },
      },
      "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
      "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
        { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
          "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
          "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
        },
      ],
      "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
        "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
        },
      },
    },
    "createTime": "A String", # [Output-only] The timestamp of cluster creation.
  }

  updateMask: string, [Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as "configuration.worker_configuration.num_instances," and the PATCH request body would specify the new value, as follows: { "configuration":{ "workerConfiguration":{ "numInstances":"5" } } } Note: Currently, configuration.worker_configuration.num_instances is the only field that can be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
    "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
    "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
    "metadata": { # Service-specific metadata associated with the operation.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/dataproc_v1alpha1.projects.regions.html000066400000000000000000000027441300622755700275550ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions

Instance Methods

clusters()

Returns the clusters Resource.

jobs()

Returns the jobs Resource.

google-api-python-client-1.5.5/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html000066400000000000000000002415501300622755700305110ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . regions . jobs

Instance Methods

cancel(projectId, region, jobId, body, x__xgafv=None)

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.

delete(projectId, region, jobId, x__xgafv=None)

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

get(projectId, region, jobId, x__xgafv=None)

Gets the resource representation for a job in a project.

submit(projectId, region, body, x__xgafv=None)

Submits a job to a cluster.

Method Details

cancel(projectId, region, jobId, body, x__xgafv=None) 
Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  jobId: string, [Required] The job ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to cancel a job.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "insertTime": "A String", # The time of the job request.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      "startTime": "A String", # The time when the server started the job.
      "endTime": "A String", # The time when the job completed.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "insertTime": "A String", # The time of the job request.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        "startTime": "A String", # The time when the server started the job.
        "endTime": "A String", # The time when the job completed.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
  }
delete(projectId, region, jobId, x__xgafv=None) 
Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  jobId: string, [Required] The job ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "insertTime": "A String", # The time of the job request.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      "startTime": "A String", # The time when the server started the job.
      "endTime": "A String", # The time when the job completed.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "insertTime": "A String", # The time of the job request.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        "startTime": "A String", # The time when the server started the job.
        "endTime": "A String", # The time when the job completed.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
  }
get(projectId, region, jobId, x__xgafv=None) 
Gets the resource representation for a job in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  jobId: string, [Required] The job ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "insertTime": "A String", # The time of the job request.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      "startTime": "A String", # The time when the server started the job.
      "endTime": "A String", # The time when the job completed.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "insertTime": "A String", # The time of the job request.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        "startTime": "A String", # The time when the server started the job.
        "endTime": "A String", # The time when the job completed.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
  }
submit(projectId, region, body, x__xgafv=None) 
Submits a job to a cluster.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  region: string, [Required] The Dataproc region in which to handle the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A job submission request.
    "job": { # A Cloud Dataproc job resource. # [Required] The job resource.
      "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "insertTime": "A String", # The time of the job request.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        "startTime": "A String", # The time when the server started the job.
        "endTime": "A String", # The time when the job completed.
      },
      "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
        "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
          "A String",
        ],
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
            "a_key": "A String",
          },
        },
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
          "A String",
        ],
        "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
        "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
          "a_key": "A String",
        },
      },
      "statusHistory": [ # [Output-only] The previous job status.
        { # Cloud Dataproc job status.
          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
          "insertTime": "A String", # The time of the job request.
          "state": "A String", # [Required] A state message specifying the overall job state.
          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
          "startTime": "A String", # The time when the server started the job.
          "endTime": "A String", # The time when the job completed.
        },
      ],
      "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
        "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
        "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
      },
      "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
        "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
        "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
      },
      "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
            "a_key": "A String",
          },
        },
        "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
          "a_key": "A String",
        },
      },
      "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
      "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
            "a_key": "A String",
          },
        },
        "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
          "a_key": "A String",
        },
      },
      "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
      "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
      "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
      "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
      "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
          "A String",
        ],
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
            "a_key": "A String",
          },
        },
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
          "A String",
        ],
        "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
        "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
          "a_key": "A String",
        },
      },
      "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
        { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
          "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
          "state": "A String", # [Required] The application state.
          "name": "A String", # [Required] The application name.
          "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
        },
      ],
      "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
        "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
          "A String",
        ],
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
            "a_key": "A String",
          },
        },
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
          "A String",
        ],
        "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
          "A String",
        ],
        "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
          "a_key": "A String",
        },
      },
      "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
        "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
          "a_key": "A String",
        },
      },
      "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "insertTime": "A String", # The time of the job request.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      "startTime": "A String", # The time when the server started the job.
      "endTime": "A String", # The time when the job completed.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "insertTime": "A String", # The time of the job request.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        "startTime": "A String", # The time when the server started the job.
        "endTime": "A String", # The time when the job completed.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
  }
google-api-python-client-1.5.5/docs/dyn/dataproc_v1beta1.html000066400000000000000000000044071300622755700241040ustar00rootroot00000000000000

Google Cloud Dataproc API

Instance Methods

operations()

Returns the operations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dataproc_v1beta1.operations.html000066400000000000000000000372301300622755700262660ustar00rootroot00000000000000

Google Cloud Dataproc API . operations

Instance Methods

cancel(name, body, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [operations.get](/dataproc/reference/rest/v1beta1/operations/get) or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.

delete(name, x__xgafv=None)

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, body, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [operations.get](/dataproc/reference/rest/v1beta1/operations/get) or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for Operations.CancelOperation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @ype with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/dataproc_v1beta1.projects.clusters.html000066400000000000000000002234761300622755700276100ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . clusters

Instance Methods

create(projectId, body, x__xgafv=None)

Creates a cluster in a project.

delete(projectId, clusterName, x__xgafv=None)

Deletes a cluster in a project.

diagnose(projectId, clusterName, body, x__xgafv=None)

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

get(projectId, clusterName, x__xgafv=None)

Gets the resource representation for a cluster in a project.

list(projectId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all clusters in a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId, clusterName, body, updateMask=None, x__xgafv=None)

Updates a cluster in a project.

Method Details

create(projectId, body, x__xgafv=None) 
Creates a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
  "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
    "state": "A String", # The cluster's state.
    "stateStartTime": "A String", # Time when this state was entered.
    "detail": "A String", # Optional details of cluster's state.
  },
  "statusHistory": [ # [Output-only] Previous cluster statuses.
    { # The status of a cluster and its instances.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
  ],
  "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
  "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
  "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
  "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
    "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
      "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
      "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
        "a_key": "A String",
      },
    },
    "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
      "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
      "tags": [ # The Google Compute Engine tags to add to all instances.
        "A String",
      ],
      "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
      "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
      "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
        "A String",
      ],
      "metadata": { # The Google Compute Engine metadata entries to add to all instances.
        "a_key": "A String",
      },
    },
    "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
    "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
        "A String",
      ],
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
    },
    "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
        "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
        "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
      },
    ],
    "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
        "A String",
      ],
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
    },
    "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
        "A String",
      ],
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
    },
  },
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
delete(projectId, clusterName, x__xgafv=None) 
Deletes a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  clusterName: string, [Required] The cluster name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
diagnose(projectId, clusterName, body, x__xgafv=None) 
Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  clusterName: string, [Required] The cluster name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to collect cluster diagnostic information.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
get(projectId, clusterName, x__xgafv=None) 
Gets the resource representation for a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  clusterName: string, [Required] The cluster name. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
    "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
    "statusHistory": [ # [Output-only] Previous cluster statuses.
      { # The status of a cluster and its instances.
        "state": "A String", # The cluster's state.
        "stateStartTime": "A String", # Time when this state was entered.
        "detail": "A String", # Optional details of cluster's state.
      },
    ],
    "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
    "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
    "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
    "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
      "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
        "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
        "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
          "a_key": "A String",
        },
      },
      "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
        "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
        "tags": [ # The Google Compute Engine tags to add to all instances.
          "A String",
        ],
        "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
        "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
        "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
          "A String",
        ],
        "metadata": { # The Google Compute Engine metadata entries to add to all instances.
          "a_key": "A String",
        },
      },
      "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
      "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
        "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
        },
      },
      "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
        { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
          "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
          "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
        },
      ],
      "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
        "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
        },
      },
      "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
        "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
          "A String",
        ],
        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
        "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
        },
        "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
        },
      },
    },
  }
list(projectId, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all clusters in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
  pageSize: integer, The standard List page size.
  pageToken: string, The standard List page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The list of all clusters in a project.
    "nextPageToken": "A String", # The standard List next-page token.
    "clusters": [ # [Output-only] The clusters in the project.
      { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
        "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
          "state": "A String", # The cluster's state.
          "stateStartTime": "A String", # Time when this state was entered.
          "detail": "A String", # Optional details of cluster's state.
        },
        "statusHistory": [ # [Output-only] Previous cluster statuses.
          { # The status of a cluster and its instances.
            "state": "A String", # The cluster's state.
            "stateStartTime": "A String", # Time when this state was entered.
            "detail": "A String", # Optional details of cluster's state.
          },
        ],
        "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
        "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
        "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
        "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
          "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
            "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
            "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
              "a_key": "A String",
            },
          },
          "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
            "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
            "tags": [ # The Google Compute Engine tags to add to all instances.
              "A String",
            ],
            "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
            "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
            "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
              "A String",
            ],
            "metadata": { # The Google Compute Engine metadata entries to add to all instances.
              "a_key": "A String",
            },
          },
          "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
          "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
            "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
              "A String",
            ],
            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
            "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
            },
          },
          "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
            { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
              "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
              "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
            },
          ],
          "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
            "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
              "A String",
            ],
            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
            "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
            },
          },
          "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
            "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
              "A String",
            ],
            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
            "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
            },
            "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
            },
          },
        },
      },
    ],
  }
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, clusterName, body, updateMask=None, x__xgafv=None) 
Updates a cluster in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
  clusterName: string, [Required] The cluster name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
  "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
    "state": "A String", # The cluster's state.
    "stateStartTime": "A String", # Time when this state was entered.
    "detail": "A String", # Optional details of cluster's state.
  },
  "statusHistory": [ # [Output-only] Previous cluster statuses.
    { # The status of a cluster and its instances.
      "state": "A String", # The cluster's state.
      "stateStartTime": "A String", # Time when this state was entered.
      "detail": "A String", # Optional details of cluster's state.
    },
  ],
  "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
  "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
  "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
  "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
    "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
      "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
      "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
        "a_key": "A String",
      },
    },
    "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
      "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
      "tags": [ # The Google Compute Engine tags to add to all instances.
        "A String",
      ],
      "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
      "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
      "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
        "A String",
      ],
      "metadata": { # The Google Compute Engine metadata entries to add to all instances.
        "a_key": "A String",
      },
    },
    "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
    "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
        "A String",
      ],
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
    },
    "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
        "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
        "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
      },
    ],
    "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
        "A String",
      ],
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
    },
    "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
        "A String",
      ],
      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
      "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
      },
      "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
      },
    },
  },
}

  updateMask: string, [Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as configuration.worker_configuration.num_instances, and the `PATCH` request body would specify the new value, as follows: { "configuration":{ "workerConfiguration":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the `PATCH` request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, config.worker_config.num_instances and config.secondary_worker_config.num_instances are the only fields that can be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/dataproc_v1beta1.projects.html000066400000000000000000000026201300622755700257270ustar00rootroot00000000000000

Google Cloud Dataproc API . projects

Instance Methods

clusters()

Returns the clusters Resource.

jobs()

Returns the jobs Resource.

google-api-python-client-1.5.5/docs/dyn/dataproc_v1beta1.projects.jobs.html000066400000000000000000002413701300622755700266720ustar00rootroot00000000000000

Google Cloud Dataproc API . projects . jobs

Instance Methods

cancel(projectId, jobId, body, x__xgafv=None)

Starts a job cancellation request. To access the job resource after cancellation, call [jobs.list](/dataproc/reference/rest/v1beta1/projects.jobs/list) or [jobs.get](/dataproc/reference/rest/v1beta1/projects.jobs/get).

delete(projectId, jobId, x__xgafv=None)

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

get(projectId, jobId, x__xgafv=None)

Gets the resource representation for a job in a project.

list(projectId, jobStateMatcher=None, pageSize=None, clusterName=None, x__xgafv=None, pageToken=None)

Lists jobs in a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

submit(projectId, body, x__xgafv=None)

Submits a job to a cluster.

Method Details

cancel(projectId, jobId, body, x__xgafv=None) 
Starts a job cancellation request. To access the job resource after cancellation, call [jobs.list](/dataproc/reference/rest/v1beta1/projects.jobs/list) or [jobs.get](/dataproc/reference/rest/v1beta1/projects.jobs/get).

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  jobId: string, [Required] The job ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to cancel a job.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
  }
delete(projectId, jobId, x__xgafv=None) 
Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  jobId: string, [Required] The job ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(projectId, jobId, x__xgafv=None) 
Gets the resource representation for a job in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  jobId: string, [Required] The job ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
  }
list(projectId, jobStateMatcher=None, pageSize=None, clusterName=None, x__xgafv=None, pageToken=None) 
Lists jobs in a project.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  jobStateMatcher: string, [Optional] Specifies enumerated categories of jobs to list.
  pageSize: integer, [Optional] The number of results to return in each response.
  clusterName: string, [Optional] If set, the returned jobs list includes only jobs that were submitted to the named cluster.
  x__xgafv: string, V1 error format.
  pageToken: string, [Optional] The page token, returned by a previous call, to request the next page of results.

Returns:
  An object of the form:

    { # A list of jobs in a project.
    "nextPageToken": "A String", # [Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListJobsRequest.
    "jobs": [ # [Output-only] Jobs list.
      { # A Cloud Dataproc job resource.
        "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
          "state": "A String", # [Required] A state message specifying the overall job state.
          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        },
        "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
          "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
            "A String",
          ],
          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
            "A String",
          ],
          "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
            "A String",
          ],
          "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
            "A String",
          ],
          "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
          "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
            "a_key": "A String",
          },
        },
        "statusHistory": [ # [Output-only] The previous job status.
          { # Cloud Dataproc job status.
            "state": "A String", # [Required] A state message specifying the overall job state.
            "stateStartTime": "A String", # [Output-only] The time when this state was entered.
            "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
          },
        ],
        "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
          "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
          "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
        },
        "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
          "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
          "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
        },
        "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
          "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
            "a_key": "A String",
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
            "A String",
          ],
          "queryList": { # A list of queries to run on a cluster. # A list of queries.
            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
              "A String",
            ],
          },
          "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
            "a_key": "A String",
          },
        },
        "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
          "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
            "a_key": "A String",
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
            "A String",
          ],
          "queryList": { # A list of queries to run on a cluster. # A list of queries.
            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
              "A String",
            ],
          },
          "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
          "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
            "a_key": "A String",
          },
        },
        "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
        "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
        "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
        "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
        "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
            "A String",
          ],
          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
            "A String",
          ],
          "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
            "A String",
          ],
          "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
            "A String",
          ],
          "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
          "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
            "a_key": "A String",
          },
        },
        "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
          { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
            "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
            "state": "A String", # [Required] The application state.
            "name": "A String", # [Required] The application name.
            "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
          },
        ],
        "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
          "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
            "A String",
          ],
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
            "A String",
          ],
          "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
              "a_key": "A String",
            },
          },
          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
            "A String",
          ],
          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
            "A String",
          ],
          "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
            "A String",
          ],
          "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
            "a_key": "A String",
          },
        },
        "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
          "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
            "a_key": "A String",
          },
          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
            "A String",
          ],
          "queryList": { # A list of queries to run on a cluster. # A list of queries.
            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
              "A String",
            ],
          },
          "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
          "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
            "a_key": "A String",
          },
        },
        "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
      },
    ],
  }
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(projectId, body, x__xgafv=None) 
Submits a job to a cluster.

Args:
  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to submit a job.
    "job": { # A Cloud Dataproc job resource. # [Required] The job resource.
      "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
      "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
        "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
          "A String",
        ],
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
          "A String",
        ],
        "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
        "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
          "a_key": "A String",
        },
      },
      "statusHistory": [ # [Output-only] The previous job status.
        { # Cloud Dataproc job status.
          "state": "A String", # [Required] A state message specifying the overall job state.
          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
        },
      ],
      "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
        "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
        "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
      },
      "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
        "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
        "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
      },
      "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
          "a_key": "A String",
        },
      },
      "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
          "a_key": "A String",
        },
      },
      "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
      "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
      "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
      "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
      "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
          "A String",
        ],
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
          "A String",
        ],
        "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
        "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
          "a_key": "A String",
        },
      },
      "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
        { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
          "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
          "state": "A String", # [Required] The application state.
          "name": "A String", # [Required] The application name.
          "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
        },
      ],
      "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
        "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
          "A String",
        ],
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
          "A String",
        ],
        "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
            "a_key": "A String",
          },
        },
        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
          "A String",
        ],
        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
          "A String",
        ],
        "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
          "A String",
        ],
        "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
          "a_key": "A String",
        },
      },
      "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
        "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
          "a_key": "A String",
        },
        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
          "A String",
        ],
        "queryList": { # A list of queries to run on a cluster. # A list of queries.
          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
            "A String",
          ],
        },
        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
        "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
          "a_key": "A String",
        },
      },
      "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Cloud Dataproc job resource.
    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
      "state": "A String", # [Required] A state message specifying the overall job state.
      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
    },
    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
        "a_key": "A String",
      },
    },
    "statusHistory": [ # [Output-only] The previous job status.
      { # Cloud Dataproc job status.
        "state": "A String", # [Required] A state message specifying the overall job state.
        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
      },
    ],
    "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
    },
    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
    },
    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
        "a_key": "A String",
      },
    },
    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
        "a_key": "A String",
      },
    },
    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
    "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
    "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
        "A String",
      ],
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
      { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
        "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
        "state": "A String", # [Required] The application state.
        "name": "A String", # [Required] The application name.
        "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
      },
    ],
    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
        "A String",
      ],
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
        "A String",
      ],
      "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
          "a_key": "A String",
        },
      },
      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
        "A String",
      ],
      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
        "A String",
      ],
      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
        "A String",
      ],
      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
        "a_key": "A String",
      },
    },
    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
        "a_key": "A String",
      },
      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
        "A String",
      ],
      "queryList": { # A list of queries to run on a cluster. # A list of queries.
        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
          "A String",
        ],
      },
      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
        "a_key": "A String",
      },
    },
    "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
  }
google-api-python-client-1.5.5/docs/dyn/datastore_v1.html000066400000000000000000000041351300622755700233560ustar00rootroot00000000000000

Google Cloud Datastore API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/datastore_v1.projects.html000066400000000000000000005042031300622755700252070ustar00rootroot00000000000000

Google Cloud Datastore API . projects

Instance Methods

allocateIds(projectId, body, x__xgafv=None)

Allocates IDs for the given keys, which is useful for referencing an entity

beginTransaction(projectId, body, x__xgafv=None)

Begins a new transaction.

commit(projectId, body, x__xgafv=None)

Commits a transaction, optionally creating, deleting or modifying some

lookup(projectId, body, x__xgafv=None)

Looks up entities by key.

rollback(projectId, body, x__xgafv=None)

Rolls back a transaction.

runQuery(projectId, body, x__xgafv=None)

Queries for entities.

Method Details

allocateIds(projectId, body, x__xgafv=None) 
Allocates IDs for the given keys, which is useful for referencing an entity
before it is inserted.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.AllocateIds.
    "keys": [ # A list of keys with incomplete key paths for which to allocate IDs.
        # No key may be reserved/read-only.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.AllocateIds.
    "keys": [ # The keys specified in the request (in the same order), each with
        # its key path completed with a newly allocated ID.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
  }
beginTransaction(projectId, body, x__xgafv=None) 
Begins a new transaction.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.BeginTransaction.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.BeginTransaction.
    "transaction": "A String", # The transaction identifier (always present).
  }
commit(projectId, body, x__xgafv=None) 
Commits a transaction, optionally creating, deleting or modifying some
entities.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.Commit.
    "transaction": "A String", # The identifier of the transaction associated with the commit. A
        # transaction identifier is returned by a call to
        # Datastore.BeginTransaction.
    "mode": "A String", # The type of commit to perform. Defaults to `TRANSACTIONAL`.
    "mutations": [ # The mutations to perform.
        # 
        # When mode is `TRANSACTIONAL`, mutations affecting a single entity are
        # applied in order. The following sequences of mutations affecting a single
        # entity are not permitted in a single `Commit` request:
        # 
        # - `insert` followed by `insert`
        # - `update` followed by `insert`
        # - `upsert` followed by `insert`
        # - `delete` followed by `update`
        # 
        # When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
        # entity.
      { # A mutation to apply to an entity.
        "insert": { # A Datastore data object. # The entity to insert. The entity must not already exist.
            # The entity key's final path element may be incomplete.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
        "delete": { # A unique identifier for an entity. # The key of the entity to delete. The entity may or may not already exist.
            # Must have a complete key path and must not be reserved/read-only.
            # If a key's partition ID or any of its path kinds or names are
            # reserved/read-only, the key is reserved/read-only.
            # A reserved/read-only key is forbidden in certain documented contexts.
          "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 identifies 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. For example,
              # the last path element of the key of `Mutation.insert` may have no
              # identifier.
              #
              # A path can never be empty, and a path can have at most 100 elements.
            { # A (kind, ID/name) pair used to construct a key path.
                #
                # If either name or ID is set, the element is complete.
                # If neither is set, the element is incomplete.
              "kind": "A String", # The kind of the entity.
                  # A kind matching regex `__.*__` is reserved/read-only.
                  # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
              "id": "A String", # The auto-allocated ID of the entity.
                  # Never equal to zero. Values less than zero are discouraged and may not
                  # be supported in the future.
              "name": "A String", # The name of the entity.
                  # A name matching regex `__.*__` is reserved/read-only.
                  # A name must not be more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
            },
          ],
          "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
              # ID and namespace ID.
              # Queries are scoped to a single partition.
              # by project and namespace, however the namespace ID may be empty.
              #
              # A partition ID contains several dimensions:
              # project ID and namespace ID.
              #
              # Partition dimensions:
              #
              # - May be `""`.
              # - Must be valid UTF-8 bytes.
              # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
              # If the value of any dimension matches regex `__.*__`, the partition is
              # reserved/read-only.
              # A reserved/read-only partition ID is forbidden in certain documented
              # contexts.
              #
              # Foreign partition IDs (in which the project ID does
              # not match the context project ID ) are discouraged.
              # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
            "projectId": "A String", # The ID of the project to which the entities belong.
            "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
          },
        },
        "update": { # A Datastore data object. # The entity to update. The entity must already exist.
            # Must have a complete key path.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
        "baseVersion": "A String", # The version of the entity that this mutation is being applied to. If this
            # does not match the current version on the server, the mutation conflicts.
        "upsert": { # A Datastore data object. # The entity to upsert. The entity may or may not already exist.
            # The entity key's final path element may be incomplete.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.Commit.
    "mutationResults": [ # The result of performing the mutations.
        # The i-th mutation result corresponds to the i-th mutation in the request.
      { # The result of applying a mutation.
        "version": "A String", # The version of the entity on the server after processing the mutation. If
            # the mutation doesn't change anything on the server, then the version will
            # be the version of the current entity or, if no entity is present, a version
            # that is strictly greater than the version of any previous entity and less
            # than the version of any possible future entity.
        "conflictDetected": True or False, # Whether a conflict was detected for this mutation. Always false when a
            # conflict detection strategy field is not set in the mutation.
        "key": { # A unique identifier for an entity. # The automatically allocated key.
            # Set only when the mutation allocated a key.
            # If a key's partition ID or any of its path kinds or names are
            # reserved/read-only, the key is reserved/read-only.
            # A reserved/read-only key is forbidden in certain documented contexts.
          "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 identifies 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. For example,
              # the last path element of the key of `Mutation.insert` may have no
              # identifier.
              #
              # A path can never be empty, and a path can have at most 100 elements.
            { # A (kind, ID/name) pair used to construct a key path.
                #
                # If either name or ID is set, the element is complete.
                # If neither is set, the element is incomplete.
              "kind": "A String", # The kind of the entity.
                  # A kind matching regex `__.*__` is reserved/read-only.
                  # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
              "id": "A String", # The auto-allocated ID of the entity.
                  # Never equal to zero. Values less than zero are discouraged and may not
                  # be supported in the future.
              "name": "A String", # The name of the entity.
                  # A name matching regex `__.*__` is reserved/read-only.
                  # A name must not be more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
            },
          ],
          "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
              # ID and namespace ID.
              # Queries are scoped to a single partition.
              # by project and namespace, however the namespace ID may be empty.
              #
              # A partition ID contains several dimensions:
              # project ID and namespace ID.
              #
              # Partition dimensions:
              #
              # - May be `""`.
              # - Must be valid UTF-8 bytes.
              # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
              # If the value of any dimension matches regex `__.*__`, the partition is
              # reserved/read-only.
              # A reserved/read-only partition ID is forbidden in certain documented
              # contexts.
              #
              # Foreign partition IDs (in which the project ID does
              # not match the context project ID ) are discouraged.
              # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
            "projectId": "A String", # The ID of the project to which the entities belong.
            "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
          },
        },
      },
    ],
    "indexUpdates": 42, # The number of index entries updated during the commit, or zero if none were
        # updated.
  }
lookup(projectId, body, x__xgafv=None) 
Looks up entities by key.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.Lookup.
    "keys": [ # Keys of entities to look up.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
    "readOptions": { # The options shared by read requests. # The options for this lookup request.
      "transaction": "A String", # The identifier of the transaction in which to read. A
          # transaction identifier is returned by a call to
          # Datastore.BeginTransaction.
      "readConsistency": "A String", # The non-transactional read consistency to use.
          # Cannot be set to `STRONG` for global queries.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.Lookup.
    "found": [ # Entities found as `ResultType.FULL` entities. The order of results in this
        # field is undefined and has no relation to the order of the keys in the
        # input.
      { # The result of fetching an entity from Datastore.
        "cursor": "A String", # A cursor that points to the position after the result entity.
            # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
        "version": "A String", # The version of the entity, a strictly positive number that monotonically
            # increases with changes to the entity.
            #
            # This field is set for `FULL` entity
            # results.
            #
            # For missing entities in `LookupResponse`, this
            # is the version of the snapshot that was used to look up the entity, and it
            # is always set except for eventually consistent reads.
        "entity": { # A Datastore data object. # The resulting entity.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
      },
    ],
    "deferred": [ # A list of keys that were not looked up due to resource constraints. The
        # order of results in this field is undefined and has no relation to the
        # order of the keys in the input.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
    "missing": [ # Entities not found as `ResultType.KEY_ONLY` entities. The order of results
        # in this field is undefined and has no relation to the order of the keys
        # in the input.
      { # The result of fetching an entity from Datastore.
        "cursor": "A String", # A cursor that points to the position after the result entity.
            # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
        "version": "A String", # The version of the entity, a strictly positive number that monotonically
            # increases with changes to the entity.
            #
            # This field is set for `FULL` entity
            # results.
            #
            # For missing entities in `LookupResponse`, this
            # is the version of the snapshot that was used to look up the entity, and it
            # is always set except for eventually consistent reads.
        "entity": { # A Datastore data object. # The resulting entity.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
      },
    ],
  }
rollback(projectId, body, x__xgafv=None) 
Rolls back a transaction.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.Rollback.
    "transaction": "A String", # The transaction identifier, returned by a call to
        # Datastore.BeginTransaction.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.Rollback.
      # (an empty message).
  }
runQuery(projectId, body, x__xgafv=None) 
Queries for entities.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.RunQuery.
    "query": { # A query for entities. # The query to run.
      "startCursor": "A String", # A starting point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "kind": [ # The kinds to query (if empty, returns entities of all kinds).
          # Currently at most 1 kind may be specified.
        { # A representation of a kind.
          "name": "A String", # The name of the kind.
        },
      ],
      "projection": [ # The projection to return. Defaults to returning all properties.
        { # A representation of a property in a projection.
          "property": { # A reference to a property relative to the kind expressions. # The property to project.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
      "distinctOn": [ # The properties to make distinct. The query results will contain the first
          # result for each distinct combination of values for the given properties
          # (if empty, all results are returned).
        { # A reference to a property relative to the kind expressions.
          "name": "A String", # The name of the property.
              # If name includes "."s, it may be interpreted as a property name path.
        },
      ],
      "filter": { # A holder for any type of filter. # The filter to apply.
        "compositeFilter": { # A filter that merges multiple other filters using the given operator. # A composite filter.
          "filters": [ # The list of filters to combine.
              # Must contain at least one filter.
            # Object with schema name: Filter
          ],
          "op": "A String", # The operator for combining multiple filters.
        },
        "propertyFilter": { # A filter on a specific property. # A filter on a property.
          "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
          "value": { # A message that can hold any of the supported value types and associated # The value to compare the property to.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
          "op": "A String", # The operator to filter by.
        },
      },
      "limit": 42, # The maximum number of results to return. Applies after all other
          # constraints. Optional.
          # Unspecified is interpreted as no limit.
          # Must be >= 0 if specified.
      "offset": 42, # The number of results to skip. Applies before limit, but after all other
          # constraints. Optional. Must be >= 0 if specified.
      "endCursor": "A String", # An ending point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "order": [ # The order to apply to the query results (if empty, order is unspecified).
        { # The desired order for a specific property.
          "direction": "A String", # The direction to order by. Defaults to `ASCENDING`.
          "property": { # A reference to a property relative to the kind expressions. # The property to order by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
    },
    "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, identified by a partition ID.
        # Queries are scoped to a single partition.
        # This partition ID is normalized with the standard default context
        # partition ID.
        # by project and namespace, however the namespace ID may be empty.
        #
        # A partition ID contains several dimensions:
        # project ID and namespace ID.
        #
        # Partition dimensions:
        #
        # - May be `""`.
        # - Must be valid UTF-8 bytes.
        # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
        # If the value of any dimension matches regex `__.*__`, the partition is
        # reserved/read-only.
        # A reserved/read-only partition ID is forbidden in certain documented
        # contexts.
        #
        # Foreign partition IDs (in which the project ID does
        # not match the context project ID ) are discouraged.
        # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
      "projectId": "A String", # The ID of the project to which the entities belong.
      "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
    },
    "gqlQuery": { # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # The GQL query to run.
      "namedBindings": { # For each non-reserved named binding site in the query string, there must be
          # a named parameter with that name, but not necessarily the inverse.
          #
          # Key must match regex `A-Za-z_$*`, must not match regex
          # `__.*__`, and must not be `""`.
        "a_key": { # A binding parameter for a GQL query.
          "cursor": "A String", # A query cursor. Query cursors are returned in query
              # result batches.
          "value": { # A message that can hold any of the supported value types and associated # A value parameter.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
        },
      },
      "positionalBindings": [ # Numbered binding site @1 references the first numbered parameter,
          # effectively using 1-based indexing, rather than the usual 0.
          #
          # For each binding site numbered i in `query_string`, there must be an i-th
          # numbered parameter. The inverse must also be true.
        { # A binding parameter for a GQL query.
          "cursor": "A String", # A query cursor. Query cursors are returned in query
              # result batches.
          "value": { # A message that can hold any of the supported value types and associated # A value parameter.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
        },
      ],
      "queryString": "A String", # A string of the format described
          # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
      "allowLiterals": True or False, # When false, the query string must not contain any literals and instead must
          # bind all values. For example,
          # `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
          # `SELECT * FROM Kind WHERE a = @value` is.
    },
    "readOptions": { # The options shared by read requests. # The options for this query.
      "transaction": "A String", # The identifier of the transaction in which to read. A
          # transaction identifier is returned by a call to
          # Datastore.BeginTransaction.
      "readConsistency": "A String", # The non-transactional read consistency to use.
          # Cannot be set to `STRONG` for global queries.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.RunQuery.
    "query": { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set.
      "startCursor": "A String", # A starting point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "kind": [ # The kinds to query (if empty, returns entities of all kinds).
          # Currently at most 1 kind may be specified.
        { # A representation of a kind.
          "name": "A String", # The name of the kind.
        },
      ],
      "projection": [ # The projection to return. Defaults to returning all properties.
        { # A representation of a property in a projection.
          "property": { # A reference to a property relative to the kind expressions. # The property to project.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
      "distinctOn": [ # The properties to make distinct. The query results will contain the first
          # result for each distinct combination of values for the given properties
          # (if empty, all results are returned).
        { # A reference to a property relative to the kind expressions.
          "name": "A String", # The name of the property.
              # If name includes "."s, it may be interpreted as a property name path.
        },
      ],
      "filter": { # A holder for any type of filter. # The filter to apply.
        "compositeFilter": { # A filter that merges multiple other filters using the given operator. # A composite filter.
          "filters": [ # The list of filters to combine.
              # Must contain at least one filter.
            # Object with schema name: Filter
          ],
          "op": "A String", # The operator for combining multiple filters.
        },
        "propertyFilter": { # A filter on a specific property. # A filter on a property.
          "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
          "value": { # A message that can hold any of the supported value types and associated # The value to compare the property to.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
          "op": "A String", # The operator to filter by.
        },
      },
      "limit": 42, # The maximum number of results to return. Applies after all other
          # constraints. Optional.
          # Unspecified is interpreted as no limit.
          # Must be >= 0 if specified.
      "offset": 42, # The number of results to skip. Applies before limit, but after all other
          # constraints. Optional. Must be >= 0 if specified.
      "endCursor": "A String", # An ending point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "order": [ # The order to apply to the query results (if empty, order is unspecified).
        { # The desired order for a specific property.
          "direction": "A String", # The direction to order by. Defaults to `ASCENDING`.
          "property": { # A reference to a property relative to the kind expressions. # The property to order by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
    },
    "batch": { # A batch of results produced by a query. # A batch of query results (always present).
      "entityResultType": "A String", # The result type for every entity in `entity_results`.
      "snapshotVersion": "A String", # The version number of the snapshot this batch was returned from.
          # This applies to the range of results from the query's `start_cursor` (or
          # the beginning of the query if no cursor was given) to this batch's
          # `end_cursor` (not the query's `end_cursor`).
          #
          # In a single transaction, subsequent query result batches for the same query
          # can have a greater snapshot version number. Each batch's snapshot version
          # is valid for all preceding batches.
      "skippedResults": 42, # The number of results skipped, typically because of an offset.
      "entityResults": [ # The results for this batch.
        { # The result of fetching an entity from Datastore.
          "cursor": "A String", # A cursor that points to the position after the result entity.
              # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
          "version": "A String", # The version of the entity, a strictly positive number that monotonically
              # increases with changes to the entity.
              #
              # This field is set for `FULL` entity
              # results.
              #
              # For missing entities in `LookupResponse`, this
              # is the version of the snapshot that was used to look up the entity, and it
              # is always set except for eventually consistent reads.
          "entity": { # A Datastore data object. # The resulting entity.
              #
              # An entity is limited to 1 megabyte when stored. That _roughly_
              # corresponds to a limit of 1 megabyte for the serialized form of this
              # message.
            "properties": { # The entity's properties.
                # The map's keys are property names.
                # A property name matching regex `__.*__` is reserved.
                # A reserved property name is forbidden in certain documented contexts.
                # The name must not contain more than 500 characters.
                # The name cannot be `""`.
              "a_key": { # A message that can hold any of the supported value types and associated
                  # metadata.
                "booleanValue": True or False, # A boolean 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.
                "timestampValue": "A String", # A timestamp value.
                    # When stored in the Datastore, precise only to microseconds;
                    # any additional precision is rounded down.
                "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                    # explicitly.
                "doubleValue": 3.14, # A double value.
                "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
                "keyValue": { # A unique identifier for an entity. # A key value.
                    # If a key's partition ID or any of its path kinds or names are
                    # reserved/read-only, the key is reserved/read-only.
                    # A reserved/read-only key is forbidden in certain documented contexts.
                  "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 identifies 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. For example,
                      # the last path element of the key of `Mutation.insert` may have no
                      # identifier.
                      #
                      # A path can never be empty, and a path can have at most 100 elements.
                    { # A (kind, ID/name) pair used to construct a key path.
                        #
                        # If either name or ID is set, the element is complete.
                        # If neither is set, the element is incomplete.
                      "kind": "A String", # The kind of the entity.
                          # A kind matching regex `__.*__` is reserved/read-only.
                          # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                          # Cannot be `""`.
                      "id": "A String", # The auto-allocated ID of the entity.
                          # Never equal to zero. Values less than zero are discouraged and may not
                          # be supported in the future.
                      "name": "A String", # The name of the entity.
                          # A name matching regex `__.*__` is reserved/read-only.
                          # A name must not be more than 1500 bytes when UTF-8 encoded.
                          # Cannot be `""`.
                    },
                  ],
                  "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                      # ID and namespace ID.
                      # Queries are scoped to a single partition.
                      # by project and namespace, however the namespace ID may be empty.
                      #
                      # A partition ID contains several dimensions:
                      # project ID and namespace ID.
                      #
                      # Partition dimensions:
                      #
                      # - May be `""`.
                      # - Must be valid UTF-8 bytes.
                      # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                      # If the value of any dimension matches regex `__.*__`, the partition is
                      # reserved/read-only.
                      # A reserved/read-only partition ID is forbidden in certain documented
                      # contexts.
                      #
                      # Foreign partition IDs (in which the project ID does
                      # not match the context project ID ) are discouraged.
                      # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                    "projectId": "A String", # The ID of the project to which the entities belong.
                    "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                  },
                },
                "blobValue": "A String", # A blob value.
                    # May have at most 1,000,000 bytes.
                    # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                    # In JSON requests, must be base64-encoded.
                "stringValue": "A String", # A UTF-8 encoded string value.
                    # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                    # Otherwise, may be set to at least 1,000,000 bytes.
                "nullValue": "A String", # A null value.
                "arrayValue": { # An array value. # An array value.
                    # Cannot contain another array value.
                    # A `Value` instance that sets field `array_value` must not set fields
                    # `meaning` or `exclude_from_indexes`.
                  "values": [ # Values in the array.
                      # The order of this array may not be preserved if it contains a mix of
                      # indexed and unindexed values.
                    # Object with schema name: Value
                  ],
                },
                "integerValue": "A String", # An integer value.
                "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                    # of doubles representing degrees latitude and degrees longitude. Unless
                    # specified otherwise, this must conform to the
                    # WGS84
                    # standard. Values must be within normalized ranges.
                    #
                    # Example of normalization code in Python:
                    #
                    #     def NormalizeLongitude(longitude):
                    #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                    #       q, r = divmod(longitude, 360.0)
                    #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                    #         return r - 360.0
                    #       return r
                    #
                    #     def NormalizeLatLng(latitude, longitude):
                    #       """Wraps decimal degrees latitude and longitude to
                    #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                    #       r = latitude % 360.0
                    #       if r <= 90.0:
                    #         return r, NormalizeLongitude(longitude)
                    #       elif r >= 270.0:
                    #         return r - 360, NormalizeLongitude(longitude)
                    #       else:
                    #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                    #
                    #     assert 180.0 == NormalizeLongitude(180.0)
                    #     assert -180.0 == NormalizeLongitude(-180.0)
                    #     assert -179.0 == NormalizeLongitude(181.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                    #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                    #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                    #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                    #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                  "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                  "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
                },
              },
            },
            "key": { # A unique identifier for an entity. # The entity's key.
                #
                # An entity must have a key, unless otherwise documented (for example,
                # an entity in `Value.entity_value` may have no key).
                # An entity's kind is its key path's last element's kind,
                # or null if it has no key.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
          },
        },
      ],
      "skippedCursor": "A String", # A cursor that points to the position after the last skipped result.
          # Will be set when `skipped_results` != 0.
      "moreResults": "A String", # The state of the query after the current batch.
      "endCursor": "A String", # A cursor that points to the position after the last result in the batch.
    },
  }
google-api-python-client-1.5.5/docs/dyn/datastore_v1beta1.datasets.html000066400000000000000000003644041300622755700261120ustar00rootroot00000000000000

Google Cloud Datastore API . datasets

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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "namespace": "A String", # The namespace.
          "datasetId": "A String", # The dataset ID.
        },
      },
    ],
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "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", # Identifies what kind of resource this is. Value: the fixed string "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": { # A set of changes to apply. # 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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # A unique identifier for an entity.
          "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. The path can have at most 100 elements.
            { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
              "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
              "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
            },
          ],
          "partitionId": { # An identifier for a particular subset of entities. # 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.
              #
              # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
            "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "namespace": "A String", # The namespace.
              "datasetId": "A String", # The dataset ID.
            },
          },
        },
      ],
    },
  }


Returns:
  An object of the form:

    {
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "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.
        { # A unique identifier for an entity.
          "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. The path can have at most 100 elements.
            { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
              "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
              "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
            },
          ],
          "partitionId": { # An identifier for a particular subset of entities. # 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.
              #
              # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
            "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:

{
    "ignoreReadOnly": True or False,
    "transaction": "A String", # The transaction identifier, returned by a call to beginTransaction. Must be set when mode is TRANSACTIONAL.
    "mutation": { # A set of changes to apply. # The mutation to perform. Optional.
      "insert": [ # Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # A unique identifier for an entity.
          "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. The path can have at most 100 elements.
            { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
              "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
              "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
            },
          ],
          "partitionId": { # An identifier for a particular subset of entities. # 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.
              #
              # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
            "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "namespace": "A String", # The namespace.
              "datasetId": "A String", # The dataset ID.
            },
          },
        },
      ],
    },
  }


Returns:
  An object of the form:

    {
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "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.
        { # A unique identifier for an entity.
          "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. The path can have at most 100 elements.
            { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
              "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
              "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
            },
          ],
          "partitionId": { # An identifier for a particular subset of entities. # 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.
              #
              # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
            "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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "namespace": "A String", # The namespace.
          "datasetId": "A String", # The dataset ID.
        },
      },
    ],
    "missing": [ # Entities not found, with only the key populated.
      { # The result of fetching an entity from the datastore.
        "entity": { # An entity. # The resulting entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "namespace": "A String", # The namespace.
              "datasetId": "A String", # The dataset ID.
            },
          },
        },
      },
    ],
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
    },
    "found": [ # Entities found.
      { # The result of fetching an entity from the datastore.
        "entity": { # An entity. # The resulting entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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", # Identifies what kind of resource this is. Value: the fixed string "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": { # A 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).
        { # A representation of a kind.
          "name": "A String", # The name of the kind.
        },
      ],
      "projection": [ # The projection to return. If not set the entire entity is returned.
        { # A representation of a property in a projection.
          "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": { # A reference to a property relative to the kind expressions. # 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).
        { # The desired order for a specific property.
          "direction": "A String", # The direction to order by. One of ascending or descending. Optional, defaults to ascending.
          "property": { # A reference to a property relative to the kind expressions. # The property to order by.
            "name": "A String", # The name of the property.
          },
        },
      ],
      "filter": { # A holder for any type of filter. Exactly one field should be specified. # The filter to apply (optional).
        "compositeFilter": { # A filter that merges the multiple other filters using the given operation. # 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 specific property. # A filter on a property.
          "operator": "A String", # The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor.
          "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
            "name": "A String", # The name of the property.
          },
          "value": { # A message that can hold any of the supported value types and associated metadata. # 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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "namespace": "A String", # The namespace.
                "datasetId": "A String", # The dataset ID.
              },
            },
            "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
            "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
            "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).
        { # A reference to a property relative to the kind expressions.
          "name": "A String", # The name of the property.
        },
      ],
    },
    "partitionId": { # An identifier for a particular subset of entities. # 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. This partition ID is normalized with the standard default context partition ID, but all other partition IDs in RunQueryRequest are normalized with this partition ID as the context partition ID.
        #
        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
      "namespace": "A String", # The namespace.
      "datasetId": "A String", # The dataset ID.
    },
    "gqlQuery": { # A GQL query. # The GQL query to run. Either this field or field query must be set, but not both.
      "queryString": "A String", # The query 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.
        { # A binding argument for a GQL query.
          "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": { # A message that can hold any of the supported value types and associated metadata.
            "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "namespace": "A String", # The namespace.
                "datasetId": "A String", # The dataset ID.
              },
            },
            "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
            "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
            "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.
        { # A binding argument for a GQL query.
          "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": { # A message that can hold any of the supported value types and associated metadata.
            "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "namespace": "A String", # The namespace.
                "datasetId": "A String", # The dataset ID.
              },
            },
            "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
            "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
            "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", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
    },
    "batch": { # A batch of results produced by a query. # 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.
        { # The result of fetching an entity from the datastore.
          "entity": { # An entity. # The resulting entity.
            "properties": { # The entity's properties.
              "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. 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" } ] }.
                  { # A message that can hold any of the supported value types and associated metadata.
                    "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                        { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                          "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                          "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                        },
                      ],
                      "partitionId": { # An identifier for a particular subset of entities. # 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.
                          #
                          # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                        "namespace": "A String", # The namespace.
                        "datasetId": "A String", # The dataset ID.
                      },
                    },
                    "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                    "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                    "booleanValue": True or False, # A boolean value.
                    "blobKeyValue": "A String", # A blob key value.
                  },
                ],
              },
            },
            "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "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. TODO(arfuller): Once all plans produce cursors update documentation here.
      "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.
    },
  }
google-api-python-client-1.5.5/docs/dyn/datastore_v1beta1.html000066400000000000000000000041471300622755700242760ustar00rootroot00000000000000

Google Cloud Datastore API

Instance Methods

datasets()

Returns the datasets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/datastore_v1beta2.datasets.html000066400000000000000000003377701300622755700261210ustar00rootroot00000000000000

Google Cloud Datastore API . datasets

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.

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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "namespace": "A String", # The namespace.
          "datasetId": "A String", # The dataset ID.
        },
      },
    ],
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "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", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
    },
    "transaction": "A String", # The transaction identifier (always present).
  }
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:

{
    "ignoreReadOnly": True or False,
    "transaction": "A String", # The transaction identifier, returned by a call to beginTransaction. Must be set when mode is TRANSACTIONAL.
    "mode": "A String", # The type of commit to perform. Either TRANSACTIONAL or NON_TRANSACTIONAL.
    "mutation": { # A set of changes to apply. # The mutation to perform. Optional.
      "insert": [ # Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
              "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                  { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                    "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                    "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                  },
                ],
                "partitionId": { # An identifier for a particular subset of entities. # 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.
                    #
                    # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                  "namespace": "A String", # The namespace.
                  "datasetId": "A String", # The dataset ID.
                },
              },
              "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
              "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
              "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                    # Object with schema name: Value
                  ],
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
              "booleanValue": True or False, # A boolean value.
              "blobKeyValue": "A String", # A blob key value.
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
              "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                  { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                    "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                    "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                  },
                ],
                "partitionId": { # An identifier for a particular subset of entities. # 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.
                    #
                    # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                  "namespace": "A String", # The namespace.
                  "datasetId": "A String", # The dataset ID.
                },
              },
              "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
              "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
              "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                    # Object with schema name: Value
                  ],
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
              "booleanValue": True or False, # A boolean value.
              "blobKeyValue": "A String", # A blob key value.
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
              "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                  { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                    "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                    "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                  },
                ],
                "partitionId": { # An identifier for a particular subset of entities. # 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.
                    #
                    # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                  "namespace": "A String", # The namespace.
                  "datasetId": "A String", # The dataset ID.
                },
              },
              "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
              "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
              "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                    # Object with schema name: Value
                  ],
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
              "booleanValue": True or False, # A boolean value.
              "blobKeyValue": "A String", # A blob key value.
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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.
        { # A unique identifier for an entity.
          "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. The path can have at most 100 elements.
            { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
              "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
              "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
            },
          ],
          "partitionId": { # An identifier for a particular subset of entities. # 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.
              #
              # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
            "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.
        { # An entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
              "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                  { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                    "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                    "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                  },
                ],
                "partitionId": { # An identifier for a particular subset of entities. # 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.
                    #
                    # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                  "namespace": "A String", # The namespace.
                  "datasetId": "A String", # The dataset ID.
                },
              },
              "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
              "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
              "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                    # Object with schema name: Value
                  ],
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
              "booleanValue": True or False, # A boolean value.
              "blobKeyValue": "A String", # A blob key value.
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "namespace": "A String", # The namespace.
              "datasetId": "A String", # The dataset ID.
            },
          },
        },
      ],
    },
  }


Returns:
  An object of the form:

    {
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "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.
        { # A unique identifier for an entity.
          "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. The path can have at most 100 elements.
            { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
              "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
              "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
            },
          ],
          "partitionId": { # An identifier for a particular subset of entities. # 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.
              #
              # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
            "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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "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.
      { # A unique identifier for an entity.
        "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. The path can have at most 100 elements.
          { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
            "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
            "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
          },
        ],
        "partitionId": { # An identifier for a particular subset of entities. # 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.
            #
            # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
          "namespace": "A String", # The namespace.
          "datasetId": "A String", # The dataset ID.
        },
      },
    ],
    "missing": [ # Entities not found, with only the key populated.
      { # The result of fetching an entity from the datastore.
        "entity": { # An entity. # The resulting entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
              "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                  { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                    "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                    "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                  },
                ],
                "partitionId": { # An identifier for a particular subset of entities. # 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.
                    #
                    # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                  "namespace": "A String", # The namespace.
                  "datasetId": "A String", # The dataset ID.
                },
              },
              "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
              "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
              "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                    # Object with schema name: Value
                  ],
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
              "booleanValue": True or False, # A boolean value.
              "blobKeyValue": "A String", # A blob key value.
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "namespace": "A String", # The namespace.
              "datasetId": "A String", # The dataset ID.
            },
          },
        },
      },
    ],
    "header": {
      "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
    },
    "found": [ # Entities found.
      { # The result of fetching an entity from the datastore.
        "entity": { # An entity. # The resulting entity.
          "properties": { # The entity's properties.
            "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
              "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                  { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                    "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                    "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                  },
                ],
                "partitionId": { # An identifier for a particular subset of entities. # 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.
                    #
                    # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                  "namespace": "A String", # The namespace.
                  "datasetId": "A String", # The dataset ID.
                },
              },
              "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
              "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
              "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                { # A message that can hold any of the supported value types and associated metadata.
                  "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                      { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                        "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                        "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                      },
                    ],
                    "partitionId": { # An identifier for a particular subset of entities. # 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.
                        #
                        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                      "namespace": "A String", # The namespace.
                      "datasetId": "A String", # The dataset ID.
                    },
                  },
                  "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                  "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                  "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                    # Object with schema name: Value
                  ],
                  "booleanValue": True or False, # A boolean value.
                  "blobKeyValue": "A String", # A blob key value.
                },
              ],
              "booleanValue": True or False, # A boolean value.
              "blobKeyValue": "A String", # A blob key value.
            },
          },
          "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
              { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
              },
            ],
            "partitionId": { # An identifier for a particular subset of entities. # 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.
                #
                # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
              "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", # Identifies what kind of resource this is. Value: the fixed string "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": { # A 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).
        { # A representation of a kind.
          "name": "A String", # The name of the kind.
        },
      ],
      "projection": [ # The projection to return. If not set the entire entity is returned.
        { # A representation of a property in a projection.
          "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": { # A reference to a property relative to the kind expressions. # 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).
        { # The desired order for a specific property.
          "direction": "A String", # The direction to order by. One of ascending or descending. Optional, defaults to ascending.
          "property": { # A reference to a property relative to the kind expressions. # The property to order by.
            "name": "A String", # The name of the property.
          },
        },
      ],
      "filter": { # A holder for any type of filter. Exactly one field should be specified. # The filter to apply (optional).
        "compositeFilter": { # A filter that merges the multiple other filters using the given operation. # 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 specific property. # A filter on a property.
          "operator": "A String", # The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor.
          "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
            "name": "A String", # The name of the property.
          },
          "value": { # A message that can hold any of the supported value types and associated metadata. # 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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "namespace": "A String", # The namespace.
                "datasetId": "A String", # The dataset ID.
              },
            },
            "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
            "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
            "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
              # Object with schema name: 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).
        { # A reference to a property relative to the kind expressions.
          "name": "A String", # The name of the property.
        },
      ],
    },
    "partitionId": { # An identifier for a particular subset of entities. # 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. This partition ID is normalized with the standard default context partition ID, but all other partition IDs in RunQueryRequest are normalized with this partition ID as the context partition ID.
        #
        # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
      "namespace": "A String", # The namespace.
      "datasetId": "A String", # The dataset ID.
    },
    "gqlQuery": { # A GQL query. # The GQL query to run. Either this field or field query must be set, but not both.
      "queryString": "A String", # The query 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.
        { # A binding argument for a GQL query.
          "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": { # A message that can hold any of the supported value types and associated metadata.
            "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "namespace": "A String", # The namespace.
                "datasetId": "A String", # The dataset ID.
              },
            },
            "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
            "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
            "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
              # Object with schema name: 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.
        { # A binding argument for a GQL query.
          "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": { # A message that can hold any of the supported value types and associated metadata.
            "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "namespace": "A String", # The namespace.
                "datasetId": "A String", # The dataset ID.
              },
            },
            "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
            "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
            "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
              # Object with schema name: 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", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
    },
    "batch": { # A batch of results produced by a query. # 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.
        { # The result of fetching an entity from the datastore.
          "entity": { # An entity. # The resulting entity.
            "properties": { # The entity's properties.
              "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
                "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                    { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                      "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                      "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                    },
                  ],
                  "partitionId": { # An identifier for a particular subset of entities. # 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.
                      #
                      # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                    "namespace": "A String", # The namespace.
                    "datasetId": "A String", # The dataset ID.
                  },
                },
                "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                  { # A message that can hold any of the supported value types and associated metadata.
                    "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 unique identifier for an entity. # 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. The path can have at most 100 elements.
                        { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                          "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                          "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                        },
                      ],
                      "partitionId": { # An identifier for a particular subset of entities. # 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.
                          #
                          # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                        "namespace": "A String", # The namespace.
                        "datasetId": "A String", # The dataset ID.
                      },
                    },
                    "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
                    "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. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
                    "listValue": [ # A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.
                      # Object with schema name: Value
                    ],
                    "booleanValue": True or False, # A boolean value.
                    "blobKeyValue": "A String", # A blob key value.
                  },
                ],
                "booleanValue": True or False, # A boolean value.
                "blobKeyValue": "A String", # A blob key value.
              },
            },
            "key": { # A unique identifier for an entity. # 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. The path can have at most 100 elements.
                { # 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. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
                  "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
                  "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
                },
              ],
              "partitionId": { # An identifier for a particular subset of entities. # 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.
                  #
                  # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
                "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. TODO(arfuller): Once all plans produce cursors update documentation here.
      "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.
    },
  }
google-api-python-client-1.5.5/docs/dyn/datastore_v1beta2.html000066400000000000000000000041471300622755700242770ustar00rootroot00000000000000

Google Cloud Datastore API

Instance Methods

datasets()

Returns the datasets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/datastore_v1beta3.html000066400000000000000000000041471300622755700243000ustar00rootroot00000000000000

Google Cloud Datastore API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/datastore_v1beta3.projects.html000066400000000000000000005042151300622755700261310ustar00rootroot00000000000000

Google Cloud Datastore API . projects

Instance Methods

allocateIds(projectId, body, x__xgafv=None)

Allocates IDs for the given keys, which is useful for referencing an entity

beginTransaction(projectId, body, x__xgafv=None)

Begins a new transaction.

commit(projectId, body, x__xgafv=None)

Commits a transaction, optionally creating, deleting or modifying some

lookup(projectId, body, x__xgafv=None)

Looks up entities by key.

rollback(projectId, body, x__xgafv=None)

Rolls back a transaction.

runQuery(projectId, body, x__xgafv=None)

Queries for entities.

Method Details

allocateIds(projectId, body, x__xgafv=None) 
Allocates IDs for the given keys, which is useful for referencing an entity
before it is inserted.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.AllocateIds.
    "keys": [ # A list of keys with incomplete key paths for which to allocate IDs.
        # No key may be reserved/read-only.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.AllocateIds.
    "keys": [ # The keys specified in the request (in the same order), each with
        # its key path completed with a newly allocated ID.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
  }
beginTransaction(projectId, body, x__xgafv=None) 
Begins a new transaction.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.BeginTransaction.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.BeginTransaction.
    "transaction": "A String", # The transaction identifier (always present).
  }
commit(projectId, body, x__xgafv=None) 
Commits a transaction, optionally creating, deleting or modifying some
entities.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.Commit.
    "transaction": "A String", # The identifier of the transaction associated with the commit. A
        # transaction identifier is returned by a call to
        # Datastore.BeginTransaction.
    "mode": "A String", # The type of commit to perform. Defaults to `TRANSACTIONAL`.
    "mutations": [ # The mutations to perform.
        # 
        # When mode is `TRANSACTIONAL`, mutations affecting a single entity are
        # applied in order. The following sequences of mutations affecting a single
        # entity are not permitted in a single `Commit` request:
        # 
        # - `insert` followed by `insert`
        # - `update` followed by `insert`
        # - `upsert` followed by `insert`
        # - `delete` followed by `update`
        # 
        # When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
        # entity.
      { # A mutation to apply to an entity.
        "insert": { # A Datastore data object. # The entity to insert. The entity must not already exist.
            # The entity key's final path element may be incomplete.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
        "delete": { # A unique identifier for an entity. # The key of the entity to delete. The entity may or may not already exist.
            # Must have a complete key path and must not be reserved/read-only.
            # If a key's partition ID or any of its path kinds or names are
            # reserved/read-only, the key is reserved/read-only.
            # A reserved/read-only key is forbidden in certain documented contexts.
          "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 identifies 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. For example,
              # the last path element of the key of `Mutation.insert` may have no
              # identifier.
              #
              # A path can never be empty, and a path can have at most 100 elements.
            { # A (kind, ID/name) pair used to construct a key path.
                #
                # If either name or ID is set, the element is complete.
                # If neither is set, the element is incomplete.
              "kind": "A String", # The kind of the entity.
                  # A kind matching regex `__.*__` is reserved/read-only.
                  # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
              "id": "A String", # The auto-allocated ID of the entity.
                  # Never equal to zero. Values less than zero are discouraged and may not
                  # be supported in the future.
              "name": "A String", # The name of the entity.
                  # A name matching regex `__.*__` is reserved/read-only.
                  # A name must not be more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
            },
          ],
          "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
              # ID and namespace ID.
              # Queries are scoped to a single partition.
              # by project and namespace, however the namespace ID may be empty.
              #
              # A partition ID contains several dimensions:
              # project ID and namespace ID.
              #
              # Partition dimensions:
              #
              # - May be `""`.
              # - Must be valid UTF-8 bytes.
              # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
              # If the value of any dimension matches regex `__.*__`, the partition is
              # reserved/read-only.
              # A reserved/read-only partition ID is forbidden in certain documented
              # contexts.
              #
              # Foreign partition IDs (in which the project ID does
              # not match the context project ID ) are discouraged.
              # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
            "projectId": "A String", # The ID of the project to which the entities belong.
            "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
          },
        },
        "update": { # A Datastore data object. # The entity to update. The entity must already exist.
            # Must have a complete key path.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
        "baseVersion": "A String", # The version of the entity that this mutation is being applied to. If this
            # does not match the current version on the server, the mutation conflicts.
        "upsert": { # A Datastore data object. # The entity to upsert. The entity may or may not already exist.
            # The entity key's final path element may be incomplete.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.Commit.
    "mutationResults": [ # The result of performing the mutations.
        # The i-th mutation result corresponds to the i-th mutation in the request.
      { # The result of applying a mutation.
        "version": "A String", # The version of the entity on the server after processing the mutation. If
            # the mutation doesn't change anything on the server, then the version will
            # be the version of the current entity or, if no entity is present, a version
            # that is strictly greater than the version of any previous entity and less
            # than the version of any possible future entity.
        "conflictDetected": True or False, # Whether a conflict was detected for this mutation. Always false when a
            # conflict detection strategy field is not set in the mutation.
        "key": { # A unique identifier for an entity. # The automatically allocated key.
            # Set only when the mutation allocated a key.
            # If a key's partition ID or any of its path kinds or names are
            # reserved/read-only, the key is reserved/read-only.
            # A reserved/read-only key is forbidden in certain documented contexts.
          "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 identifies 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. For example,
              # the last path element of the key of `Mutation.insert` may have no
              # identifier.
              #
              # A path can never be empty, and a path can have at most 100 elements.
            { # A (kind, ID/name) pair used to construct a key path.
                #
                # If either name or ID is set, the element is complete.
                # If neither is set, the element is incomplete.
              "kind": "A String", # The kind of the entity.
                  # A kind matching regex `__.*__` is reserved/read-only.
                  # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
              "id": "A String", # The auto-allocated ID of the entity.
                  # Never equal to zero. Values less than zero are discouraged and may not
                  # be supported in the future.
              "name": "A String", # The name of the entity.
                  # A name matching regex `__.*__` is reserved/read-only.
                  # A name must not be more than 1500 bytes when UTF-8 encoded.
                  # Cannot be `""`.
            },
          ],
          "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
              # ID and namespace ID.
              # Queries are scoped to a single partition.
              # by project and namespace, however the namespace ID may be empty.
              #
              # A partition ID contains several dimensions:
              # project ID and namespace ID.
              #
              # Partition dimensions:
              #
              # - May be `""`.
              # - Must be valid UTF-8 bytes.
              # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
              # If the value of any dimension matches regex `__.*__`, the partition is
              # reserved/read-only.
              # A reserved/read-only partition ID is forbidden in certain documented
              # contexts.
              #
              # Foreign partition IDs (in which the project ID does
              # not match the context project ID ) are discouraged.
              # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
            "projectId": "A String", # The ID of the project to which the entities belong.
            "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
          },
        },
      },
    ],
    "indexUpdates": 42, # The number of index entries updated during the commit, or zero if none were
        # updated.
  }
lookup(projectId, body, x__xgafv=None) 
Looks up entities by key.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.Lookup.
    "keys": [ # Keys of entities to look up.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
    "readOptions": { # The options shared by read requests. # The options for this lookup request.
      "transaction": "A String", # The identifier of the transaction in which to read. A
          # transaction identifier is returned by a call to
          # Datastore.BeginTransaction.
      "readConsistency": "A String", # The non-transactional read consistency to use.
          # Cannot be set to `STRONG` for global queries.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.Lookup.
    "found": [ # Entities found as `ResultType.FULL` entities. The order of results in this
        # field is undefined and has no relation to the order of the keys in the
        # input.
      { # The result of fetching an entity from Datastore.
        "cursor": "A String", # A cursor that points to the position after the result entity.
            # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
        "version": "A String", # The version of the entity, a strictly positive number that monotonically
            # increases with changes to the entity.
            #
            # This field is set for `FULL` entity
            # results.
            #
            # For missing entities in `LookupResponse`, this
            # is the version of the snapshot that was used to look up the entity, and it
            # is always set except for eventually consistent reads.
        "entity": { # A Datastore data object. # The resulting entity.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
      },
    ],
    "deferred": [ # A list of keys that were not looked up due to resource constraints. The
        # order of results in this field is undefined and has no relation to the
        # order of the keys in the input.
      { # A unique identifier for an entity.
          # If a key's partition ID or any of its path kinds or names are
          # reserved/read-only, the key is reserved/read-only.
          # A reserved/read-only key is forbidden in certain documented contexts.
        "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 identifies 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. For example,
            # the last path element of the key of `Mutation.insert` may have no
            # identifier.
            #
            # A path can never be empty, and a path can have at most 100 elements.
          { # A (kind, ID/name) pair used to construct a key path.
              #
              # If either name or ID is set, the element is complete.
              # If neither is set, the element is incomplete.
            "kind": "A String", # The kind of the entity.
                # A kind matching regex `__.*__` is reserved/read-only.
                # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
            "id": "A String", # The auto-allocated ID of the entity.
                # Never equal to zero. Values less than zero are discouraged and may not
                # be supported in the future.
            "name": "A String", # The name of the entity.
                # A name matching regex `__.*__` is reserved/read-only.
                # A name must not be more than 1500 bytes when UTF-8 encoded.
                # Cannot be `""`.
          },
        ],
        "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
            # ID and namespace ID.
            # Queries are scoped to a single partition.
            # by project and namespace, however the namespace ID may be empty.
            #
            # A partition ID contains several dimensions:
            # project ID and namespace ID.
            #
            # Partition dimensions:
            #
            # - May be `""`.
            # - Must be valid UTF-8 bytes.
            # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
            # If the value of any dimension matches regex `__.*__`, the partition is
            # reserved/read-only.
            # A reserved/read-only partition ID is forbidden in certain documented
            # contexts.
            #
            # Foreign partition IDs (in which the project ID does
            # not match the context project ID ) are discouraged.
            # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
          "projectId": "A String", # The ID of the project to which the entities belong.
          "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
        },
      },
    ],
    "missing": [ # Entities not found as `ResultType.KEY_ONLY` entities. The order of results
        # in this field is undefined and has no relation to the order of the keys
        # in the input.
      { # The result of fetching an entity from Datastore.
        "cursor": "A String", # A cursor that points to the position after the result entity.
            # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
        "version": "A String", # The version of the entity, a strictly positive number that monotonically
            # increases with changes to the entity.
            #
            # This field is set for `FULL` entity
            # results.
            #
            # For missing entities in `LookupResponse`, this
            # is the version of the snapshot that was used to look up the entity, and it
            # is always set except for eventually consistent reads.
        "entity": { # A Datastore data object. # The resulting entity.
            #
            # An entity is limited to 1 megabyte when stored. That _roughly_
            # corresponds to a limit of 1 megabyte for the serialized form of this
            # message.
          "properties": { # The entity's properties.
              # The map's keys are property names.
              # A property name matching regex `__.*__` is reserved.
              # A reserved property name is forbidden in certain documented contexts.
              # The name must not contain more than 500 characters.
              # The name cannot be `""`.
            "a_key": { # A message that can hold any of the supported value types and associated
                # metadata.
              "booleanValue": True or False, # A boolean 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.
              "timestampValue": "A String", # A timestamp value.
                  # When stored in the Datastore, precise only to microseconds;
                  # any additional precision is rounded down.
              "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                  # explicitly.
              "doubleValue": 3.14, # A double value.
              "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
              "keyValue": { # A unique identifier for an entity. # A key value.
                  # If a key's partition ID or any of its path kinds or names are
                  # reserved/read-only, the key is reserved/read-only.
                  # A reserved/read-only key is forbidden in certain documented contexts.
                "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 identifies 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. For example,
                    # the last path element of the key of `Mutation.insert` may have no
                    # identifier.
                    #
                    # A path can never be empty, and a path can have at most 100 elements.
                  { # A (kind, ID/name) pair used to construct a key path.
                      #
                      # If either name or ID is set, the element is complete.
                      # If neither is set, the element is incomplete.
                    "kind": "A String", # The kind of the entity.
                        # A kind matching regex `__.*__` is reserved/read-only.
                        # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                    "id": "A String", # The auto-allocated ID of the entity.
                        # Never equal to zero. Values less than zero are discouraged and may not
                        # be supported in the future.
                    "name": "A String", # The name of the entity.
                        # A name matching regex `__.*__` is reserved/read-only.
                        # A name must not be more than 1500 bytes when UTF-8 encoded.
                        # Cannot be `""`.
                  },
                ],
                "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                    # ID and namespace ID.
                    # Queries are scoped to a single partition.
                    # by project and namespace, however the namespace ID may be empty.
                    #
                    # A partition ID contains several dimensions:
                    # project ID and namespace ID.
                    #
                    # Partition dimensions:
                    #
                    # - May be `""`.
                    # - Must be valid UTF-8 bytes.
                    # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                    # If the value of any dimension matches regex `__.*__`, the partition is
                    # reserved/read-only.
                    # A reserved/read-only partition ID is forbidden in certain documented
                    # contexts.
                    #
                    # Foreign partition IDs (in which the project ID does
                    # not match the context project ID ) are discouraged.
                    # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                  "projectId": "A String", # The ID of the project to which the entities belong.
                  "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                },
              },
              "blobValue": "A String", # A blob value.
                  # May have at most 1,000,000 bytes.
                  # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                  # In JSON requests, must be base64-encoded.
              "stringValue": "A String", # A UTF-8 encoded string value.
                  # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                  # Otherwise, may be set to at least 1,000,000 bytes.
              "nullValue": "A String", # A null value.
              "arrayValue": { # An array value. # An array value.
                  # Cannot contain another array value.
                  # A `Value` instance that sets field `array_value` must not set fields
                  # `meaning` or `exclude_from_indexes`.
                "values": [ # Values in the array.
                    # The order of this array may not be preserved if it contains a mix of
                    # indexed and unindexed values.
                  # Object with schema name: Value
                ],
              },
              "integerValue": "A String", # An integer value.
              "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                  # of doubles representing degrees latitude and degrees longitude. Unless
                  # specified otherwise, this must conform to the
                  # WGS84
                  # standard. Values must be within normalized ranges.
                  #
                  # Example of normalization code in Python:
                  #
                  #     def NormalizeLongitude(longitude):
                  #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                  #       q, r = divmod(longitude, 360.0)
                  #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                  #         return r - 360.0
                  #       return r
                  #
                  #     def NormalizeLatLng(latitude, longitude):
                  #       """Wraps decimal degrees latitude and longitude to
                  #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                  #       r = latitude % 360.0
                  #       if r <= 90.0:
                  #         return r, NormalizeLongitude(longitude)
                  #       elif r >= 270.0:
                  #         return r - 360, NormalizeLongitude(longitude)
                  #       else:
                  #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                  #
                  #     assert 180.0 == NormalizeLongitude(180.0)
                  #     assert -180.0 == NormalizeLongitude(-180.0)
                  #     assert -179.0 == NormalizeLongitude(181.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                  #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                  #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                  #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                  #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                  #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                  #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                  #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
              },
            },
          },
          "key": { # A unique identifier for an entity. # The entity's key.
              #
              # An entity must have a key, unless otherwise documented (for example,
              # an entity in `Value.entity_value` may have no key).
              # An entity's kind is its key path's last element's kind,
              # or null if it has no key.
              # If a key's partition ID or any of its path kinds or names are
              # reserved/read-only, the key is reserved/read-only.
              # A reserved/read-only key is forbidden in certain documented contexts.
            "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 identifies 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. For example,
                # the last path element of the key of `Mutation.insert` may have no
                # identifier.
                #
                # A path can never be empty, and a path can have at most 100 elements.
              { # A (kind, ID/name) pair used to construct a key path.
                  #
                  # If either name or ID is set, the element is complete.
                  # If neither is set, the element is incomplete.
                "kind": "A String", # The kind of the entity.
                    # A kind matching regex `__.*__` is reserved/read-only.
                    # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
                "id": "A String", # The auto-allocated ID of the entity.
                    # Never equal to zero. Values less than zero are discouraged and may not
                    # be supported in the future.
                "name": "A String", # The name of the entity.
                    # A name matching regex `__.*__` is reserved/read-only.
                    # A name must not be more than 1500 bytes when UTF-8 encoded.
                    # Cannot be `""`.
              },
            ],
            "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                # ID and namespace ID.
                # Queries are scoped to a single partition.
                # by project and namespace, however the namespace ID may be empty.
                #
                # A partition ID contains several dimensions:
                # project ID and namespace ID.
                #
                # Partition dimensions:
                #
                # - May be `""`.
                # - Must be valid UTF-8 bytes.
                # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                # If the value of any dimension matches regex `__.*__`, the partition is
                # reserved/read-only.
                # A reserved/read-only partition ID is forbidden in certain documented
                # contexts.
                #
                # Foreign partition IDs (in which the project ID does
                # not match the context project ID ) are discouraged.
                # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
              "projectId": "A String", # The ID of the project to which the entities belong.
              "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
            },
          },
        },
      },
    ],
  }
rollback(projectId, body, x__xgafv=None) 
Rolls back a transaction.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.Rollback.
    "transaction": "A String", # The transaction identifier, returned by a call to
        # Datastore.BeginTransaction.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.Rollback.
      # (an empty message).
  }
runQuery(projectId, body, x__xgafv=None) 
Queries for entities.

Args:
  projectId: string, The ID of the project against which to make the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for Datastore.RunQuery.
    "query": { # A query for entities. # The query to run.
      "startCursor": "A String", # A starting point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "kind": [ # The kinds to query (if empty, returns entities of all kinds).
          # Currently at most 1 kind may be specified.
        { # A representation of a kind.
          "name": "A String", # The name of the kind.
        },
      ],
      "projection": [ # The projection to return. Defaults to returning all properties.
        { # A representation of a property in a projection.
          "property": { # A reference to a property relative to the kind expressions. # The property to project.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
      "distinctOn": [ # The properties to make distinct. The query results will contain the first
          # result for each distinct combination of values for the given properties
          # (if empty, all results are returned).
        { # A reference to a property relative to the kind expressions.
          "name": "A String", # The name of the property.
              # If name includes "."s, it may be interpreted as a property name path.
        },
      ],
      "filter": { # A holder for any type of filter. # The filter to apply.
        "compositeFilter": { # A filter that merges multiple other filters using the given operator. # A composite filter.
          "filters": [ # The list of filters to combine.
              # Must contain at least one filter.
            # Object with schema name: Filter
          ],
          "op": "A String", # The operator for combining multiple filters.
        },
        "propertyFilter": { # A filter on a specific property. # A filter on a property.
          "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
          "value": { # A message that can hold any of the supported value types and associated # The value to compare the property to.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
          "op": "A String", # The operator to filter by.
        },
      },
      "limit": 42, # The maximum number of results to return. Applies after all other
          # constraints. Optional.
          # Unspecified is interpreted as no limit.
          # Must be >= 0 if specified.
      "offset": 42, # The number of results to skip. Applies before limit, but after all other
          # constraints. Optional. Must be >= 0 if specified.
      "endCursor": "A String", # An ending point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "order": [ # The order to apply to the query results (if empty, order is unspecified).
        { # The desired order for a specific property.
          "direction": "A String", # The direction to order by. Defaults to `ASCENDING`.
          "property": { # A reference to a property relative to the kind expressions. # The property to order by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
    },
    "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, identified by a partition ID.
        # Queries are scoped to a single partition.
        # This partition ID is normalized with the standard default context
        # partition ID.
        # by project and namespace, however the namespace ID may be empty.
        #
        # A partition ID contains several dimensions:
        # project ID and namespace ID.
        #
        # Partition dimensions:
        #
        # - May be `""`.
        # - Must be valid UTF-8 bytes.
        # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
        # If the value of any dimension matches regex `__.*__`, the partition is
        # reserved/read-only.
        # A reserved/read-only partition ID is forbidden in certain documented
        # contexts.
        #
        # Foreign partition IDs (in which the project ID does
        # not match the context project ID ) are discouraged.
        # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
      "projectId": "A String", # The ID of the project to which the entities belong.
      "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
    },
    "gqlQuery": { # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # The GQL query to run.
      "namedBindings": { # For each non-reserved named binding site in the query string, there must be
          # a named parameter with that name, but not necessarily the inverse.
          #
          # Key must match regex `A-Za-z_$*`, must not match regex
          # `__.*__`, and must not be `""`.
        "a_key": { # A binding parameter for a GQL query.
          "cursor": "A String", # A query cursor. Query cursors are returned in query
              # result batches.
          "value": { # A message that can hold any of the supported value types and associated # A value parameter.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
        },
      },
      "positionalBindings": [ # Numbered binding site @1 references the first numbered parameter,
          # effectively using 1-based indexing, rather than the usual 0.
          #
          # For each binding site numbered i in `query_string`, there must be an i-th
          # numbered parameter. The inverse must also be true.
        { # A binding parameter for a GQL query.
          "cursor": "A String", # A query cursor. Query cursors are returned in query
              # result batches.
          "value": { # A message that can hold any of the supported value types and associated # A value parameter.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
        },
      ],
      "queryString": "A String", # A string of the format described
          # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
      "allowLiterals": True or False, # When false, the query string must not contain any literals and instead must
          # bind all values. For example,
          # `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
          # `SELECT * FROM Kind WHERE a = @value` is.
    },
    "readOptions": { # The options shared by read requests. # The options for this query.
      "transaction": "A String", # The identifier of the transaction in which to read. A
          # transaction identifier is returned by a call to
          # Datastore.BeginTransaction.
      "readConsistency": "A String", # The non-transactional read consistency to use.
          # Cannot be set to `STRONG` for global queries.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for Datastore.RunQuery.
    "query": { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set.
      "startCursor": "A String", # A starting point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "kind": [ # The kinds to query (if empty, returns entities of all kinds).
          # Currently at most 1 kind may be specified.
        { # A representation of a kind.
          "name": "A String", # The name of the kind.
        },
      ],
      "projection": [ # The projection to return. Defaults to returning all properties.
        { # A representation of a property in a projection.
          "property": { # A reference to a property relative to the kind expressions. # The property to project.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
      "distinctOn": [ # The properties to make distinct. The query results will contain the first
          # result for each distinct combination of values for the given properties
          # (if empty, all results are returned).
        { # A reference to a property relative to the kind expressions.
          "name": "A String", # The name of the property.
              # If name includes "."s, it may be interpreted as a property name path.
        },
      ],
      "filter": { # A holder for any type of filter. # The filter to apply.
        "compositeFilter": { # A filter that merges multiple other filters using the given operator. # A composite filter.
          "filters": [ # The list of filters to combine.
              # Must contain at least one filter.
            # Object with schema name: Filter
          ],
          "op": "A String", # The operator for combining multiple filters.
        },
        "propertyFilter": { # A filter on a specific property. # A filter on a property.
          "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
          "value": { # A message that can hold any of the supported value types and associated # The value to compare the property to.
              # metadata.
            "booleanValue": True or False, # A boolean 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.
            "timestampValue": "A String", # A timestamp value.
                # When stored in the Datastore, precise only to microseconds;
                # any additional precision is rounded down.
            "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                # explicitly.
            "doubleValue": 3.14, # A double value.
            "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
            "keyValue": { # A unique identifier for an entity. # A key value.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
            "blobValue": "A String", # A blob value.
                # May have at most 1,000,000 bytes.
                # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                # In JSON requests, must be base64-encoded.
            "stringValue": "A String", # A UTF-8 encoded string value.
                # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                # Otherwise, may be set to at least 1,000,000 bytes.
            "nullValue": "A String", # A null value.
            "arrayValue": { # An array value. # An array value.
                # Cannot contain another array value.
                # A `Value` instance that sets field `array_value` must not set fields
                # `meaning` or `exclude_from_indexes`.
              "values": [ # Values in the array.
                  # The order of this array may not be preserved if it contains a mix of
                  # indexed and unindexed values.
                # Object with schema name: Value
              ],
            },
            "integerValue": "A String", # An integer value.
            "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
          "op": "A String", # The operator to filter by.
        },
      },
      "limit": 42, # The maximum number of results to return. Applies after all other
          # constraints. Optional.
          # Unspecified is interpreted as no limit.
          # Must be >= 0 if specified.
      "offset": 42, # The number of results to skip. Applies before limit, but after all other
          # constraints. Optional. Must be >= 0 if specified.
      "endCursor": "A String", # An ending point for the query results. Query cursors are
          # returned in query result batches and
          # [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
      "order": [ # The order to apply to the query results (if empty, order is unspecified).
        { # The desired order for a specific property.
          "direction": "A String", # The direction to order by. Defaults to `ASCENDING`.
          "property": { # A reference to a property relative to the kind expressions. # The property to order by.
            "name": "A String", # The name of the property.
                # If name includes "."s, it may be interpreted as a property name path.
          },
        },
      ],
    },
    "batch": { # A batch of results produced by a query. # A batch of query results (always present).
      "entityResultType": "A String", # The result type for every entity in `entity_results`.
      "snapshotVersion": "A String", # The version number of the snapshot this batch was returned from.
          # This applies to the range of results from the query's `start_cursor` (or
          # the beginning of the query if no cursor was given) to this batch's
          # `end_cursor` (not the query's `end_cursor`).
          #
          # In a single transaction, subsequent query result batches for the same query
          # can have a greater snapshot version number. Each batch's snapshot version
          # is valid for all preceding batches.
      "skippedResults": 42, # The number of results skipped, typically because of an offset.
      "entityResults": [ # The results for this batch.
        { # The result of fetching an entity from Datastore.
          "cursor": "A String", # A cursor that points to the position after the result entity.
              # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
          "version": "A String", # The version of the entity, a strictly positive number that monotonically
              # increases with changes to the entity.
              #
              # This field is set for `FULL` entity
              # results.
              #
              # For missing entities in `LookupResponse`, this
              # is the version of the snapshot that was used to look up the entity, and it
              # is always set except for eventually consistent reads.
          "entity": { # A Datastore data object. # The resulting entity.
              #
              # An entity is limited to 1 megabyte when stored. That _roughly_
              # corresponds to a limit of 1 megabyte for the serialized form of this
              # message.
            "properties": { # The entity's properties.
                # The map's keys are property names.
                # A property name matching regex `__.*__` is reserved.
                # A reserved property name is forbidden in certain documented contexts.
                # The name must not contain more than 500 characters.
                # The name cannot be `""`.
              "a_key": { # A message that can hold any of the supported value types and associated
                  # metadata.
                "booleanValue": True or False, # A boolean 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.
                "timestampValue": "A String", # A timestamp value.
                    # When stored in the Datastore, precise only to microseconds;
                    # any additional precision is rounded down.
                "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
                    # explicitly.
                "doubleValue": 3.14, # A double value.
                "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
                "keyValue": { # A unique identifier for an entity. # A key value.
                    # If a key's partition ID or any of its path kinds or names are
                    # reserved/read-only, the key is reserved/read-only.
                    # A reserved/read-only key is forbidden in certain documented contexts.
                  "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 identifies 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. For example,
                      # the last path element of the key of `Mutation.insert` may have no
                      # identifier.
                      #
                      # A path can never be empty, and a path can have at most 100 elements.
                    { # A (kind, ID/name) pair used to construct a key path.
                        #
                        # If either name or ID is set, the element is complete.
                        # If neither is set, the element is incomplete.
                      "kind": "A String", # The kind of the entity.
                          # A kind matching regex `__.*__` is reserved/read-only.
                          # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                          # Cannot be `""`.
                      "id": "A String", # The auto-allocated ID of the entity.
                          # Never equal to zero. Values less than zero are discouraged and may not
                          # be supported in the future.
                      "name": "A String", # The name of the entity.
                          # A name matching regex `__.*__` is reserved/read-only.
                          # A name must not be more than 1500 bytes when UTF-8 encoded.
                          # Cannot be `""`.
                    },
                  ],
                  "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                      # ID and namespace ID.
                      # Queries are scoped to a single partition.
                      # by project and namespace, however the namespace ID may be empty.
                      #
                      # A partition ID contains several dimensions:
                      # project ID and namespace ID.
                      #
                      # Partition dimensions:
                      #
                      # - May be `""`.
                      # - Must be valid UTF-8 bytes.
                      # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                      # If the value of any dimension matches regex `__.*__`, the partition is
                      # reserved/read-only.
                      # A reserved/read-only partition ID is forbidden in certain documented
                      # contexts.
                      #
                      # Foreign partition IDs (in which the project ID does
                      # not match the context project ID ) are discouraged.
                      # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                    "projectId": "A String", # The ID of the project to which the entities belong.
                    "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
                  },
                },
                "blobValue": "A String", # A blob value.
                    # May have at most 1,000,000 bytes.
                    # When `exclude_from_indexes` is false, may have at most 1500 bytes.
                    # In JSON requests, must be base64-encoded.
                "stringValue": "A String", # A UTF-8 encoded string value.
                    # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
                    # Otherwise, may be set to at least 1,000,000 bytes.
                "nullValue": "A String", # A null value.
                "arrayValue": { # An array value. # An array value.
                    # Cannot contain another array value.
                    # A `Value` instance that sets field `array_value` must not set fields
                    # `meaning` or `exclude_from_indexes`.
                  "values": [ # Values in the array.
                      # The order of this array may not be preserved if it contains a mix of
                      # indexed and unindexed values.
                    # Object with schema name: Value
                  ],
                },
                "integerValue": "A String", # An integer value.
                "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
                    # of doubles representing degrees latitude and degrees longitude. Unless
                    # specified otherwise, this must conform to the
                    # WGS84
                    # standard. Values must be within normalized ranges.
                    #
                    # Example of normalization code in Python:
                    #
                    #     def NormalizeLongitude(longitude):
                    #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                    #       q, r = divmod(longitude, 360.0)
                    #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                    #         return r - 360.0
                    #       return r
                    #
                    #     def NormalizeLatLng(latitude, longitude):
                    #       """Wraps decimal degrees latitude and longitude to
                    #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                    #       r = latitude % 360.0
                    #       if r <= 90.0:
                    #         return r, NormalizeLongitude(longitude)
                    #       elif r >= 270.0:
                    #         return r - 360, NormalizeLongitude(longitude)
                    #       else:
                    #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                    #
                    #     assert 180.0 == NormalizeLongitude(180.0)
                    #     assert -180.0 == NormalizeLongitude(-180.0)
                    #     assert -179.0 == NormalizeLongitude(181.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                    #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                    #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                    #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                    #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                  "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                  "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
                },
              },
            },
            "key": { # A unique identifier for an entity. # The entity's key.
                #
                # An entity must have a key, unless otherwise documented (for example,
                # an entity in `Value.entity_value` may have no key).
                # An entity's kind is its key path's last element's kind,
                # or null if it has no key.
                # If a key's partition ID or any of its path kinds or names are
                # reserved/read-only, the key is reserved/read-only.
                # A reserved/read-only key is forbidden in certain documented contexts.
              "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 identifies 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. For example,
                  # the last path element of the key of `Mutation.insert` may have no
                  # identifier.
                  #
                  # A path can never be empty, and a path can have at most 100 elements.
                { # A (kind, ID/name) pair used to construct a key path.
                    #
                    # If either name or ID is set, the element is complete.
                    # If neither is set, the element is incomplete.
                  "kind": "A String", # The kind of the entity.
                      # A kind matching regex `__.*__` is reserved/read-only.
                      # A kind must not contain more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                  "id": "A String", # The auto-allocated ID of the entity.
                      # Never equal to zero. Values less than zero are discouraged and may not
                      # be supported in the future.
                  "name": "A String", # The name of the entity.
                      # A name matching regex `__.*__` is reserved/read-only.
                      # A name must not be more than 1500 bytes when UTF-8 encoded.
                      # Cannot be `""`.
                },
              ],
              "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
                  # ID and namespace ID.
                  # Queries are scoped to a single partition.
                  # by project and namespace, however the namespace ID may be empty.
                  #
                  # A partition ID contains several dimensions:
                  # project ID and namespace ID.
                  #
                  # Partition dimensions:
                  #
                  # - May be `""`.
                  # - Must be valid UTF-8 bytes.
                  # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
                  # If the value of any dimension matches regex `__.*__`, the partition is
                  # reserved/read-only.
                  # A reserved/read-only partition ID is forbidden in certain documented
                  # contexts.
                  #
                  # Foreign partition IDs (in which the project ID does
                  # not match the context project ID ) are discouraged.
                  # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
                "projectId": "A String", # The ID of the project to which the entities belong.
                "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
              },
            },
          },
        },
      ],
      "skippedCursor": "A String", # A cursor that points to the position after the last skipped result.
          # Will be set when `skipped_results` != 0.
      "moreResults": "A String", # The state of the query after the current batch.
      "endCursor": "A String", # A cursor that points to the position after the last result in the batch.
    },
  }
google-api-python-client-1.5.5/docs/dyn/deploymentmanager_v2.deployments.html000066400000000000000000003151621300622755700274530ustar00rootroot00000000000000

Google Cloud Deployment Manager API . deployments

Instance Methods

cancelPreview(project, deployment, body)

Cancels and removes the preview currently associated with the deployment.

delete(project, deployment)

Deletes a deployment and all of the resources in the deployment.

get(project, deployment)

Gets information about a specific deployment.

getIamPolicy(project, resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body, preview=None)

Creates a deployment and all of the resources described by the deployment manifest.

list(project, maxResults=None, pageToken=None, filter=None)

Lists all deployments for a given project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)

Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.

setIamPolicy(project, resource, body)

Sets the access control policy on the specified resource. Replaces any existing policy.

stop(project, deployment, body)

Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.

testIamPermissions(project, resource, body)

Returns permissions that a caller has on the specified resource.

update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)

Updates a deployment and all of the resources described by the deployment manifest.

Method Details

cancelPreview(project, deployment, body) 
Cancels and removes the preview currently associated with the deployment.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
        # 
        # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
delete(project, deployment) 
Deletes a deployment and all of the resources in the deployment.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
get(project, deployment) 
Gets information about a specific deployment.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)

Returns:
  An object of the form:

    {
      "description": "A String", # An optional user-provided description of the deployment.
      "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
        {
          "value": "A String",
          "key": "A String",
        },
      ],
      "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
        "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
          {
            "value": "A String",
            "key": "A String",
          },
        ],
        "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
      },
      "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
      "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
      "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
          #
          # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
      "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
      "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
        "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
          {
            "content": "A String", # The contents of the file.
            "name": "A String", # The name of the file.
          },
        ],
        "config": { # The configuration to use for this deployment.
          "content": "A String", # The contents of the file.
        },
      },
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] Self link for the deployment.
      "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    }
getIamPolicy(project, resource) 
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
insert(project, body, preview=None) 
Creates a deployment and all of the resources described by the deployment manifest.

Args:
  project: string, The project ID for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "description": "A String", # An optional user-provided description of the deployment.
    "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
      "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
        {
          "value": "A String",
          "key": "A String",
        },
      ],
      "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
    },
    "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
    "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
    "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
        # 
        # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
    "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
      "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
      "clientOperationId": "A String", # [Output Only] Reserved for future use.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
      "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
      "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
      "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
      "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
      "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
      "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
      "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
      "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
      "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
        {
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      ],
      "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
      "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
      "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
      "name": "A String", # [Output Only] Name of the resource.
      "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
      "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
          {
            "message": "A String", # [Output Only] An optional, human-readable error message.
            "code": "A String", # [Output Only] The error type identifier for this error.
            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
          },
        ],
      },
      "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
    },
    "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
      "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
        {
          "content": "A String", # The contents of the file.
          "name": "A String", # The name of the file.
        },
      ],
      "config": { # The configuration to use for this deployment.
        "content": "A String", # The contents of the file.
      },
    },
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Self link for the deployment.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, maxResults=None, pageToken=None, filter=None) 
Lists all deployments for a given project.

Args:
  project: string, The project ID for this request. (required)
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "deployments": [ # [Output Only] The deployments contained in this response.
      {
          "description": "A String", # An optional user-provided description of the deployment.
          "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
            {
              "value": "A String",
              "key": "A String",
            },
          ],
          "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
            "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
              {
                "value": "A String",
                "key": "A String",
              },
            ],
            "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
          },
          "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
          "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
          "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
              #
              # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
          "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
            "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
            "clientOperationId": "A String", # [Output Only] Reserved for future use.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
            "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
            "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
            "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
            "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
            "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
            "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
            "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
            "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
            "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
              {
                "message": "A String", # [Output Only] A human-readable description of the warning code.
                "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
                "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                    # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                  {
                    "value": "A String", # [Output Only] A warning data value corresponding to the key.
                    "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                  },
                ],
              },
            ],
            "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
            "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
            "name": "A String", # [Output Only] Name of the resource.
            "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
            "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
              "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                {
                  "message": "A String", # [Output Only] An optional, human-readable error message.
                  "code": "A String", # [Output Only] The error type identifier for this error.
                  "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
                },
              ],
            },
            "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
          },
          "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
            "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
              {
                "content": "A String", # The contents of the file.
                "name": "A String", # The name of the file.
              },
            ],
            "config": { # The configuration to use for this deployment.
              "content": "A String", # The contents of the file.
            },
          },
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] Self link for the deployment.
          "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        },
    ],
  }
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, deployment, body, deletePolicy=None, createPolicy=None, preview=None) 
Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "description": "A String", # An optional user-provided description of the deployment.
    "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
      "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
        {
          "value": "A String",
          "key": "A String",
        },
      ],
      "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
    },
    "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
    "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
    "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
        # 
        # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
    "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
      "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
      "clientOperationId": "A String", # [Output Only] Reserved for future use.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
      "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
      "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
      "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
      "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
      "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
      "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
      "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
      "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
      "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
        {
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      ],
      "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
      "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
      "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
      "name": "A String", # [Output Only] Name of the resource.
      "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
      "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
          {
            "message": "A String", # [Output Only] An optional, human-readable error message.
            "code": "A String", # [Output Only] The error type identifier for this error.
            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
          },
        ],
      },
      "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
    },
    "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
      "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
        {
          "content": "A String", # The contents of the file.
          "name": "A String", # The name of the file.
        },
      ],
      "config": { # The configuration to use for this deployment.
        "content": "A String", # The contents of the file.
      },
    },
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Self link for the deployment.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  deletePolicy: string, Sets the policy to use for deleting resources.
    Allowed values
      ABANDON - 
      DELETE - 
  createPolicy: string, Sets the policy to use for creating new resources.
    Allowed values
      ACQUIRE - 
      CREATE_OR_ACQUIRE - 
  preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
setIamPolicy(project, resource, body) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
    # 
    # 
    # 
    # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
    # 
    # **Example**
    # 
    # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
    # 
    # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
  "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
      # 
      # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
    { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
      "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
        "A String",
      ],
      "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
    },
  ],
  "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    { # A rule to be applied in a Policy.
      "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
        { # Specifies what kind of log the caller must write
          "counter": { # Options for counters # Counter options.
            "field": "A String", # The field value to attribute.
            "metric": "A String", # The metric to update.
          },
        },
      ],
      "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
        "A String",
      ],
      "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
        "A String",
      ],
      "action": "A String", # Required
      "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
        "A String",
      ],
      "conditions": [ # Additional restrictions that must be met
        { # A condition to be met.
          "iam": "A String", # Trusted attributes supplied by the IAM system.
          "svc": "A String", # Trusted attributes discharged by the service.
          "value": "A String", # DEPRECATED. Use 'values' instead.
          "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
          "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
            "A String",
          ],
          "op": "A String", # An operator to apply the subject with.
        },
      ],
      "description": "A String", # Human-readable description of the rule.
    },
  ],
  "version": 42, # Version of the `Policy`. The default version is 0.
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
      # 
      # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
    { # Associates `members` with a `role`.
      "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
          #
          # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
          #
          # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
          #
          # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
          #
          # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
          #
          # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
          #
          # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
    },
  ],
  "iamOwned": True or False,
}


Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
      #
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
      #
      # **Example**
      #
      # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
      #
      # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
          { # Specifies what kind of log the caller must write
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
          },
        ],
        "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
          "A String",
        ],
        "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "description": "A String", # Human-readable description of the rule.
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
stop(project, deployment, body) 
Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).
        # 
        # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
  }


Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
testIamPermissions(project, resource, body) 
Returns permissions that a caller has on the specified resource.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name of the resource for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None) 
Updates a deployment and all of the resources described by the deployment manifest.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "description": "A String", # An optional user-provided description of the deployment.
    "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
      "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
        {
          "value": "A String",
          "key": "A String",
        },
      ],
      "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
    },
    "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
    "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
    "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
        # 
        # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
    "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
      "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
      "clientOperationId": "A String", # [Output Only] Reserved for future use.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
      "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
      "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
      "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
      "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
      "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
      "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
      "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
      "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
      "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
        {
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      ],
      "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
      "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
      "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
      "name": "A String", # [Output Only] Name of the resource.
      "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
      "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
          {
            "message": "A String", # [Output Only] An optional, human-readable error message.
            "code": "A String", # [Output Only] The error type identifier for this error.
            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
          },
        ],
      },
      "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
    },
    "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
      "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
        {
          "content": "A String", # The contents of the file.
          "name": "A String", # The name of the file.
        },
      ],
      "config": { # The configuration to use for this deployment.
        "content": "A String", # The contents of the file.
      },
    },
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Self link for the deployment.
    "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  }

  deletePolicy: string, Sets the policy to use for deleting resources.
    Allowed values
      ABANDON - 
      DELETE - 
  createPolicy: string, Sets the policy to use for creating new resources.
    Allowed values
      ACQUIRE - 
      CREATE_OR_ACQUIRE - 
  preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
google-api-python-client-1.5.5/docs/dyn/deploymentmanager_v2.html000066400000000000000000000054061300622755700251060ustar00rootroot00000000000000

Google Cloud Deployment Manager API

Instance Methods

deployments()

Returns the deployments Resource.

manifests()

Returns the manifests Resource.

operations()

Returns the operations Resource.

resources()

Returns the resources Resource.

types()

Returns the types Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/deploymentmanager_v2.manifests.html000066400000000000000000000155001300622755700270720ustar00rootroot00000000000000

Google Cloud Deployment Manager API . manifests

Instance Methods

get(project, deployment, manifest)

Gets information about a specific manifest.

list(project, deployment, maxResults=None, pageToken=None, filter=None)

Lists all manifests for a given deployment.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, deployment, manifest) 
Gets information about a specific manifest.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  manifest: string, The name of the manifest for this request. (required)

Returns:
  An object of the form:

    {
    "layout": "A String", # [Output Only] The YAML layout for this manifest.
    "name": "A String", # [Output Only] The name of the manifest.
    "expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
    "imports": [ # [Output Only] The imported files for this manifest.
      {
        "content": "A String", # The contents of the file.
        "name": "A String", # The name of the file.
      },
    ],
    "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
    "config": { # [Output Only] The YAML configuration for this manifest.
      "content": "A String", # The contents of the file.
    },
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Self link for the manifest.
  }
list(project, deployment, maxResults=None, pageToken=None, filter=None) 
Lists all manifests for a given deployment.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "manifests": [ # [Output Only] Manifests contained in this list response.
      {
        "layout": "A String", # [Output Only] The YAML layout for this manifest.
        "name": "A String", # [Output Only] The name of the manifest.
        "expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
        "imports": [ # [Output Only] The imported files for this manifest.
          {
            "content": "A String", # The contents of the file.
            "name": "A String", # The name of the file.
          },
        ],
        "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
        "config": { # [Output Only] The YAML configuration for this manifest.
          "content": "A String", # The contents of the file.
        },
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "selfLink": "A String", # [Output Only] Self link for the manifest.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/deploymentmanager_v2.operations.html000066400000000000000000000343371300622755700272750ustar00rootroot00000000000000

Google Cloud Deployment Manager API . operations

Instance Methods

get(project, operation)

Gets information about a specific operation.

list(project, maxResults=None, pageToken=None, filter=None)

Lists all operations for a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, operation) 
Gets information about a specific operation.

Args:
  project: string, The project ID for this request. (required)
  operation: string, The name of the operation for this request. (required)

Returns:
  An object of the form:

    { # An Operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "clientOperationId": "A String", # [Output Only] Reserved for future use.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
  }
list(project, maxResults=None, pageToken=None, filter=None) 
Lists all operations for a project.

Args:
  project: string, The project ID for this request. (required)
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "operations": [ # [Output Only] Operations contained in this list response.
      { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/deploymentmanager_v2.resources.html000066400000000000000000000372501300622755700271210ustar00rootroot00000000000000

Google Cloud Deployment Manager API . resources

Instance Methods

get(project, deployment, resource)

Gets information about a single resource.

list(project, deployment, maxResults=None, pageToken=None, filter=None)

Lists all resources in a given deployment.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, deployment, resource) 
Gets information about a single resource.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  resource: string, The name of the resource for this request. (required)

Returns:
  An object of the form:

    {
    "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
      "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
    },
    "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
    "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
    "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
    "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
          },
        ],
      },
    ],
    "url": "A String", # [Output Only] The URL of the actual resource.
    "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
      "accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
        "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
      },
      "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
      "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
        {
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
            },
          ],
        },
      ],
      "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
      "state": "A String", # [Output Only] The state of the resource.
      "intent": "A String", # [Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL.
      "error": { # [Output Only] If errors are generated during update of the resource, this field will be populated.
        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
          {
            "message": "A String", # [Output Only] An optional, human-readable error message.
            "code": "A String", # [Output Only] The error type identifier for this error.
            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
          },
        ],
      },
      "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
    },
    "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
    "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
    "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
    "type": "A String", # [Output Only] The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
  }
list(project, deployment, maxResults=None, pageToken=None, filter=None) 
Lists all resources in a given deployment.

Args:
  project: string, The project ID for this request. (required)
  deployment: string, The name of the deployment for this request. (required)
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
    "nextPageToken": "A String", # A token used to continue a truncated list request.
    "resources": [ # Resources contained in this list response.
      {
        "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
          "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
        },
        "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
        "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
        "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
        "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              },
            ],
          },
        ],
        "url": "A String", # [Output Only] The URL of the actual resource.
        "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
          "accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
            "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
          },
          "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
          "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
            {
              "message": "A String", # [Output Only] A human-readable description of the warning code.
              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                  "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                },
              ],
            },
          ],
          "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
          "state": "A String", # [Output Only] The state of the resource.
          "intent": "A String", # [Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL.
          "error": { # [Output Only] If errors are generated during update of the resource, this field will be populated.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
          "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
        },
        "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
        "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
        "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
        "type": "A String", # [Output Only] The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/deploymentmanager_v2.types.html000066400000000000000000000232051300622755700262460ustar00rootroot00000000000000

Google Cloud Deployment Manager API . types

Instance Methods

list(project, maxResults=None, pageToken=None, filter=None)

Lists all resource types for Deployment Manager.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(project, maxResults=None, pageToken=None, filter=None) 
Lists all resource types for Deployment Manager.

Args:
  project: string, The project ID for this request. (required)
  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

Returns:
  An object of the form:

    { # A response that returns all Types supported by Deployment Manager
    "nextPageToken": "A String", # A token used to continue a truncated list request.
    "types": [ # [Output Only] A list of resource types supported by Deployment Manager.
      { # A resource type supported by Deployment Manager.
        "selfLink": "A String", # [Output Only] Self link for the type.
        "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type.
          "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
          "clientOperationId": "A String", # [Output Only] Reserved for future use.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
          "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
          "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
          "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
          "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
          "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
          "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
          "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
          "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
          "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
          "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
            {
              "message": "A String", # [Output Only] A human-readable description of the warning code.
              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                  "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                },
              ],
            },
          ],
          "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
          "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
          "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
          "name": "A String", # [Output Only] Name of the resource.
          "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
          "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
          "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
        },
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "insertTime": "A String", # [Output Only] Timestamp when the type was created, in RFC3339 text format.
        "name": "A String", # Name of the 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.accountActiveAdSummaries.html000066400000000000000000000042261300622755700312230ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountActiveAdSummaries

Instance Methods

get(profileId, summaryAccountId)

Gets the account's active ad summary by account ID.

Method Details

get(profileId, summaryAccountId) 
Gets the account's active ad summary by account ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  summaryAccountId: string, Account ID. (required)

Returns:
  An object of the form:

    { # Gets a summary of active ads in an account.
    "availableAds": "A String", # Ads that can be activated for the account.
    "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
    "activeAds": "A String", # Ads that have been activated for the account
    "accountId": "A String", # ID of the account.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.accountPermissionGroups.html000066400000000000000000000062671300622755700312140ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissionGroups

Instance Methods

get(profileId, id)

Gets one account permission group by ID.

list(profileId)

Retrieves the list of account permission groups.

Method Details

get(profileId, id) 
Gets one account permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission group ID. (required)

Returns:
  An object of the form:

    { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
    "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
    "id": "A String", # ID of this account permission group.
    "name": "A String", # Name of this account permission group.
  }
list(profileId) 
Retrieves the list of account permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission Group List Response
    "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
    "accountPermissionGroups": [ # Account permission group collection.
      { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
        "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
        "id": "A String", # ID of this account permission group.
        "name": "A String", # Name of this account permission group.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.accountPermissions.html000066400000000000000000000077041300622755700301740ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissions

Instance Methods

get(profileId, id)

Gets one account permission by ID.

list(profileId)

Retrieves the list of account permissions.

Method Details

get(profileId, id) 
Gets one account permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission ID. (required)

Returns:
  An object of the form:

    { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
    "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
    "name": "A String", # Name of this account permission.
    "level": "A String", # Administrative level required to enable this account permission.
    "permissionGroupId": "A String", # Permission group of this account permission.
    "accountProfiles": [ # Account profiles associated with this account permission.
        #
        # Possible values are:
        # - "ACCOUNT_PROFILE_BASIC"
        # - "ACCOUNT_PROFILE_STANDARD"
      "A String",
    ],
    "id": "A String", # ID of this account permission.
  }
list(profileId) 
Retrieves the list of account permissions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission List Response
    "accountPermissions": [ # Account permission collection.
      { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
        "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
        "name": "A String", # Name of this account permission.
        "level": "A String", # Administrative level required to enable this account permission.
        "permissionGroupId": "A String", # Permission group of this account permission.
        "accountProfiles": [ # Account profiles associated with this account permission.
            #
            # Possible values are:
            # - "ACCOUNT_PROFILE_BASIC"
            # - "ACCOUNT_PROFILE_STANDARD"
          "A String",
        ],
        "id": "A String", # ID of this account permission.
      },
    ],
    "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.accountUserProfiles.html000066400000000000000000001271001300622755700302740ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountUserProfiles

Instance Methods

get(profileId, id)

Gets one account user profile by ID.

insert(profileId, body)

Inserts a new account user profile.

list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)

Retrieves a list of account user profiles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account user profile. This method supports patch semantics.

update(profileId, body)

Updates an existing account user profile.

Method Details

get(profileId, id) 
Gets one account user profile by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)

Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None) 
Retrieves a list of account user profiles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
  subaccountId: string, Select only user profiles with the specified subaccount ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only user profiles with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  userRoleId: string, Select only user profiles with the specified user role ID.
  active: boolean, Select only active user profiles.

Returns:
  An object of the form:

    { # Account User Profile List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "accountUserProfiles": [ # Account user profile collection.
      { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
          "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
          "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
          "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
          "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "locale": "A String", # Locale of the user profile. This is a required field.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "comments": "A String", # Comments for this user profile.
          "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
          "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "userRoleId": "A String", # User role ID of the user profile. This is a required field.
          "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
          "traffickerType": "A String", # Trafficker type of this user profile.
          "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
          "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
          "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
  }
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, id, body) 
Updates an existing account user profile. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.accounts.html000066400000000000000000001147041300622755700261220ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accounts

Instance Methods

get(profileId, id)

Gets one account by ID.

list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)

Retrieves the list of accounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account. This method supports patch semantics.

update(profileId, body)

Updates an existing account.

Method Details

get(profileId, id) 
Gets one account by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None) 
Retrieves the list of accounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only accounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.

Returns:
  An object of the form:

    { # Account List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
    "accounts": [ # Account collection.
      { # Contains properties of a DCM account.
          "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
          "countryId": "A String", # ID of the country associated with this account.
          "availablePermissionIds": [ # User role permissions available to the user roles of this account.
            "A String",
          ],
          "description": "A String", # Description of this account.
          "maximumImageSize": "A String", # Maximum image size allowed for this account.
          "currencyId": "A String", # ID of currency associated with this account. This is a required field.
              # Acceptable values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
          "accountPermissionIds": [ # Account permissions assigned to this account.
            "A String",
          ],
          "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
          "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
          "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
          "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
          "locale": "A String", # Locale of this account.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
          "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
            "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
                # Acceptable values are:
                #
                # - "1" for "America/New_York"
                # - "2" for "Europe/London"
                # - "3" for "Europe/Paris"
                # - "4" for "Africa/Johannesburg"
                # - "5" for "Asia/Jerusalem"
                # - "6" for "Asia/Shanghai"
                # - "7" for "Asia/Hong_Kong"
                # - "8" for "Asia/Tokyo"
                # - "9" for "Australia/Sydney"
                # - "10" for "Asia/Dubai"
                # - "11" for "America/Los_Angeles"
                # - "12" for "Pacific/Auckland"
                # - "13" for "America/Sao_Paulo"
            "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
            "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
          },
          "active": True or False, # Whether this account is active.
          "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
          "id": "A String", # ID of this account. This is a read-only, auto-generated field.
          "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
        },
    ],
  }
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, id, body) 
Updates an existing account. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
update(profileId, body) 
Updates an existing account.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.ads.html000066400000000000000000010522021300622755700250450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . ads

Instance Methods

get(profileId, id)

Gets one ad by ID.

insert(profileId, body)

Inserts a new ad.

list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)

Retrieves a list of ads, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing ad. This method supports patch semantics.

update(profileId, body)

Updates an existing ad.

Method Details

get(profileId, id) 
Gets one ad by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
insert(profileId, body) 
Inserts a new ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None) 
Retrieves a list of ads, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  landingPageIds: string, Select only ads with these landing page IDs. (repeated)
  overriddenEventTagId: string, Select only ads with this event tag override ID.
  campaignIds: string, Select only ads with these campaign IDs. (repeated)
  sizeIds: string, Select only ads with these size IDs. (repeated)
  archived: boolean, Select only archived ads.
  creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
  sslCompliant: boolean, Select only ads that are SSL-compliant.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only ads with these types. (repeated)
    Allowed values
      AD_SERVING_CLICK_TRACKER - 
      AD_SERVING_DEFAULT_AD - 
      AD_SERVING_STANDARD_AD - 
      AD_SERVING_TRACKING - 
  sslRequired: boolean, Select only ads that require SSL.
  creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
  remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  creativeType: string, Select only ads with the specified creativeType.
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_INPAGE - 
      CUSTOM_INTERSTITIAL - 
      ENHANCED_BANNER - 
      ENHANCED_IMAGE - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      REDIRECT - 
      RICH_MEDIA_EXPANDING - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_INTERSTITIAL_FLOAT - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_MULTI_FLOATING - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR - 
      VPAID_NON_LINEAR - 
  placementIds: string, Select only ads with these placement IDs assigned. (repeated)
  active: boolean, Select only active ads.
  compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  advertiserId: string, Select only ads with this advertiser ID.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
  audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
  ids: string, Select only ads with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Returns:
  An object of the form:

    { # Ad List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
    "ads": [ # Ad collection.
      { # Contains properties of a DCM ad.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
          "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
          "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
              { # Contains information about a country that can be targeted by ads.
                "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
                "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
                "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
                "countryCode": "A String", # Country code.
                "name": "A String", # Name of this country.
              },
            ],
            "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
            "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
              { # Contains information about a postal code that can be targeted by ads.
                "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
                "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
                "code": "A String", # Postal code. This is equivalent to the id field.
                "id": "A String", # ID of this postal code.
                "countryCode": "A String", # Country code of the country to which this postal code belongs.
              },
            ],
            "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
              { # Contains information about a region that can be targeted by ads.
                "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
                "countryDartId": "A String", # DART ID of the country to which this region belongs.
                "name": "A String", # Name of this region.
                "countryCode": "A String", # Country code of the country to which this region belongs.
                "regionCode": "A String", # Region code.
                "dartId": "A String", # DART ID of this region.
              },
            ],
            "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
              { # Contains information about a city that can be targeted by ads.
                "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
                "countryDartId": "A String", # DART ID of the country to which this city belongs.
                "name": "A String", # Name of this city.
                "countryCode": "A String", # Country code of the country to which this city belongs.
                "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
                "regionCode": "A String", # Region code of the region to which this city belongs.
                "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
                "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
                "regionDartId": "A String", # DART ID of the region to which this city belongs.
              },
            ],
            "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
              { # Contains information about a metro region that can be targeted by ads.
                "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
                "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
                "name": "A String", # Name of this metro region.
                "countryCode": "A String", # Country code of the country to which this metro region belongs.
                "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
                "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
                "dartId": "A String", # DART ID of this metro region.
              },
            ],
          },
          "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
            "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
            "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
            "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
              "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
              "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
            },
            "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Event tag overrides for this ad.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this ad is archived.
          "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a platform type that can be targeted by ads.
                "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
                "id": "A String", # ID of this platform type.
                "name": "A String", # Name of this platform type.
              },
            ],
            "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
              { # Contains information about a particular version of an operating system that can be targeted by ads.
                "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
                "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
                "name": "A String", # Name of this operating system version.
                "id": "A String", # ID of this operating system version.
                "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
                  "mobile": True or False, # Whether this operating system is for mobile.
                  "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                  "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                  "name": "A String", # Name of this operating system.
                  "desktop": True or False, # Whether this operating system is for desktop.
                },
                "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
              },
            ],
            "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a browser that can be targeted by ads.
                "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
                "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
                "name": "A String", # Name of this browser.
                "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
                "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
                "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
              },
            ],
            "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
              { # Contains information about an operating system that can be targeted by ads.
                "mobile": True or False, # Whether this operating system is for mobile.
                "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                "name": "A String", # Name of this operating system.
                "desktop": True or False, # Whether this operating system is for desktop.
              },
            ],
            "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
              { # Contains information about a mobile carrier that can be targeted by ads.
                "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
                "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
                "id": "A String", # ID of this mobile carrier.
                "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
                "name": "A String", # Name of this mobile carrier.
              },
            ],
            "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
                "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
                "id": "A String", # ID of this connection type.
                "name": "A String", # Name of this connection type.
              },
            ],
          },
          "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
            "creativeAssignments": [ # Creative assignments in this creative rotation.
              { # Creative Assignment.
                "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
                "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
                "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
                "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                    # Applicable when the creative type is any of the following:
                    # - RICH_MEDIA_INPAGE
                    # - RICH_MEDIA_INPAGE_FLOATING
                    # - RICH_MEDIA_IM_EXPAND
                    # - RICH_MEDIA_EXPANDING
                    # - RICH_MEDIA_INTERSTITIAL_FLOAT
                    # - RICH_MEDIA_MOBILE_IN_APP
                    # - RICH_MEDIA_MULTI_FLOATING
                    # - RICH_MEDIA_PEEL_DOWN
                    # - ADVANCED_BANNER
                    # - VPAID_LINEAR
                    # - VPAID_NON_LINEAR
                  { # Rich Media Exit Override.
                    "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                    "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                    "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
                  },
                ],
                "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
                "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
                  { # Creative Group Assignment.
                    "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                    "creativeGroupId": "A String", # ID of the creative group to be assigned.
                  },
                ],
                "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
                  { # Companion Click-through override.
                    "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                    },
                    "creativeId": "A String", # ID of the creative for this companion click-through override.
                  },
                ],
                "startTime": "A String", # Date and time that the assigned creative should start serving.
                "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
                "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
                "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
                "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              },
            ],
            "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
            "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
            "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
          },
          "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "comments": "A String", # Comments for this ad.
          "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Expression describing which lists are being targeted by the ad.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
          "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
          "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Keyword expression being targeted by the ad.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
          "active": True or False, # Whether this ad is active.
          "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
          "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
          "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
          "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
          "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
            "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
              42,
            ],
            "daysOfWeek": [ # Days of the week when the ad will serve.
                #
                # Acceptable values are:
                # - "SUNDAY"
                # - "MONDAY"
                # - "TUESDAY"
                # - "WEDNESDAY"
                # - "THURSDAY"
                # - "FRIDAY"
                # - "SATURDAY"
              "A String",
            ],
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "placementAssignments": [ # Placement assignments for this ad.
            { # Placement Assignment.
              "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
              "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "placementId": "A String", # ID of the placement to be assigned. This is a required field.
              "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
            },
          ],
          "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
          "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
        },
    ],
  }
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, id, body) 
Updates an existing ad. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
update(profileId, body) 
Updates an existing ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.advertiserGroups.html000066400000000000000000000262671300622755700276610ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertiserGroups

Instance Methods

delete(profileId, id)

Deletes an existing advertiser group.

get(profileId, id)

Gets one advertiser group by ID.

insert(profileId, body)

Inserts a new advertiser group.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of advertiser groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser group. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser group.

Method Details

delete(profileId, id) 
Deletes an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
get(profileId, id) 
Gets one advertiser group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of advertiser groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only advertiser groups with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Advertiser Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
    "advertiserGroups": [ # Advertiser group collection.
      { # Groups advertisers together so that reports can be generated for the entire group at once.
          "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
          "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
          "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing advertiser group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.advertisers.html000066400000000000000000001217041300622755700266340ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertisers

Instance Methods

get(profileId, id)

Gets one advertiser by ID.

insert(profileId, body)

Inserts a new advertiser.

list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)

Retrieves a list of advertisers, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser.

Method Details

get(profileId, id) 
Gets one advertiser by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None) 
Retrieves a list of advertisers, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
  onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  status: string, Select only advertisers with the specified status.
    Allowed values
      APPROVED - 
      ON_HOLD - 
  maxResults: integer, Maximum number of results to return.
  advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
  subaccountId: string, Select only advertisers with these subaccount IDs.
  ids: string, Select only advertisers with these IDs. (repeated)
  floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Advertiser List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "advertisers": [ # Advertiser collection.
      { # Contains properties of a DCM advertiser.
          "status": "A String", # Status of this advertiser.
          "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
          "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
          "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
          "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
          "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
          "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
              # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
              # - This advertiser's original floodlight configuration is not already shared with another advertiser.
          "suspended": True or False, # Suspension status of this advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultEmail": "A String", # Default email address used in sender field for tag emails.
          "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
  }
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, id, body) 
Updates an existing advertiser. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.browsers.html000066400000000000000000000065301300622755700261460ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . browsers

Instance Methods

list(profileId)

Retrieves a list of browsers.

Method Details

list(profileId) 
Retrieves a list of browsers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Browser List Response
    "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
    "browsers": [ # Browser collection.
      { # Contains information about a browser that can be targeted by ads.
        "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
        "name": "A String", # Name of this browser.
        "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
        "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
        "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.campaignCreativeAssociations.html000066400000000000000000000120761300622755700321240ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaignCreativeAssociations

Instance Methods

insert(profileId, campaignId, body)

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)

Retrieves the list of creative IDs associated with the specified campaign.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

insert(profileId, campaignId, body) 
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Identifies a creative which has been associated with a given campaign.
    "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
    "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
  }


Returns:
  An object of the form:

    { # Identifies a creative which has been associated with a given campaign.
      "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
      "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
    }
list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves the list of creative IDs associated with the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Campaign Creative Association List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "campaignCreativeAssociations": [ # Campaign creative association collection
      { # Identifies a creative which has been associated with a given campaign.
          "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
          "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
        },
    ],
    "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.campaigns.html000066400000000000000000003133611300622755700262450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaigns

Instance Methods

get(profileId, id)

Gets one campaign by ID.

insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)

Inserts a new campaign.

list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)

Retrieves a list of campaigns, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing campaign. This method supports patch semantics.

update(profileId, body)

Updates an existing campaign.

Method Details

get(profileId, id) 
Gets one campaign by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body) 
Inserts a new campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
  defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None) 
Retrieves a list of campaigns, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
  archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
  advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  excludedIds: string, Exclude campaigns with these IDs. (repeated)
  advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
  searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
  subaccountId: string, Select only campaigns that belong to this subaccount.
  ids: string, Select only campaigns with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.

Returns:
  An object of the form:

    { # Campaign List Response
    "campaigns": [ # Campaign collection.
      { # Contains properties of a DCM campaign.
          "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
          "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
          "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
            "optimizationActivitys": [ # List of optimization activities associated with this configuration.
              { # Creative optimization activity.
                "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
                "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
              },
            ],
            "optimizationModel": "A String", # Optimization model for this configuration.
            "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
            "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
          },
          "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
          "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
          "traffickerEmails": [ # Campaign trafficker contact emails.
            "A String",
          ],
          "archived": True or False, # Whether this campaign has been archived.
          "externalId": "A String", # External ID for this campaign.
          "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
          "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
          "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
            "A String",
          ],
          "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
            { # Creative optimization settings.
              "optimizationActivitys": [ # List of optimization activities associated with this configuration.
                { # Creative optimization activity.
                  "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                  "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                    "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                  },
                  "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
                },
              ],
              "optimizationModel": "A String", # Optimization model for this configuration.
              "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
              "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
            },
          ],
          "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
          "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
          "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
            { # Audience Segment Group.
              "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
                { # Audience Segment.
                  "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
                  "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
                  "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
                },
              ],
              "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
            },
          ],
        },
    ],
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
  }
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, id, body) 
Updates an existing campaign. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
update(profileId, body) 
Updates an existing campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.changeLogs.html000066400000000000000000000214531300622755700263530ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . changeLogs

Instance Methods

get(profileId, id)

Gets one change log by ID.

list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)

Retrieves a list of change logs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one change log by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Change log ID. (required)

Returns:
  An object of the form:

    { # Describes a change that a user has made to a resource.
    "changeTime": "A String", # Time when the object was modified.
    "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
    "subaccountId": "A String", # Subaccount ID of the modified object.
    "userProfileId": "A String", # ID of the user who modified the object.
    "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
    "newValue": "A String", # New value of the object field.
    "userProfileName": "A String", # User profile name of the user who modified the object.
    "fieldName": "A String", # Field name of the object which changed.
    "oldValue": "A String", # Old value of the object field.
    "action": "A String", # Action which caused the change.
    "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
    "objectType": "A String", # Object type of the change log.
    "id": "A String", # ID of this change log.
    "accountId": "A String", # Account ID of the modified object.
  }
list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None) 
Retrieves a list of change logs.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectType: string, Select only change logs with the specified object type.
    Allowed values
      OBJECT_ACCOUNT - 
      OBJECT_ACCOUNT_BILLING_FEATURE - 
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_ADVERTISER_GROUP - 
      OBJECT_BILLING_ACCOUNT_GROUP - 
      OBJECT_BILLING_FEATURE - 
      OBJECT_BILLING_MINIMUM_FEE - 
      OBJECT_BILLING_PROFILE - 
      OBJECT_CAMPAIGN - 
      OBJECT_CONTENT_CATEGORY - 
      OBJECT_CREATIVE - 
      OBJECT_CREATIVE_ASSET - 
      OBJECT_CREATIVE_BUNDLE - 
      OBJECT_CREATIVE_FIELD - 
      OBJECT_CREATIVE_GROUP - 
      OBJECT_DFA_SITE - 
      OBJECT_EVENT_TAG - 
      OBJECT_FLOODLIGHT_ACTIVITY_GROUP - 
      OBJECT_FLOODLIGHT_ACTVITY - 
      OBJECT_FLOODLIGHT_CONFIGURATION - 
      OBJECT_INSTREAM_CREATIVE - 
      OBJECT_LANDING_PAGE - 
      OBJECT_MEDIA_ORDER - 
      OBJECT_PLACEMENT - 
      OBJECT_PLACEMENT_STRATEGY - 
      OBJECT_PLAYSTORE_LINK - 
      OBJECT_PROVIDED_LIST_CLIENT - 
      OBJECT_RATE_CARD - 
      OBJECT_REMARKETING_LIST - 
      OBJECT_RICHMEDIA_CREATIVE - 
      OBJECT_SD_SITE - 
      OBJECT_SIZE - 
      OBJECT_SUBACCOUNT - 
      OBJECT_TARGETING_TEMPLATE - 
      OBJECT_USER_PROFILE - 
      OBJECT_USER_PROFILE_FILTER - 
      OBJECT_USER_ROLE - 
  maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxResults: integer, Maximum number of results to return.
  action: string, Select only change logs with the specified action.
    Allowed values
      ACTION_ADD - 
      ACTION_ASSIGN - 
      ACTION_ASSOCIATE - 
      ACTION_CREATE - 
      ACTION_DELETE - 
      ACTION_DISABLE - 
      ACTION_EMAIL_TAGS - 
      ACTION_ENABLE - 
      ACTION_LINK - 
      ACTION_MARK_AS_DEFAULT - 
      ACTION_PUSH - 
      ACTION_REMOVE - 
      ACTION_SEND - 
      ACTION_SHARE - 
      ACTION_UNASSIGN - 
      ACTION_UNLINK - 
      ACTION_UPDATE - 
  minChangeTime: string, Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
  userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
  ids: string, Select only change logs with these IDs. (repeated)
  objectIds: string, Select only change logs with these object IDs. (repeated)

Returns:
  An object of the form:

    { # Change Log List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
    "changeLogs": [ # Change log collection.
      { # Describes a change that a user has made to a resource.
        "changeTime": "A String", # Time when the object was modified.
        "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
        "subaccountId": "A String", # Subaccount ID of the modified object.
        "userProfileId": "A String", # ID of the user who modified the object.
        "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
        "newValue": "A String", # New value of the object field.
        "userProfileName": "A String", # User profile name of the user who modified the object.
        "fieldName": "A String", # Field name of the object which changed.
        "oldValue": "A String", # Old value of the object field.
        "action": "A String", # Action which caused the change.
        "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
        "objectType": "A String", # Object type of the change log.
        "id": "A String", # ID of this change log.
        "accountId": "A String", # Account ID of the modified object.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.cities.html000066400000000000000000000061251300622755700255600ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . cities

Instance Methods

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)

Retrieves a list of cities, possibly filtered.

Method Details

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None) 
Retrieves a list of cities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartIds: string, Select only cities with these DART IDs. (repeated)
  namePrefix: string, Select only cities with names starting with this prefix.
  regionDartIds: string, Select only cities from these regions. (repeated)
  countryDartIds: string, Select only cities from these countries. (repeated)

Returns:
  An object of the form:

    { # City List Response
    "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
    "cities": [ # City collection.
      { # Contains information about a city that can be targeted by ads.
        "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
        "countryDartId": "A String", # DART ID of the country to which this city belongs.
        "name": "A String", # Name of this city.
        "countryCode": "A String", # Country code of the country to which this city belongs.
        "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
        "regionCode": "A String", # Region code of the region to which this city belongs.
        "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
        "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
        "regionDartId": "A String", # DART ID of the region to which this city belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.connectionTypes.html000066400000000000000000000061311300622755700274610ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . connectionTypes

Instance Methods

get(profileId, id)

Gets one connection type by ID.

list(profileId)

Retrieves a list of connection types.

Method Details

get(profileId, id) 
Gets one connection type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Connection type ID. (required)

Returns:
  An object of the form:

    { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
    "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
    "id": "A String", # ID of this connection type.
    "name": "A String", # Name of this connection type.
  }
list(profileId) 
Retrieves a list of connection types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Connection Type List Response
    "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
    "connectionTypes": [ # Collection of connection types such as broadband and mobile.
      { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
        "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
        "id": "A String", # ID of this connection type.
        "name": "A String", # Name of this connection type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.contentCategories.html000066400000000000000000000261311300622755700277570ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . contentCategories

Instance Methods

delete(profileId, id)

Deletes an existing content category.

get(profileId, id)

Gets one content category by ID.

insert(profileId, body)

Inserts a new content category.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of content categories, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing content category. This method supports patch semantics.

update(profileId, body)

Updates an existing content category.

Method Details

delete(profileId, id) 
Deletes an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
get(profileId, id) 
Gets one content category by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)

Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of content categories, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only content categories with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Content Category List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
    "contentCategories": [ # Content category collection.
      { # Organizes placements according to the contents of their associated webpages.
          "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
          "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
          "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
          "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing content category. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.countries.html000066400000000000000000000062531300622755700263150ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . countries

Instance Methods

get(profileId, dartId)

Gets one country by ID.

list(profileId)

Retrieves a list of countries.

Method Details

get(profileId, dartId) 
Gets one country by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Country DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about a country that can be targeted by ads.
    "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
    "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
    "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
    "countryCode": "A String", # Country code.
    "name": "A String", # Name of this country.
  }
list(profileId) 
Retrieves a list of countries.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Country List Response
    "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
    "countries": [ # Country collection.
      { # Contains information about a country that can be targeted by ads.
        "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
        "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
        "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
        "countryCode": "A String", # Country code.
        "name": "A String", # Name of this country.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.creativeAssets.html000066400000000000000000000172501300622755700272660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeAssets

Instance Methods

insert(profileId, advertiserId, body=None, media_body=None)

Inserts a new creative asset.

Method Details

insert(profileId, advertiserId, body=None, media_body=None) 
Inserts a new creative asset.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
  body: object, The request body.
    The object takes the form of:

{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
    "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
        # 
        # Possible values are:
        # - "ADMOB_REFERENCED"
        # - "ASSET_FORMAT_UNSUPPORTED_DCM"
        # - "ASSET_INVALID"
        # - "CLICK_TAG_HARD_CODED"
        # - "CLICK_TAG_INVALID"
        # - "CLICK_TAG_IN_GWD"
        # - "CLICK_TAG_MISSING"
        # - "CLICK_TAG_MORE_THAN_ONE"
        # - "CLICK_TAG_NON_TOP_LEVEL"
        # - "COMPONENT_UNSUPPORTED_DCM"
        # - "ENABLER_UNSUPPORTED_METHOD_DCM"
        # - "EXTERNAL_FILE_REFERENCED"
        # - "FILE_DETAIL_EMPTY"
        # - "FILE_TYPE_INVALID"
        # - "GWD_PROPERTIES_INVALID"
        # - "HTML5_FEATURE_UNSUPPORTED"
        # - "LINKED_FILE_NOT_FOUND"
        # - "MAX_FLASH_VERSION_11"
        # - "MRAID_REFERENCED"
        # - "NOT_SSL_COMPLIANT"
        # - "ORPHANED_ASSET"
        # - "PRIMARY_HTML_MISSING"
        # - "SVG_INVALID"
        # - "ZIP_INVALID"
      "A String",
    ],
    "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
      "A String",
    ],
    "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
    "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
      "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
      "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
    },
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
      "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
          #
          # Possible values are:
          # - "ADMOB_REFERENCED"
          # - "ASSET_FORMAT_UNSUPPORTED_DCM"
          # - "ASSET_INVALID"
          # - "CLICK_TAG_HARD_CODED"
          # - "CLICK_TAG_INVALID"
          # - "CLICK_TAG_IN_GWD"
          # - "CLICK_TAG_MISSING"
          # - "CLICK_TAG_MORE_THAN_ONE"
          # - "CLICK_TAG_NON_TOP_LEVEL"
          # - "COMPONENT_UNSUPPORTED_DCM"
          # - "ENABLER_UNSUPPORTED_METHOD_DCM"
          # - "EXTERNAL_FILE_REFERENCED"
          # - "FILE_DETAIL_EMPTY"
          # - "FILE_TYPE_INVALID"
          # - "GWD_PROPERTIES_INVALID"
          # - "HTML5_FEATURE_UNSUPPORTED"
          # - "LINKED_FILE_NOT_FOUND"
          # - "MAX_FLASH_VERSION_11"
          # - "MRAID_REFERENCED"
          # - "NOT_SSL_COMPLIANT"
          # - "ORPHANED_ASSET"
          # - "PRIMARY_HTML_MISSING"
          # - "SVG_INVALID"
          # - "ZIP_INVALID"
        "A String",
      ],
      "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
        "A String",
      ],
      "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
      "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
        "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
        "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.creativeFieldValues.html000066400000000000000000000241561300622755700302320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFieldValues

Instance Methods

delete(profileId, creativeFieldId, id)

Deletes an existing creative field value.

get(profileId, creativeFieldId, id)

Gets one creative field value by ID.

insert(profileId, creativeFieldId, body)

Inserts a new creative field value.

list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)

Retrieves a list of creative field values, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, creativeFieldId, id, body)

Updates an existing creative field value. This method supports patch semantics.

update(profileId, creativeFieldId, body)

Updates an existing creative field value.

Method Details

delete(profileId, creativeFieldId, id) 
Deletes an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
get(profileId, creativeFieldId, id) 
Gets one creative field value by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
insert(profileId, creativeFieldId, body) 
Inserts a new creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves a list of creative field values, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      VALUE - 
  ids: string, Select only creative field values with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field Value List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
    "creativeFieldValues": [ # Creative field value collection.
      { # Contains properties of a creative field value.
          "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
          "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
          "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
        },
    ],
  }
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, creativeFieldId, id, body) 
Updates an existing creative field value. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
update(profileId, creativeFieldId, body) 
Updates an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.creativeFields.html000066400000000000000000000500231300622755700272250ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFields

Instance Methods

delete(profileId, id)

Deletes an existing creative field.

get(profileId, id)

Gets one creative field by ID.

insert(profileId, body)

Inserts a new creative field.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of creative fields, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative field. This method supports patch semantics.

update(profileId, body)

Updates an existing creative field.

Method Details

delete(profileId, id) 
Deletes an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
get(profileId, id) 
Gets one creative field by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of creative fields, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
  ids: string, Select only creative fields with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeFields": [ # Creative field collection.
      { # Contains properties of a creative field.
          "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
          "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
          "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
  }
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, id, body) 
Updates an existing creative field. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.creativeGroups.html000066400000000000000000000541451300622755700273070ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeGroups

Instance Methods

get(profileId, id)

Gets one creative group by ID.

insert(profileId, body)

Inserts a new creative group.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)

Retrieves a list of creative groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative group. This method supports patch semantics.

update(profileId, body)

Updates an existing creative group.

Method Details

get(profileId, id) 
Gets one creative group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None) 
Retrieves a list of creative groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
  groupNumber: integer, Select only creative groups that belong to this subgroup.
  maxResults: integer, Maximum number of results to return.
  ids: string, Select only creative groups with these IDs. (repeated)
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeGroups": [ # Creative group collection.
      { # Contains properties of a creative group.
          "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
          "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
          "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
              # Acceptable values are:
              # - 1
              # - 2
          "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
  }
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, id, body) 
Updates an existing creative group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.creatives.html000066400000000000000000012431761300622755700262770ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creatives

Instance Methods

get(profileId, id)

Gets one creative by ID.

insert(profileId, body)

Inserts a new creative.

list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)

Retrieves a list of creatives, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative. This method supports patch semantics.

update(profileId, body)

Updates an existing creative.

Method Details

get(profileId, id) 
Gets one creative by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
insert(profileId, body) 
Inserts a new creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None) 
Retrieves a list of creatives, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only creatives with this campaign ID.
  advertiserId: string, Select only creatives with this advertiser ID.
  sizeIds: string, Select only creatives with these size IDs. (repeated)
  archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  renderingIds: string, Select only creatives with these rendering IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
  companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
  types: string, Select only creatives with these creative types. (repeated)
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_INPAGE - 
      CUSTOM_INTERSTITIAL - 
      ENHANCED_BANNER - 
      ENHANCED_IMAGE - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      REDIRECT - 
      RICH_MEDIA_EXPANDING - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_INTERSTITIAL_FLOAT - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_MULTI_FLOATING - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR - 
      VPAID_NON_LINEAR - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
  ids: string, Select only creatives with these IDs. (repeated)
  studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)

Returns:
  An object of the form:

    { # Creative List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
    "creatives": [ # Creative collection.
      { # Contains properties of a Creative.
          "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            { # Third-party Tracking URL.
              "url": "A String", # URL for the specified third-party URL type.
              "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
            },
          ],
          "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
          "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
          "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
            "windowHeight": 42, # Height of the window.
            "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
            "windowWidth": 42, # Width of the window.
            "positionOption": "A String", # Position in the browser where the window will open.
            "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
          },
          "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
          "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
          "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
          "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
          "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
          "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
          "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
            { # Creative Field Assignment.
              "creativeFieldId": "A String", # ID of the creative field.
              "creativeFieldValueId": "A String", # ID of the creative field value.
            },
          ],
          "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
          "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
          "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
          "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
            { # Creative Asset.
              "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
              "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
                "A String",
              ],
              "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
              "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
              "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
              "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
              "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
                  # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
                  # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
                  # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
                  # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
                  # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
                  # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
                  # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
                  # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
              "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
              "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
              "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
              "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
              "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
              "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
                "targetType": "A String", # Target type used by the event.
                "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
                "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
                "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                  "showStatusBar": True or False, # Whether to display the browser status bar.
                  "showScrollBar": True or False, # Whether to display the browser scroll bar.
                  "showAddressBar": True or False, # Whether to display the browser address bar.
                  "showMenuBar": True or False, # Whether to display the browser menu bar.
                  "title": "A String", # Title of popup window.
                  "showToolBar": True or False, # Whether to display the browser tool bar.
                  "positionType": "A String", # Popup window position either centered or at specific coordinate.
                  "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                    "top": 42, # Offset distance from top side of an asset or a window.
                    "left": 42, # Offset distance from left side of an asset or a window.
                  },
                  "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                    "width": 42, # Width of this size.
                    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                    "height": 42, # Height of this size.
                  },
                },
                "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
                "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
                "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
                "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
                "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
                "advertiserCustomEventName": "A String", # User-entered name for the event.
              },
              "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
              "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
                "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
                "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
              },
              "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
              "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
            },
          ],
          "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
          "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
          "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
          "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            { # Creative Click Tag.
              "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
              "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
              "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
            },
          ],
          "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "active": True or False, # Whether the creative is active. Applicable to all creative types.
          "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
              #
              # Acceptable values are:
              # - "APP"
              # - "APP_INTERSTITIAL"
              # - "IN_STREAM_VIDEO"
              # - "DISPLAY"
              # - "DISPLAY_INTERSTITIAL"
            "A String",
          ],
          "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
          "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
          "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
          "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
          "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
          "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
          "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            "A String",
          ],
          "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
          "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
            "A String",
          ],
          "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "customHtml": "A String", # User-entered value.
            "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
          },
          "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        },
    ],
  }
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, id, body) 
Updates an existing creative. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
update(profileId, body) 
Updates an existing creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.dimensionValues.html000066400000000000000000000115331300622755700274440ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dimensionValues

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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.directorySiteContacts.html000066400000000000000000000142361300622755700306320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySiteContacts

Instance Methods

get(profileId, id)

Gets one directory site contact by ID.

list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of directory site contacts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site contact by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site contact ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Site Directory contact.
    "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
    "firstName": "A String", # First name of this directory site contact.
    "title": "A String", # Title or designation of this directory site contact.
    "lastName": "A String", # Last name of this directory site contact.
    "email": "A String", # Email address of this directory site contact.
    "phone": "A String", # Phone number of this directory site contact.
    "role": "A String", # Directory site contact role.
    "address": "A String", # Address of this directory site contact.
    "type": "A String", # Directory site contact type.
    "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
  }
list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of directory site contacts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
  directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory site contacts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Directory Site Contact List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "directorySiteContacts": [ # Directory site contact collection
      { # Contains properties of a Site Directory contact.
        "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
        "firstName": "A String", # First name of this directory site contact.
        "title": "A String", # Title or designation of this directory site contact.
        "lastName": "A String", # Last name of this directory site contact.
        "email": "A String", # Email address of this directory site contact.
        "phone": "A String", # Phone number of this directory site contact.
        "role": "A String", # Directory site contact role.
        "address": "A String", # Address of this directory site contact.
        "type": "A String", # Directory site contact type.
        "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
      },
    ],
    "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.directorySites.html000066400000000000000000000667611300622755700273300ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySites

Instance Methods

get(profileId, id)

Gets one directory site by ID.

insert(profileId, body)

Inserts a new directory site.

list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)

Retrieves a list of directory sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site ID. (required)

Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
insert(profileId, body) 
Inserts a new directory site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
    "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
    "countryId": "A String", # Country ID of this directory site.
    "description": "A String", # Description of this directory site.
    "settings": { # Directory Site Settings # Directory site settings.
      "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
      "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
      "dfp_settings": { # DFP Settings # Directory site DFP settings.
        "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
        "dfp_network_name": "A String", # DFP network name for this directory site.
        "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
        "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
        "dfp_network_code": "A String", # DFP network code for this directory site.
      },
      "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
      "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
      "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
      "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
    },
    "currencyId": "A String", # Currency ID of this directory site.
        # Possible values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "inpageTagFormats": [ # Tag types for regular placements.
        # 
        # Acceptable values are:
        # - "STANDARD"
        # - "IFRAME_JAVASCRIPT_INPAGE"
        # - "INTERNAL_REDIRECT_INPAGE"
        # - "JAVASCRIPT_INPAGE"
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "interstitialTagFormats": [ # Tag types for interstitial placements.
        # 
        # Acceptable values are:
        # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
        # - "INTERNAL_REDIRECT_INTERSTITIAL"
        # - "JAVASCRIPT_INTERSTITIAL"
      "A String",
    ],
    "contactAssignments": [ # Directory site contacts.
      { # Directory Site Contact Assignment
        "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
        "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
      },
    ],
    "url": "A String", # URL of this directory site.
    "parentId": "A String", # Parent directory site ID.
    "active": True or False, # Whether this directory site is active.
    "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
    "name": "A String", # Name of this directory site.
  }


Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None) 
Retrieves a list of directory sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  countryId: string, Select only directory sites with this country ID.
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  parentId: string, Select only directory sites with this parent ID.
  acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
  searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory sites with these IDs. (repeated)
  dfp_network_code: string, Select only directory sites with this DFP network code.

Returns:
  An object of the form:

    { # Directory Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
    "directorySites": [ # Directory site collection.
      { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
          "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
          "countryId": "A String", # Country ID of this directory site.
          "description": "A String", # Description of this directory site.
          "settings": { # Directory Site Settings # Directory site settings.
            "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
            "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
            "dfp_settings": { # DFP Settings # Directory site DFP settings.
              "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
              "dfp_network_name": "A String", # DFP network name for this directory site.
              "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
              "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
              "dfp_network_code": "A String", # DFP network code for this directory site.
            },
            "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
            "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
            "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
            "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
          },
          "currencyId": "A String", # Currency ID of this directory site.
              # Possible values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "inpageTagFormats": [ # Tag types for regular placements.
              #
              # Acceptable values are:
              # - "STANDARD"
              # - "IFRAME_JAVASCRIPT_INPAGE"
              # - "INTERNAL_REDIRECT_INPAGE"
              # - "JAVASCRIPT_INPAGE"
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "interstitialTagFormats": [ # Tag types for interstitial placements.
              #
              # Acceptable values are:
              # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
              # - "INTERNAL_REDIRECT_INTERSTITIAL"
              # - "JAVASCRIPT_INTERSTITIAL"
            "A String",
          ],
          "contactAssignments": [ # Directory site contacts.
            { # Directory Site Contact Assignment
              "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
              "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
            },
          ],
          "url": "A String", # URL of this directory site.
          "parentId": "A String", # Parent directory site ID.
          "active": True or False, # Whether this directory site is active.
          "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
          "name": "A String", # Name of this directory site.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.eventTags.html000066400000000000000000001223761300622755700262470ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . eventTags

Instance Methods

delete(profileId, id)

Deletes an existing event tag.

get(profileId, id)

Gets one event tag by ID.

insert(profileId, body)

Inserts a new event tag.

list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)

Retrieves a list of event tags, possibly filtered.

patch(profileId, id, body)

Updates an existing event tag. This method supports patch semantics.

update(profileId, body)

Updates an existing event tag.

Method Details

delete(profileId, id) 
Deletes an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
get(profileId, id) 
Gets one event tag by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)

Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None) 
Retrieves a list of event tags, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only event tags that belong to this campaign.
  advertiserId: string, Select only event tags that belong to this advertiser.
  adId: string, Select only event tags that belong to this ad.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  definitionsOnly: boolean, Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
  eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
    Allowed values
      CLICK_THROUGH_EVENT_TAG - 
      IMPRESSION_IMAGE_EVENT_TAG - 
      IMPRESSION_JAVASCRIPT_EVENT_TAG - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  enabled: boolean, Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
  ids: string, Select only event tags with these IDs. (repeated)

Returns:
  An object of the form:

    { # Event Tag List Response
    "eventTags": [ # Event tag collection.
      { # Contains properties of an event tag.
          "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
          "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
          "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
          "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
          "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
          "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
          "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
          "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
          "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
          "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
            "A String",
          ],
          "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
          "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
          "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
  }
patch(profileId, id, body) 
Updates an existing event tag. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.files.html000066400000000000000000000177121300622755700254060ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.floodlightActivities.html000066400000000000000000002332701300622755700304630ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivities

Instance Methods

delete(profileId, id)

Deletes an existing floodlight activity.

generatetag(profileId, floodlightActivityId=None)

Generates a tag for a floodlight activity.

get(profileId, id)

Gets one floodlight activity by ID.

insert(profileId, body)

Inserts a new floodlight activity.

list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)

Retrieves a list of floodlight activities, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity.

Method Details

delete(profileId, id) 
Deletes an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
generatetag(profileId, floodlightActivityId=None) 
Generates a tag for a floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.

Returns:
  An object of the form:

    { # Floodlight Activity GenerateTag Response
    "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
    "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
  }
get(profileId, id) 
Gets one floodlight activity by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
insert(profileId, body) 
Inserts a new floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None) 
Retrieves a list of floodlight activities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
  advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  tagString: string, Select only floodlight activities with the specified tag string.
  floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
  floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
  floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
    "floodlightActivities": [ # Floodlight activity collection.
      { # Contains properties of a Floodlight activity.
          "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
          "secure": True or False, # Whether this tag should use SSL.
          "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
          "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
          "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
          "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
          "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
          "publisherTags": [ # Publisher dynamic floodlight tags.
            { # Publisher Dynamic Tag
              "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
              "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
              "siteId": "A String", # Site ID of this dynamic tag.
              "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
                "tag": "A String", # Tag code.
                "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
                "name": "A String", # Name of this tag.
              },
              "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
              "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            },
          ],
          "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "hidden": True or False, # Whether this activity is archived.
          "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
          "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
          "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
          "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
          "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
          "notes": "A String", # General notes or implementation instructions for the tag.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
          "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
              # Acceptable values are:
              # - "U1"
              # - "U2"
              # - "U3"
              # - "U4"
              # - "U5"
              # - "U6"
              # - "U7"
              # - "U8"
              # - "U9"
              # - "U10"
              # - "U11"
              # - "U12"
              # - "U13"
              # - "U14"
              # - "U15"
              # - "U16"
              # - "U17"
              # - "U18"
              # - "U19"
              # - "U20"
            "A String",
          ],
          "defaultTags": [ # Dynamic floodlight tags.
            { # Dynamic Tag
              "tag": "A String", # Tag code.
              "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
              "name": "A String", # Name of this tag.
            },
          ],
          "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
          "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
update(profileId, body) 
Updates an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.floodlightActivityGroups.html000066400000000000000000001251721300622755700313540ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivityGroups

Instance Methods

get(profileId, id)

Gets one floodlight activity group by ID.

insert(profileId, body)

Inserts a new floodlight activity group.

list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)

Retrieves a list of floodlight activity groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity group. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity group.

Method Details

get(profileId, id) 
Gets one floodlight activity group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None) 
Retrieves a list of floodlight activity groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only floodlight activity groups with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
    "floodlightActivityGroups": [ # Floodlight activity group collection.
      { # Contains properties of a Floodlight activity group.
          "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
          "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.floodlightConfigurations.html000066400000000000000000001153651300622755700313550ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightConfigurations

Instance Methods

get(profileId, id)

Gets one floodlight configuration by ID.

list(profileId, ids=None)

Retrieves a list of floodlight configurations, possibly filtered.

patch(profileId, id, body)

Updates an existing floodlight configuration. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight configuration.

Method Details

get(profileId, id) 
Gets one floodlight configuration by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
list(profileId, ids=None) 
Retrieves a list of floodlight configurations, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)

Returns:
  An object of the form:

    { # Floodlight Configuration List Response
    "floodlightConfigurations": [ # Floodlight configuration collection.
      { # Contains properties of a Floodlight configuration.
          "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
          "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
          "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
            "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
            "imageTagEnabled": True or False, # Whether image tags are enabled.
          },
          "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
          "standardVariableTypes": [ # List of standard variables enabled for this configuration.
              #
              # Acceptable values are:
              # - "ORD"
              # - "NUM"
            "A String",
          ],
          "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
            "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
            "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
          },
          "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
          "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
          "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
          "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
          "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
            { # Third Party Authentication Token
              "name": "A String", # Name of the third-party authentication token.
              "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
            },
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
          "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
            { # User Defined Variable configuration.
              "dataType": "A String", # Data type for the variable. This is a required field.
              "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
              "variableType": "A String", # Variable name in the tag. This is a required field.
            },
          ],
          "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
  }
patch(profileId, id, body) 
Updates an existing floodlight configuration. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight configuration.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.html000066400000000000000000000266411300622755700243060ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API

Instance Methods

accountActiveAdSummaries()

Returns the accountActiveAdSummaries Resource.

accountPermissionGroups()

Returns the accountPermissionGroups Resource.

accountPermissions()

Returns the accountPermissions Resource.

accountUserProfiles()

Returns the accountUserProfiles Resource.

accounts()

Returns the accounts Resource.

ads()

Returns the ads Resource.

advertiserGroups()

Returns the advertiserGroups Resource.

advertisers()

Returns the advertisers Resource.

browsers()

Returns the browsers Resource.

campaignCreativeAssociations()

Returns the campaignCreativeAssociations Resource.

campaigns()

Returns the campaigns Resource.

changeLogs()

Returns the changeLogs Resource.

cities()

Returns the cities Resource.

connectionTypes()

Returns the connectionTypes Resource.

contentCategories()

Returns the contentCategories Resource.

countries()

Returns the countries Resource.

creativeAssets()

Returns the creativeAssets Resource.

creativeFieldValues()

Returns the creativeFieldValues Resource.

creativeFields()

Returns the creativeFields Resource.

creativeGroups()

Returns the creativeGroups Resource.

creatives()

Returns the creatives Resource.

dimensionValues()

Returns the dimensionValues Resource.

directorySiteContacts()

Returns the directorySiteContacts Resource.

directorySites()

Returns the directorySites Resource.

eventTags()

Returns the eventTags Resource.

files()

Returns the files Resource.

floodlightActivities()

Returns the floodlightActivities Resource.

floodlightActivityGroups()

Returns the floodlightActivityGroups Resource.

floodlightConfigurations()

Returns the floodlightConfigurations Resource.

inventoryItems()

Returns the inventoryItems Resource.

landingPages()

Returns the landingPages Resource.

metros()

Returns the metros Resource.

mobileCarriers()

Returns the mobileCarriers Resource.

operatingSystemVersions()

Returns the operatingSystemVersions Resource.

operatingSystems()

Returns the operatingSystems Resource.

orderDocuments()

Returns the orderDocuments Resource.

orders()

Returns the orders Resource.

placementGroups()

Returns the placementGroups Resource.

placementStrategies()

Returns the placementStrategies Resource.

placements()

Returns the placements Resource.

platformTypes()

Returns the platformTypes Resource.

postalCodes()

Returns the postalCodes Resource.

projects()

Returns the projects Resource.

regions()

Returns the regions Resource.

remarketingListShares()

Returns the remarketingListShares Resource.

remarketingLists()

Returns the remarketingLists Resource.

reports()

Returns the reports Resource.

sites()

Returns the sites Resource.

sizes()

Returns the sizes Resource.

subaccounts()

Returns the subaccounts Resource.

targetableRemarketingLists()

Returns the targetableRemarketingLists Resource.

userProfiles()

Returns the userProfiles Resource.

userRolePermissionGroups()

Returns the userRolePermissionGroups Resource.

userRolePermissions()

Returns the userRolePermissions Resource.

userRoles()

Returns the userRoles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.inventoryItems.html000066400000000000000000000316271300622755700273440ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . inventoryItems

Instance Methods

get(profileId, projectId, id)

Gets one inventory item by ID.

list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)

Retrieves a list of inventory items, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one inventory item by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Inventory item ID. (required)

Returns:
  An object of the form:

    { # Represents a buy from the DoubleClick Planning inventory store.
    "orderId": "A String", # Order ID of this inventory item.
    "pricing": { # Pricing Information # Pricing of this inventory item.
      "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
      "startDate": "A String", # Start date of this inventory item.
      "endDate": "A String", # End date of this inventory item.
      "pricingType": "A String", # Pricing type of this inventory item.
      "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
        { # Flight
          "rateOrCost": "A String", # Rate or cost of this flight.
          "startDate": "A String", # Inventory item flight start date.
          "units": "A String", # Units of this flight.
          "endDate": "A String", # Inventory item flight end date.
        },
      ],
      "capCostType": "A String", # Cap cost type of this inventory item.
    },
    "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
    "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
    "subaccountId": "A String", # Subaccount ID of this inventory item.
    "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
    "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
    "inPlan": True or False, # Whether this inventory item is in plan.
    "id": "A String", # ID of this inventory item.
    "advertiserId": "A String", # Advertiser ID of this inventory item.
    "siteId": "A String", # ID of the site this inventory item is associated with.
    "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
      { # Ad Slot
        "comment": "A String", # Comment for this ad slot.
        "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
        "name": "A String", # Name of this ad slot.
        "primary": True or False, # Primary ad slot of a roadblock inventory item.
        "height": "A String", # Height of this ad slot.
        "width": "A String", # Width of this ad slot.
        "paymentSourceType": "A String", # Payment source type of this ad slot.
        "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
      },
    ],
    "projectId": "A String", # Project ID of this inventory item.
    "rfpId": "A String", # RFP ID of this inventory item.
    "type": "A String", # Type of inventory item.
    "contentCategoryId": "A String", # Content category ID of this inventory item.
    "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
    "accountId": "A String", # Account ID of this inventory item.
  }
list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None) 
Retrieves a list of inventory items, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  inPlan: boolean, Select only inventory items that are in plan.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only inventory items with this type.
    Allowed values
      PLANNING_PLACEMENT_TYPE_CREDIT - 
      PLANNING_PLACEMENT_TYPE_REGULAR - 
  orderId: string, Select only inventory items that belong to specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only inventory items that are associated with these sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only inventory items with these IDs. (repeated)

Returns:
  An object of the form:

    { # Inventory item List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#inventoryItemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
    "inventoryItems": [ # Inventory item collection
      { # Represents a buy from the DoubleClick Planning inventory store.
        "orderId": "A String", # Order ID of this inventory item.
        "pricing": { # Pricing Information # Pricing of this inventory item.
          "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
          "startDate": "A String", # Start date of this inventory item.
          "endDate": "A String", # End date of this inventory item.
          "pricingType": "A String", # Pricing type of this inventory item.
          "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
            { # Flight
              "rateOrCost": "A String", # Rate or cost of this flight.
              "startDate": "A String", # Inventory item flight start date.
              "units": "A String", # Units of this flight.
              "endDate": "A String", # Inventory item flight end date.
            },
          ],
          "capCostType": "A String", # Cap cost type of this inventory item.
        },
        "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
        "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
        "subaccountId": "A String", # Subaccount ID of this inventory item.
        "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
        "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
        "inPlan": True or False, # Whether this inventory item is in plan.
        "id": "A String", # ID of this inventory item.
        "advertiserId": "A String", # Advertiser ID of this inventory item.
        "siteId": "A String", # ID of the site this inventory item is associated with.
        "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
          { # Ad Slot
            "comment": "A String", # Comment for this ad slot.
            "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
            "name": "A String", # Name of this ad slot.
            "primary": True or False, # Primary ad slot of a roadblock inventory item.
            "height": "A String", # Height of this ad slot.
            "width": "A String", # Width of this ad slot.
            "paymentSourceType": "A String", # Payment source type of this ad slot.
            "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
          },
        ],
        "projectId": "A String", # Project ID of this inventory item.
        "rfpId": "A String", # RFP ID of this inventory item.
        "type": "A String", # Type of inventory item.
        "contentCategoryId": "A String", # Content category ID of this inventory item.
        "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
        "accountId": "A String", # Account ID of this inventory item.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.landingPages.html000066400000000000000000000262211300622755700266730ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . landingPages

Instance Methods

delete(profileId, campaignId, id)

Deletes an existing campaign landing page.

get(profileId, campaignId, id)

Gets one campaign landing page by ID.

insert(profileId, campaignId, body)

Inserts a new landing page for the specified campaign.

list(profileId, campaignId)

Retrieves the list of landing pages for the specified campaign.

patch(profileId, campaignId, id, body)

Updates an existing campaign landing page. This method supports patch semantics.

update(profileId, campaignId, body)

Updates an existing campaign landing page.

Method Details

delete(profileId, campaignId, id) 
Deletes an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
get(profileId, campaignId, id) 
Gets one campaign landing page by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)

Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
insert(profileId, campaignId, body) 
Inserts a new landing page for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
list(profileId, campaignId) 
Retrieves the list of landing pages for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)

Returns:
  An object of the form:

    { # Landing Page List Response
    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
    "landingPages": [ # Landing page collection
      { # Contains information about where a user's browser is taken after the user clicks an ad.
          "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
          "url": "A String", # URL of this landing page. This is a required field.
          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
        },
    ],
  }
patch(profileId, campaignId, id, body) 
Updates an existing campaign landing page. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
update(profileId, campaignId, body) 
Updates an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.metros.html000066400000000000000000000047421300622755700256140ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . metros

Instance Methods

list(profileId)

Retrieves a list of metros.

Method Details

list(profileId) 
Retrieves a list of metros.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Metro List Response
    "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
    "metros": [ # Metro collection.
      { # Contains information about a metro region that can be targeted by ads.
        "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
        "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
        "name": "A String", # Name of this metro region.
        "countryCode": "A String", # Country code of the country to which this metro region belongs.
        "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
        "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
        "dartId": "A String", # DART ID of this metro region.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.mobileCarriers.html000066400000000000000000000064101300622755700272370ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . mobileCarriers

Instance Methods

get(profileId, id)

Gets one mobile carrier by ID.

list(profileId)

Retrieves a list of mobile carriers.

Method Details

get(profileId, id) 
Gets one mobile carrier by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Mobile carrier ID. (required)

Returns:
  An object of the form:

    { # Contains information about a mobile carrier that can be targeted by ads.
    "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
    "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
    "id": "A String", # ID of this mobile carrier.
    "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
    "name": "A String", # Name of this mobile carrier.
  }
list(profileId) 
Retrieves a list of mobile carriers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Mobile Carrier List Response
    "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
    "mobileCarriers": [ # Mobile carrier collection.
      { # Contains information about a mobile carrier that can be targeted by ads.
        "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
        "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
        "id": "A String", # ID of this mobile carrier.
        "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
        "name": "A String", # Name of this mobile carrier.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.operatingSystemVersions.html000066400000000000000000000114331300622755700312240ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystemVersions

Instance Methods

get(profileId, id)

Gets one operating system version by ID.

list(profileId)

Retrieves a list of operating system versions.

Method Details

get(profileId, id) 
Gets one operating system version by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Operating system version ID. (required)

Returns:
  An object of the form:

    { # Contains information about a particular version of an operating system that can be targeted by ads.
    "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
    "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
    "name": "A String", # Name of this operating system version.
    "id": "A String", # ID of this operating system version.
    "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
      "mobile": True or False, # Whether this operating system is for mobile.
      "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
      "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
      "name": "A String", # Name of this operating system.
      "desktop": True or False, # Whether this operating system is for desktop.
    },
    "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
  }
list(profileId) 
Retrieves a list of operating system versions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System Version List Response
    "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
    "operatingSystemVersions": [ # Operating system version collection.
      { # Contains information about a particular version of an operating system that can be targeted by ads.
        "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
        "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
        "name": "A String", # Name of this operating system version.
        "id": "A String", # ID of this operating system version.
        "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
        "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.operatingSystems.html000066400000000000000000000065271300622755700276660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystems

Instance Methods

get(profileId, dartId)

Gets one operating system by DART ID.

list(profileId)

Retrieves a list of operating systems.

Method Details

get(profileId, dartId) 
Gets one operating system by DART ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Operating system DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about an operating system that can be targeted by ads.
    "mobile": True or False, # Whether this operating system is for mobile.
    "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
    "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
    "name": "A String", # Name of this operating system.
    "desktop": True or False, # Whether this operating system is for desktop.
  }
list(profileId) 
Retrieves a list of operating systems.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System List Response
    "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
    "operatingSystems": [ # Operating system collection.
      { # Contains information about an operating system that can be targeted by ads.
        "mobile": True or False, # Whether this operating system is for mobile.
        "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
        "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
        "name": "A String", # Name of this operating system.
        "desktop": True or False, # Whether this operating system is for desktop.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.orderDocuments.html000066400000000000000000000200461300622755700272730ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orderDocuments

Instance Methods

get(profileId, projectId, id)

Gets one order document by ID.

list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)

Retrieves a list of order documents, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order document by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Order document ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning order document.
    "orderId": "A String", # ID of the order from which this order document is created.
    "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
      "A String",
    ],
    "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
    "subaccountId": "A String", # Subaccount ID of this order document.
    "effectiveDate": "A String", # Effective date of this order document.
    "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
    "lastSentRecipients": [ # List of email addresses that received the last sent document.
      "A String",
    ],
    "title": "A String", # Title of this order document.
    "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
    "signed": True or False, # Whether this order document has been signed.
    "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "advertiserId": "A String", # Advertiser ID of this order document.
    "projectId": "A String", # Project ID of this order document.
    "cancelled": True or False, # Whether this order document is cancelled.
    "type": "A String", # Type of this order document
    "id": "A String", # ID of this order document.
    "accountId": "A String", # Account ID of this order document.
  }
list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None) 
Retrieves a list of order documents, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  orderId: string, Select only order documents for specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only order documents that are associated with these sites. (repeated)
  approved: boolean, Select only order documents that have been approved by at least one user.
  searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only order documents with these IDs. (repeated)

Returns:
  An object of the form:

    { # Order document List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#orderDocumentsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
    "orderDocuments": [ # Order document collection
      { # Contains properties of a DoubleClick Planning order document.
        "orderId": "A String", # ID of the order from which this order document is created.
        "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
          "A String",
        ],
        "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
        "subaccountId": "A String", # Subaccount ID of this order document.
        "effectiveDate": "A String", # Effective date of this order document.
        "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
        "lastSentRecipients": [ # List of email addresses that received the last sent document.
          "A String",
        ],
        "title": "A String", # Title of this order document.
        "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
        "signed": True or False, # Whether this order document has been signed.
        "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "advertiserId": "A String", # Advertiser ID of this order document.
        "projectId": "A String", # Project ID of this order document.
        "cancelled": True or False, # Whether this order document is cancelled.
        "type": "A String", # Type of this order document
        "id": "A String", # ID of this order document.
        "accountId": "A String", # Account ID of this order document.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.orders.html000066400000000000000000000213671300622755700256030ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orders

Instance Methods

get(profileId, projectId, id)

Gets one order by ID.

list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)

Retrieves a list of orders, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  id: string, Order ID. (required)

Returns:
  An object of the form:

    { # Describes properties of a DoubleClick Planning order.
    "termsAndConditions": "A String", # Terms and conditions of this order.
    "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
    "sellerOrganizationName": "A String", # Name of the seller organization.
    "subaccountId": "A String", # Subaccount ID of this order.
    "name": "A String", # Name of this order.
    "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "notes": "A String", # Notes of this order.
    "contacts": [ # Contacts for this order.
      { # Contact of an order.
        "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
        "contactTitle": "A String", # Title of this contact.
        "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
        "contactName": "A String", # Name of this contact.
        "contactType": "A String", # Type of this contact.
      },
    ],
    "buyerOrganizationName": "A String", # Name of the buyer organization.
    "comments": "A String", # Comments in this order.
    "advertiserId": "A String", # Advertiser ID of this order.
    "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
      "A String",
    ],
    "siteId": [ # Site IDs this order is associated with.
      "A String",
    ],
    "sellerOrderId": "A String", # Seller order ID associated with this order.
    "projectId": "A String", # Project ID of this order.
    "siteNames": [ # Free-form site names this order is associated with.
      "A String",
    ],
    "planningTermId": "A String", # ID of the terms and conditions template used in this order.
    "id": "A String", # ID of this order. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this order.
  }
list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None) 
Retrieves a list of orders, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only orders with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  siteId: string, Select only orders that are associated with these site IDs. (repeated)

Returns:
  An object of the form:

    { # Order List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
    "orders": [ # Order collection.
      { # Describes properties of a DoubleClick Planning order.
        "termsAndConditions": "A String", # Terms and conditions of this order.
        "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
        "sellerOrganizationName": "A String", # Name of the seller organization.
        "subaccountId": "A String", # Subaccount ID of this order.
        "name": "A String", # Name of this order.
        "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "notes": "A String", # Notes of this order.
        "contacts": [ # Contacts for this order.
          { # Contact of an order.
            "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
            "contactTitle": "A String", # Title of this contact.
            "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
            "contactName": "A String", # Name of this contact.
            "contactType": "A String", # Type of this contact.
          },
        ],
        "buyerOrganizationName": "A String", # Name of the buyer organization.
        "comments": "A String", # Comments in this order.
        "advertiserId": "A String", # Advertiser ID of this order.
        "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
          "A String",
        ],
        "siteId": [ # Site IDs this order is associated with.
          "A String",
        ],
        "sellerOrderId": "A String", # Seller order ID associated with this order.
        "projectId": "A String", # Project ID of this order.
        "siteNames": [ # Free-form site names this order is associated with.
          "A String",
        ],
        "planningTermId": "A String", # ID of the terms and conditions template used in this order.
        "id": "A String", # ID of this order. This is a read-only, auto-generated field.
        "accountId": "A String", # Account ID of this order.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.placementGroups.html000066400000000000000000003050101300622755700274430ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementGroups

Instance Methods

get(profileId, id)

Gets one placement group by ID.

insert(profileId, body)

Inserts a new placement group.

list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)

Retrieves a list of placement groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement group. This method supports patch semantics.

update(profileId, body)

Updates an existing placement group.

Method Details

get(profileId, id) 
Gets one placement group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None) 
Retrieves a list of placement groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placement groups that are associated with these sites. (repeated)
  placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
    Allowed values
      PLACEMENT_PACKAGE - 
      PLACEMENT_ROADBLOCK - 
  pricingTypes: string, Select only placement groups with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
  ids: string, Select only placement groups with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Placement Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
    "placementGroups": [ # Placement group collection.
      { # Contains properties of a package or roadblock.
          "comment": "A String", # Comments for this placement group.
          "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
          "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
          "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this placement group is archived.
          "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
            "A String",
          ],
          "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
          "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
          "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.placementStrategies.html000066400000000000000000000257571300622755700303170ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementStrategies

Instance Methods

delete(profileId, id)

Deletes an existing placement strategy.

get(profileId, id)

Gets one placement strategy by ID.

insert(profileId, body)

Inserts a new placement strategy.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of placement strategies, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement strategy. This method supports patch semantics.

update(profileId, body)

Updates an existing placement strategy.

Method Details

delete(profileId, id) 
Deletes an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
get(profileId, id) 
Gets one placement strategy by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of placement strategies, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placement strategies with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Placement Strategy List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
    "placementStrategies": [ # Placement strategy collection.
      { # Contains properties of a placement strategy.
          "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
          "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
          "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
          "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing placement strategy. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.placements.html000066400000000000000000004054451300622755700264430ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placements

Instance Methods

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)

Generates tags for a placement.

get(profileId, id)

Gets one placement by ID.

insert(profileId, body)

Inserts a new placement.

list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)

Retrieves a list of placements, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement. This method supports patch semantics.

update(profileId, body)

Updates an existing placement.

Method Details

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None) 
Generates tags for a placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Generate placements belonging to this campaign. This is a required field.
  tagFormats: string, Tag formats to generate for these placements. (repeated)
    Allowed values
      PLACEMENT_TAG_CLICK_COMMANDS - 
      PLACEMENT_TAG_IFRAME_ILAYER - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 - 
      PLACEMENT_TAG_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_JAVASCRIPT - 
      PLACEMENT_TAG_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_STANDARD - 
      PLACEMENT_TAG_TRACKING - 
      PLACEMENT_TAG_TRACKING_IFRAME - 
      PLACEMENT_TAG_TRACKING_JAVASCRIPT - 
  placementIds: string, Generate tags for these placements. (repeated)

Returns:
  An object of the form:

    { # Placement GenerateTags Response
    "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
    "placementTags": [ # Set of generated tags for the specified placements.
      { # Placement Tag
        "tagDatas": [ # Tags generated for this placement.
          { # Placement Tag Data
            "clickTag": "A String", # Tag string to record a click.
            "impressionTag": "A String", # Tag string for serving an ad.
            "creativeId": "A String", # Creative associated with this placement tag.
            "adId": "A String", # Ad associated with this placement tag.
            "format": "A String", # TagData tag format of this tag.
          },
        ],
        "placementId": "A String", # Placement ID
      },
    ],
  }
get(profileId, id) 
Gets one placement by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None) 
Retrieves a list of placements, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placements that are associated with these sites. (repeated)
  paymentSource: string, Select only placements with this payment source.
    Allowed values
      PLACEMENT_AGENCY_PAID - 
      PLACEMENT_PUBLISHER_PAID - 
  pricingTypes: string, Select only placements with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placements that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
  sizeIds: string, Select only placements that are associated with these sizes. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placements with these IDs. (repeated)
  groupIds: string, Select only placements that belong to these placement groups. (repeated)

Returns:
  An object of the form:

    { # Placement List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
    "placements": [ # Placement collection.
      { # Contains properties of a placement.
          "comment": "A String", # Comments for this placement.
          "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
          "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
          "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement. This field can be left blank.
          "archived": True or False, # Whether this placement is archived.
          "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
              # Acceptable values are:
              # - "PLACEMENT_TAG_STANDARD"
              # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_IFRAME_ILAYER"
              # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
              # - "PLACEMENT_TAG_CLICK_COMMANDS"
              # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
              # - "PLACEMENT_TAG_TRACKING"
              # - "PLACEMENT_TAG_TRACKING_IFRAME"
              # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
            "A String",
          ],
          "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
          "tagSetting": { # Tag Settings # Tag settings for this placement.
            "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
            "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
            "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
            "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
          },
          "contentCategoryId": "A String", # ID of the content category assigned to this placement.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
          "status": "A String", # Third-party placement status.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
          "placementGroupId": "A String", # ID of this placement's group, if applicable.
          "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
          "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
          "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
          "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.platformTypes.html000066400000000000000000000055441300622755700271550ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . platformTypes

Instance Methods

get(profileId, id)

Gets one platform type by ID.

list(profileId)

Retrieves a list of platform types.

Method Details

get(profileId, id) 
Gets one platform type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Platform type ID. (required)

Returns:
  An object of the form:

    { # Contains information about a platform type that can be targeted by ads.
    "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
    "id": "A String", # ID of this platform type.
    "name": "A String", # Name of this platform type.
  }
list(profileId) 
Retrieves a list of platform types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Platform Type List Response
    "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
    "platformTypes": [ # Platform type collection.
      { # Contains information about a platform type that can be targeted by ads.
        "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
        "id": "A String", # ID of this platform type.
        "name": "A String", # Name of this platform type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.postalCodes.html000066400000000000000000000063561300622755700265660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . postalCodes

Instance Methods

get(profileId, code)

Gets one postal code by ID.

list(profileId)

Retrieves a list of postal codes.

Method Details

get(profileId, code) 
Gets one postal code by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  code: string, Postal code ID. (required)

Returns:
  An object of the form:

    { # Contains information about a postal code that can be targeted by ads.
    "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
    "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
    "code": "A String", # Postal code. This is equivalent to the id field.
    "id": "A String", # ID of this postal code.
    "countryCode": "A String", # Country code of the country to which this postal code belongs.
  }
list(profileId) 
Retrieves a list of postal codes.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Postal Code List Response
    "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
    "postalCodes": [ # Postal code collection.
      { # Contains information about a postal code that can be targeted by ads.
        "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
        "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
        "code": "A String", # Postal code. This is equivalent to the id field.
        "id": "A String", # ID of this postal code.
        "countryCode": "A String", # Country code of the country to which this postal code belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.projects.html000066400000000000000000000177221300622755700261360ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . projects

Instance Methods

get(profileId, id)

Gets one project by ID.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of projects, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one project by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Project ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning project.
    "startDate": "A String", # Start date of the project.
    "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
    "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
    "endDate": "A String", # End date of the project.
    "name": "A String", # Name of this project.
    "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
    "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
    "clientBillingCode": "A String", # Client billing code of this project.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
    "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
    "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
    "advertiserId": "A String", # Advertiser ID of this project.
    "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
    "overview": "A String", # Overview of this project.
    "audienceAgeGroup": "A String", # Audience age group of this project.
    "subaccountId": "A String", # Subaccount ID of this project.
    "audienceGender": "A String", # Audience gender of this project.
    "id": "A String", # ID of this project. This is a read-only, auto-generated field.
    "clientName": "A String", # Name of the project client.
    "accountId": "A String", # Account ID of this project.
  }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of projects, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
  ids: string, Select only projects with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Project List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
    "projects": [ # Project collection.
      { # Contains properties of a DoubleClick Planning project.
        "startDate": "A String", # Start date of the project.
        "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
        "endDate": "A String", # End date of the project.
        "name": "A String", # Name of this project.
        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
        "clientBillingCode": "A String", # Client billing code of this project.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
        "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
        "advertiserId": "A String", # Advertiser ID of this project.
        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
        "overview": "A String", # Overview of this project.
        "audienceAgeGroup": "A String", # Audience age group of this project.
        "subaccountId": "A String", # Subaccount ID of this project.
        "audienceGender": "A String", # Audience gender of this project.
        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
        "clientName": "A String", # Name of the project client.
        "accountId": "A String", # Account ID of this 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.regions.html000066400000000000000000000044071300622755700257470ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . regions

Instance Methods

list(profileId)

Retrieves a list of regions.

Method Details

list(profileId) 
Retrieves a list of regions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Region List Response
    "regions": [ # Region collection.
      { # Contains information about a region that can be targeted by ads.
        "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
        "countryDartId": "A String", # DART ID of the country to which this region belongs.
        "name": "A String", # Name of this region.
        "countryCode": "A String", # Country code of the country to which this region belongs.
        "regionCode": "A String", # Region code.
        "dartId": "A String", # DART ID of this region.
      },
    ],
    "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.remarketingListShares.html000066400000000000000000000146621300622755700306170ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingListShares

Instance Methods

get(profileId, remarketingListId)

Gets one remarketing list share by remarketing list ID.

patch(profileId, remarketingListId, body)

Updates an existing remarketing list share. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list share.

Method Details

get(profileId, remarketingListId) 
Gets one remarketing list share by remarketing list ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
patch(profileId, remarketingListId, body) 
Updates an existing remarketing list share. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
update(profileId, body) 
Updates an existing remarketing list share.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.remarketingLists.html000066400000000000000000001407631300622755700276360ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

insert(profileId, body)

Inserts a new remarketing list.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing remarketing list. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
insert(profileId, body) 
Inserts a new remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "remarketingLists": [ # Remarketing list collection.
      { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
          "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
            "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
            "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
              { # A group clause made up of list population terms representing constraints joined by ORs.
                "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
                  { # Remarketing List Population Rule Term.
                    "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                    "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                    "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                    "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                    "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                  },
                ],
              },
            ],
          },
          "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
          "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
          "description": "A String", # Remarketing list description.
          "listSize": "A String", # Number of users currently in the list. This is a read-only field.
          "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
          "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
          "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
          "listSource": "A String", # Product from which this remarketing list was originated.
          "active": True or False, # Whether this remarketing list is active.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        },
    ],
    "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
  }
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, id, body) 
Updates an existing remarketing list. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
update(profileId, body) 
Updates an existing remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.reports.compatibleFields.html000066400000000000000000001142221300622755700312410ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . compatibleFields

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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.reports.files.html000066400000000000000000000176051300622755700271040ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.reports.html000066400000000000000000007120561300622755700260050ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports

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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
              },
            ],
            "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.
            },
            "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.
              },
            ],
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
          },
          "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
          "subAccountId": "A String", # The subaccount 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.
                # 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. Note:
                # - "DAILY" also requires field "every" to be set.
                # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
                # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
            "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
              "A String",
            ],
          },
          "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              ],
            },
            "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
          },
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
          "fileName": "A String", # The filename used when generating report files for this report.
          "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.
            "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.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          "type": "A String", # The type of the report.
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "accountId": "A String", # The account ID to which this report belongs.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.sites.html000066400000000000000000001641231300622755700254320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sites

Instance Methods

get(profileId, id)

Gets one site by ID.

insert(profileId, body)

Inserts a new site.

list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)

Retrieves a list of sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing site. This method supports patch semantics.

update(profileId, body)

Updates an existing site.

Method Details

get(profileId, id) 
Gets one site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None) 
Retrieves a list of sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
  campaignIds: string, Select only sites with these campaign IDs. (repeated)
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  adWordsSite: boolean, Select only AdWords sites.
  approved: boolean, Select only approved sites.
  searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
  subaccountId: string, Select only sites with this subaccount ID.
  directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only sites with these IDs. (repeated)

Returns:
  An object of the form:

    { # Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
    "sites": [ # Site collection.
      { # Contains properties of a site.
          "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
          "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
          "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteSettings": { # Site Settings # Site-wide settings.
            "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
            "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
            "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
            "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
            "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
              "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
              "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
              "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
              "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
            },
            "creativeSettings": { # Creative Settings # Site-wide creative settings.
              "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
              "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
            },
            "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
          },
          "approved": True or False, # Whether this site is approved.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteContacts": [ # Site contacts.
            { # Site Contact
              "firstName": "A String", # First name of this site contact.
              "title": "A String", # Title or designation of this site contact.
              "lastName": "A String", # Last name of this site contact.
              "address": "A String", # Address of this site contact.
              "email": "A String", # Email address of this site contact. This is a required field.
              "phone": "A String", # Primary phone number of this site contact.
              "contactType": "A String", # Site contact type.
              "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
            },
          ],
          "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this site. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing site. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.sizes.html000066400000000000000000000113601300622755700254320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sizes

Instance Methods

get(profileId, id)

Gets one size by ID.

insert(profileId, body)

Inserts a new size.

list(profileId, iabStandard=None, width=None, ids=None, height=None)

Retrieves a list of sizes, possibly filtered.

Method Details

get(profileId, id) 
Gets one size by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Size ID. (required)

Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
insert(profileId, body) 
Inserts a new size.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents the dimensions of ads, placements, creatives, or creative assets.
  "width": 42, # Width of this size.
  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
  "height": 42, # Height of this size.
}


Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
list(profileId, iabStandard=None, width=None, ids=None, height=None) 
Retrieves a list of sizes, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  iabStandard: boolean, Select only IAB standard sizes.
  width: integer, Select only sizes with this width.
  ids: string, Select only sizes with these IDs. (repeated)
  height: integer, Select only sizes with this height.

Returns:
  An object of the form:

    { # Size List Response
    "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
    "sizes": [ # Size collection.
      { # Represents the dimensions of ads, placements, creatives, or creative assets.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.subaccounts.html000066400000000000000000000261311300622755700266300ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . subaccounts

Instance Methods

get(profileId, id)

Gets one subaccount by ID.

insert(profileId, body)

Inserts a new subaccount.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Gets a list of subaccounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing subaccount. This method supports patch semantics.

update(profileId, body)

Updates an existing subaccount.

Method Details

get(profileId, id) 
Gets one subaccount by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Gets a list of subaccounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only subaccounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Subaccount List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
    "subaccounts": [ # Subaccount collection.
      { # Contains properties of a DCM subaccount.
          "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
          "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
            "A String",
          ],
          "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
          "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
          "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing subaccount. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.targetableRemarketingLists.html000066400000000000000000000232141300622755700316200ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . targetableRemarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of targetable remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
    "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Targetable remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
    "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
    "listSource": "A String", # Product from which this targetable remarketing list was originated.
    "active": True or False, # Whether this targetable remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of targetable remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive targetable remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Targetable remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
    "targetableRemarketingLists": [ # Targetable remarketing list collection.
      { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
        "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
        "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        "description": "A String", # Targetable remarketing list description.
        "listSize": "A String", # Number of users currently in the list. This is a read-only field.
        "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
        "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
        "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
        "listSource": "A String", # Product from which this targetable remarketing list was originated.
        "active": True or False, # Whether this targetable remarketing list is active.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
        "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.userProfiles.html000066400000000000000000000067201300622755700267630ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userProfiles

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.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.userRolePermissionGroups.html000066400000000000000000000060741300622755700313540ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissionGroups

Instance Methods

get(profileId, id)

Gets one user role permission group by ID.

list(profileId)

Gets a list of all supported user role permission groups.

Method Details

get(profileId, id) 
Gets one user role permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission group ID. (required)

Returns:
  An object of the form:

    { # Represents a grouping of related user role permissions.
    "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
    "id": "A String", # ID of this user role permission.
    "name": "A String", # Name of this user role permission group.
  }
list(profileId) 
Gets a list of all supported user role permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # User Role Permission Group List Response
    "userRolePermissionGroups": [ # User role permission group collection.
      { # Represents a grouping of related user role permissions.
        "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
        "id": "A String", # ID of this user role permission.
        "name": "A String", # Name of this user role permission group.
      },
    ],
    "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.userRolePermissions.html000066400000000000000000000066751300622755700303460ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissions

Instance Methods

get(profileId, id)

Gets one user role permission by ID.

list(profileId, ids=None)

Gets a list of user role permissions, possibly filtered.

Method Details

get(profileId, id) 
Gets one user role permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a user role permission.
    "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
    "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
    "availability": "A String", # Levels of availability for a user role permission.
    "name": "A String", # Name of this user role permission.
    "id": "A String", # ID of this user role permission.
  }
list(profileId, ids=None) 
Gets a list of user role permissions, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Select only user role permissions with these IDs. (repeated)

Returns:
  An object of the form:

    { # User Role Permission List Response
    "userRolePermissions": [ # User role permission collection.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_4.userRoles.html000066400000000000000000000523331300622755700262650ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRoles

Instance Methods

delete(profileId, id)

Deletes an existing user role.

get(profileId, id)

Gets one user role by ID.

insert(profileId, body)

Inserts a new user role.

list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)

Retrieves a list of user roles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing user role. This method supports patch semantics.

update(profileId, body)

Updates an existing user role.

Method Details

delete(profileId, id) 
Deletes an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
get(profileId, id) 
Gets one user role by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)

Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None) 
Retrieves a list of user roles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
  subaccountId: string, Select only user roles that belong to this subaccount.
  pageToken: string, Value of the nextPageToken from the previous result page.
  ids: string, Select only user roles with the specified IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # User Role List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
    "userRoles": [ # User role collection.
      { # Contains properties of auser role, which is used to manage user access.
          "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
          "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
          "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
          "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
          "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
          "permissions": [ # List of permissions associated with this user role.
            { # Contains properties of a user role permission.
              "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
              "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
              "availability": "A String", # Levels of availability for a user role permission.
              "name": "A String", # Name of this user role permission.
              "id": "A String", # ID of this user role permission.
            },
          ],
          "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing user role. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.accountActiveAdSummaries.html000066400000000000000000000042261300622755700312240ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountActiveAdSummaries

Instance Methods

get(profileId, summaryAccountId)

Gets the account's active ad summary by account ID.

Method Details

get(profileId, summaryAccountId) 
Gets the account's active ad summary by account ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  summaryAccountId: string, Account ID. (required)

Returns:
  An object of the form:

    { # Gets a summary of active ads in an account.
    "availableAds": "A String", # Ads that can be activated for the account.
    "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
    "activeAds": "A String", # Ads that have been activated for the account
    "accountId": "A String", # ID of the account.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.accountPermissionGroups.html000066400000000000000000000062671300622755700312150ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissionGroups

Instance Methods

get(profileId, id)

Gets one account permission group by ID.

list(profileId)

Retrieves the list of account permission groups.

Method Details

get(profileId, id) 
Gets one account permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission group ID. (required)

Returns:
  An object of the form:

    { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
    "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
    "id": "A String", # ID of this account permission group.
    "name": "A String", # Name of this account permission group.
  }
list(profileId) 
Retrieves the list of account permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission Group List Response
    "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
    "accountPermissionGroups": [ # Account permission group collection.
      { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
        "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
        "id": "A String", # ID of this account permission group.
        "name": "A String", # Name of this account permission group.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.accountPermissions.html000066400000000000000000000077041300622755700301750ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissions

Instance Methods

get(profileId, id)

Gets one account permission by ID.

list(profileId)

Retrieves the list of account permissions.

Method Details

get(profileId, id) 
Gets one account permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission ID. (required)

Returns:
  An object of the form:

    { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
    "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
    "name": "A String", # Name of this account permission.
    "level": "A String", # Administrative level required to enable this account permission.
    "permissionGroupId": "A String", # Permission group of this account permission.
    "accountProfiles": [ # Account profiles associated with this account permission.
        #
        # Possible values are:
        # - "ACCOUNT_PROFILE_BASIC"
        # - "ACCOUNT_PROFILE_STANDARD"
      "A String",
    ],
    "id": "A String", # ID of this account permission.
  }
list(profileId) 
Retrieves the list of account permissions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission List Response
    "accountPermissions": [ # Account permission collection.
      { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
        "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
        "name": "A String", # Name of this account permission.
        "level": "A String", # Administrative level required to enable this account permission.
        "permissionGroupId": "A String", # Permission group of this account permission.
        "accountProfiles": [ # Account profiles associated with this account permission.
            #
            # Possible values are:
            # - "ACCOUNT_PROFILE_BASIC"
            # - "ACCOUNT_PROFILE_STANDARD"
          "A String",
        ],
        "id": "A String", # ID of this account permission.
      },
    ],
    "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.accountUserProfiles.html000066400000000000000000001271001300622755700302750ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountUserProfiles

Instance Methods

get(profileId, id)

Gets one account user profile by ID.

insert(profileId, body)

Inserts a new account user profile.

list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)

Retrieves a list of account user profiles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account user profile. This method supports patch semantics.

update(profileId, body)

Updates an existing account user profile.

Method Details

get(profileId, id) 
Gets one account user profile by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)

Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None) 
Retrieves a list of account user profiles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
  subaccountId: string, Select only user profiles with the specified subaccount ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only user profiles with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  userRoleId: string, Select only user profiles with the specified user role ID.
  active: boolean, Select only active user profiles.

Returns:
  An object of the form:

    { # Account User Profile List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "accountUserProfiles": [ # Account user profile collection.
      { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
          "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
          "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
          "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
          "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "locale": "A String", # Locale of the user profile. This is a required field.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "comments": "A String", # Comments for this user profile.
          "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
          "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "userRoleId": "A String", # User role ID of the user profile. This is a required field.
          "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
          "traffickerType": "A String", # Trafficker type of this user profile.
          "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
          "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
          "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
  }
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, id, body) 
Updates an existing account user profile. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.accounts.html000066400000000000000000001147041300622755700261230ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accounts

Instance Methods

get(profileId, id)

Gets one account by ID.

list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)

Retrieves the list of accounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account. This method supports patch semantics.

update(profileId, body)

Updates an existing account.

Method Details

get(profileId, id) 
Gets one account by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None) 
Retrieves the list of accounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only accounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.

Returns:
  An object of the form:

    { # Account List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
    "accounts": [ # Account collection.
      { # Contains properties of a DCM account.
          "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
          "countryId": "A String", # ID of the country associated with this account.
          "availablePermissionIds": [ # User role permissions available to the user roles of this account.
            "A String",
          ],
          "description": "A String", # Description of this account.
          "maximumImageSize": "A String", # Maximum image size allowed for this account.
          "currencyId": "A String", # ID of currency associated with this account. This is a required field.
              # Acceptable values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
          "accountPermissionIds": [ # Account permissions assigned to this account.
            "A String",
          ],
          "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
          "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
          "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
          "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
          "locale": "A String", # Locale of this account.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
          "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
            "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
                # Acceptable values are:
                #
                # - "1" for "America/New_York"
                # - "2" for "Europe/London"
                # - "3" for "Europe/Paris"
                # - "4" for "Africa/Johannesburg"
                # - "5" for "Asia/Jerusalem"
                # - "6" for "Asia/Shanghai"
                # - "7" for "Asia/Hong_Kong"
                # - "8" for "Asia/Tokyo"
                # - "9" for "Australia/Sydney"
                # - "10" for "Asia/Dubai"
                # - "11" for "America/Los_Angeles"
                # - "12" for "Pacific/Auckland"
                # - "13" for "America/Sao_Paulo"
            "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
            "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
          },
          "active": True or False, # Whether this account is active.
          "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
          "id": "A String", # ID of this account. This is a read-only, auto-generated field.
          "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
        },
    ],
  }
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, id, body) 
Updates an existing account. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
update(profileId, body) 
Updates an existing account.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.ads.html000066400000000000000000010523051300622755700250520ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . ads

Instance Methods

get(profileId, id)

Gets one ad by ID.

insert(profileId, body)

Inserts a new ad.

list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)

Retrieves a list of ads, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing ad. This method supports patch semantics.

update(profileId, body)

Updates an existing ad.

Method Details

get(profileId, id) 
Gets one ad by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
insert(profileId, body) 
Inserts a new ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None) 
Retrieves a list of ads, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  landingPageIds: string, Select only ads with these landing page IDs. (repeated)
  overriddenEventTagId: string, Select only ads with this event tag override ID.
  campaignIds: string, Select only ads with these campaign IDs. (repeated)
  sizeIds: string, Select only ads with these size IDs. (repeated)
  archived: boolean, Select only archived ads.
  creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
  sslCompliant: boolean, Select only ads that are SSL-compliant.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only ads with these types. (repeated)
    Allowed values
      AD_SERVING_CLICK_TRACKER - 
      AD_SERVING_DEFAULT_AD - 
      AD_SERVING_STANDARD_AD - 
      AD_SERVING_TRACKING - 
  sslRequired: boolean, Select only ads that require SSL.
  creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
  remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  creativeType: string, Select only ads with the specified creativeType.
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_DISPLAY - 
      CUSTOM_DISPLAY_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_IMAGE_GALLERY - 
      DISPLAY_REDIRECT - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      RICH_MEDIA_DISPLAY_BANNER - 
      RICH_MEDIA_DISPLAY_EXPANDING - 
      RICH_MEDIA_DISPLAY_INTERSTITIAL - 
      RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR_VIDEO - 
      VPAID_NON_LINEAR_VIDEO - 
  placementIds: string, Select only ads with these placement IDs assigned. (repeated)
  active: boolean, Select only active ads.
  compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  advertiserId: string, Select only ads with this advertiser ID.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
  audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
  ids: string, Select only ads with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Returns:
  An object of the form:

    { # Ad List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
    "ads": [ # Ad collection.
      { # Contains properties of a DCM ad.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
          "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
          "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
              { # Contains information about a country that can be targeted by ads.
                "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
                "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
                "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
                "countryCode": "A String", # Country code.
                "name": "A String", # Name of this country.
              },
            ],
            "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
            "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
              { # Contains information about a postal code that can be targeted by ads.
                "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
                "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
                "code": "A String", # Postal code. This is equivalent to the id field.
                "id": "A String", # ID of this postal code.
                "countryCode": "A String", # Country code of the country to which this postal code belongs.
              },
            ],
            "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
              { # Contains information about a region that can be targeted by ads.
                "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
                "countryDartId": "A String", # DART ID of the country to which this region belongs.
                "name": "A String", # Name of this region.
                "countryCode": "A String", # Country code of the country to which this region belongs.
                "regionCode": "A String", # Region code.
                "dartId": "A String", # DART ID of this region.
              },
            ],
            "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
              { # Contains information about a city that can be targeted by ads.
                "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
                "countryDartId": "A String", # DART ID of the country to which this city belongs.
                "name": "A String", # Name of this city.
                "countryCode": "A String", # Country code of the country to which this city belongs.
                "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
                "regionCode": "A String", # Region code of the region to which this city belongs.
                "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
                "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
                "regionDartId": "A String", # DART ID of the region to which this city belongs.
              },
            ],
            "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
              { # Contains information about a metro region that can be targeted by ads.
                "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
                "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
                "name": "A String", # Name of this metro region.
                "countryCode": "A String", # Country code of the country to which this metro region belongs.
                "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
                "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
                "dartId": "A String", # DART ID of this metro region.
              },
            ],
          },
          "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
            "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
            "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
            "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
              "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
              "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
            },
            "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Event tag overrides for this ad.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this ad is archived.
          "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a platform type that can be targeted by ads.
                "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
                "id": "A String", # ID of this platform type.
                "name": "A String", # Name of this platform type.
              },
            ],
            "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
              { # Contains information about a particular version of an operating system that can be targeted by ads.
                "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
                "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
                "name": "A String", # Name of this operating system version.
                "id": "A String", # ID of this operating system version.
                "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
                  "mobile": True or False, # Whether this operating system is for mobile.
                  "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                  "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                  "name": "A String", # Name of this operating system.
                  "desktop": True or False, # Whether this operating system is for desktop.
                },
                "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
              },
            ],
            "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a browser that can be targeted by ads.
                "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
                "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
                "name": "A String", # Name of this browser.
                "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
                "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
                "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
              },
            ],
            "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
              { # Contains information about an operating system that can be targeted by ads.
                "mobile": True or False, # Whether this operating system is for mobile.
                "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                "name": "A String", # Name of this operating system.
                "desktop": True or False, # Whether this operating system is for desktop.
              },
            ],
            "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
              { # Contains information about a mobile carrier that can be targeted by ads.
                "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
                "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
                "id": "A String", # ID of this mobile carrier.
                "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
                "name": "A String", # Name of this mobile carrier.
              },
            ],
            "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
                "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
                "id": "A String", # ID of this connection type.
                "name": "A String", # Name of this connection type.
              },
            ],
          },
          "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
            "creativeAssignments": [ # Creative assignments in this creative rotation.
              { # Creative Assignment.
                "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
                "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
                "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
                "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                    # Applicable when the creative type is any of the following:
                    # - RICH_MEDIA_INPAGE
                    # - RICH_MEDIA_INPAGE_FLOATING
                    # - RICH_MEDIA_IM_EXPAND
                    # - RICH_MEDIA_EXPANDING
                    # - RICH_MEDIA_INTERSTITIAL_FLOAT
                    # - RICH_MEDIA_MOBILE_IN_APP
                    # - RICH_MEDIA_MULTI_FLOATING
                    # - RICH_MEDIA_PEEL_DOWN
                    # - ADVANCED_BANNER
                    # - VPAID_LINEAR
                    # - VPAID_NON_LINEAR
                  { # Rich Media Exit Override.
                    "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                    "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                    "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
                  },
                ],
                "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
                "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
                  { # Creative Group Assignment.
                    "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                    "creativeGroupId": "A String", # ID of the creative group to be assigned.
                  },
                ],
                "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
                  { # Companion Click-through override.
                    "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                    },
                    "creativeId": "A String", # ID of the creative for this companion click-through override.
                  },
                ],
                "startTime": "A String", # Date and time that the assigned creative should start serving.
                "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
                "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
                "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
                "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              },
            ],
            "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
            "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
            "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
          },
          "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "comments": "A String", # Comments for this ad.
          "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Expression describing which lists are being targeted by the ad.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
          "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
          "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Keyword expression being targeted by the ad.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
          "active": True or False, # Whether this ad is active.
          "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
          "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
          "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
          "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
          "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
            "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
              42,
            ],
            "daysOfWeek": [ # Days of the week when the ad will serve.
                #
                # Acceptable values are:
                # - "SUNDAY"
                # - "MONDAY"
                # - "TUESDAY"
                # - "WEDNESDAY"
                # - "THURSDAY"
                # - "FRIDAY"
                # - "SATURDAY"
              "A String",
            ],
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "placementAssignments": [ # Placement assignments for this ad.
            { # Placement Assignment.
              "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
              "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "placementId": "A String", # ID of the placement to be assigned. This is a required field.
              "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
            },
          ],
          "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
          "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
        },
    ],
  }
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, id, body) 
Updates an existing ad. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
update(profileId, body) 
Updates an existing ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.advertiserGroups.html000066400000000000000000000262671300622755700276620ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertiserGroups

Instance Methods

delete(profileId, id)

Deletes an existing advertiser group.

get(profileId, id)

Gets one advertiser group by ID.

insert(profileId, body)

Inserts a new advertiser group.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of advertiser groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser group. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser group.

Method Details

delete(profileId, id) 
Deletes an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
get(profileId, id) 
Gets one advertiser group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of advertiser groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only advertiser groups with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Advertiser Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
    "advertiserGroups": [ # Advertiser group collection.
      { # Groups advertisers together so that reports can be generated for the entire group at once.
          "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
          "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
          "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing advertiser group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.advertisers.html000066400000000000000000001217041300622755700266350ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertisers

Instance Methods

get(profileId, id)

Gets one advertiser by ID.

insert(profileId, body)

Inserts a new advertiser.

list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)

Retrieves a list of advertisers, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser.

Method Details

get(profileId, id) 
Gets one advertiser by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None) 
Retrieves a list of advertisers, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
  onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  status: string, Select only advertisers with the specified status.
    Allowed values
      APPROVED - 
      ON_HOLD - 
  maxResults: integer, Maximum number of results to return.
  advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
  subaccountId: string, Select only advertisers with these subaccount IDs.
  ids: string, Select only advertisers with these IDs. (repeated)
  floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Advertiser List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "advertisers": [ # Advertiser collection.
      { # Contains properties of a DCM advertiser.
          "status": "A String", # Status of this advertiser.
          "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
          "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
          "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
          "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
          "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
          "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
              # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
              # - This advertiser's original floodlight configuration is not already shared with another advertiser.
          "suspended": True or False, # Suspension status of this advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultEmail": "A String", # Default email address used in sender field for tag emails.
          "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
  }
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, id, body) 
Updates an existing advertiser. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.browsers.html000066400000000000000000000065301300622755700261470ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . browsers

Instance Methods

list(profileId)

Retrieves a list of browsers.

Method Details

list(profileId) 
Retrieves a list of browsers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Browser List Response
    "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
    "browsers": [ # Browser collection.
      { # Contains information about a browser that can be targeted by ads.
        "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
        "name": "A String", # Name of this browser.
        "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
        "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
        "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.campaignCreativeAssociations.html000066400000000000000000000120761300622755700321250ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaignCreativeAssociations

Instance Methods

insert(profileId, campaignId, body)

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)

Retrieves the list of creative IDs associated with the specified campaign.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

insert(profileId, campaignId, body) 
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Identifies a creative which has been associated with a given campaign.
    "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
    "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
  }


Returns:
  An object of the form:

    { # Identifies a creative which has been associated with a given campaign.
      "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
      "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
    }
list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves the list of creative IDs associated with the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Campaign Creative Association List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "campaignCreativeAssociations": [ # Campaign creative association collection
      { # Identifies a creative which has been associated with a given campaign.
          "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
          "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
        },
    ],
    "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.campaigns.html000066400000000000000000003133611300622755700262460ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaigns

Instance Methods

get(profileId, id)

Gets one campaign by ID.

insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)

Inserts a new campaign.

list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)

Retrieves a list of campaigns, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing campaign. This method supports patch semantics.

update(profileId, body)

Updates an existing campaign.

Method Details

get(profileId, id) 
Gets one campaign by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body) 
Inserts a new campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
  defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None) 
Retrieves a list of campaigns, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
  archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
  advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  excludedIds: string, Exclude campaigns with these IDs. (repeated)
  advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
  searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
  subaccountId: string, Select only campaigns that belong to this subaccount.
  ids: string, Select only campaigns with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.

Returns:
  An object of the form:

    { # Campaign List Response
    "campaigns": [ # Campaign collection.
      { # Contains properties of a DCM campaign.
          "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
          "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
          "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
            "optimizationActivitys": [ # List of optimization activities associated with this configuration.
              { # Creative optimization activity.
                "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
                "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
              },
            ],
            "optimizationModel": "A String", # Optimization model for this configuration.
            "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
            "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
          },
          "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
          "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
          "traffickerEmails": [ # Campaign trafficker contact emails.
            "A String",
          ],
          "archived": True or False, # Whether this campaign has been archived.
          "externalId": "A String", # External ID for this campaign.
          "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
          "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
          "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
            "A String",
          ],
          "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
            { # Creative optimization settings.
              "optimizationActivitys": [ # List of optimization activities associated with this configuration.
                { # Creative optimization activity.
                  "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                  "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                    "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                  },
                  "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
                },
              ],
              "optimizationModel": "A String", # Optimization model for this configuration.
              "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
              "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
            },
          ],
          "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
          "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
          "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
            { # Audience Segment Group.
              "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
                { # Audience Segment.
                  "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
                  "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
                  "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
                },
              ],
              "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
            },
          ],
        },
    ],
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
  }
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, id, body) 
Updates an existing campaign. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
update(profileId, body) 
Updates an existing campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.changeLogs.html000066400000000000000000000214531300622755700263540ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . changeLogs

Instance Methods

get(profileId, id)

Gets one change log by ID.

list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)

Retrieves a list of change logs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one change log by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Change log ID. (required)

Returns:
  An object of the form:

    { # Describes a change that a user has made to a resource.
    "changeTime": "A String", # Time when the object was modified.
    "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
    "subaccountId": "A String", # Subaccount ID of the modified object.
    "userProfileId": "A String", # ID of the user who modified the object.
    "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
    "newValue": "A String", # New value of the object field.
    "userProfileName": "A String", # User profile name of the user who modified the object.
    "fieldName": "A String", # Field name of the object which changed.
    "oldValue": "A String", # Old value of the object field.
    "action": "A String", # Action which caused the change.
    "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
    "objectType": "A String", # Object type of the change log.
    "id": "A String", # ID of this change log.
    "accountId": "A String", # Account ID of the modified object.
  }
list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None) 
Retrieves a list of change logs.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectType: string, Select only change logs with the specified object type.
    Allowed values
      OBJECT_ACCOUNT - 
      OBJECT_ACCOUNT_BILLING_FEATURE - 
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_ADVERTISER_GROUP - 
      OBJECT_BILLING_ACCOUNT_GROUP - 
      OBJECT_BILLING_FEATURE - 
      OBJECT_BILLING_MINIMUM_FEE - 
      OBJECT_BILLING_PROFILE - 
      OBJECT_CAMPAIGN - 
      OBJECT_CONTENT_CATEGORY - 
      OBJECT_CREATIVE - 
      OBJECT_CREATIVE_ASSET - 
      OBJECT_CREATIVE_BUNDLE - 
      OBJECT_CREATIVE_FIELD - 
      OBJECT_CREATIVE_GROUP - 
      OBJECT_DFA_SITE - 
      OBJECT_EVENT_TAG - 
      OBJECT_FLOODLIGHT_ACTIVITY_GROUP - 
      OBJECT_FLOODLIGHT_ACTVITY - 
      OBJECT_FLOODLIGHT_CONFIGURATION - 
      OBJECT_INSTREAM_CREATIVE - 
      OBJECT_LANDING_PAGE - 
      OBJECT_MEDIA_ORDER - 
      OBJECT_PLACEMENT - 
      OBJECT_PLACEMENT_STRATEGY - 
      OBJECT_PLAYSTORE_LINK - 
      OBJECT_PROVIDED_LIST_CLIENT - 
      OBJECT_RATE_CARD - 
      OBJECT_REMARKETING_LIST - 
      OBJECT_RICHMEDIA_CREATIVE - 
      OBJECT_SD_SITE - 
      OBJECT_SIZE - 
      OBJECT_SUBACCOUNT - 
      OBJECT_TARGETING_TEMPLATE - 
      OBJECT_USER_PROFILE - 
      OBJECT_USER_PROFILE_FILTER - 
      OBJECT_USER_ROLE - 
  maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxResults: integer, Maximum number of results to return.
  action: string, Select only change logs with the specified action.
    Allowed values
      ACTION_ADD - 
      ACTION_ASSIGN - 
      ACTION_ASSOCIATE - 
      ACTION_CREATE - 
      ACTION_DELETE - 
      ACTION_DISABLE - 
      ACTION_EMAIL_TAGS - 
      ACTION_ENABLE - 
      ACTION_LINK - 
      ACTION_MARK_AS_DEFAULT - 
      ACTION_PUSH - 
      ACTION_REMOVE - 
      ACTION_SEND - 
      ACTION_SHARE - 
      ACTION_UNASSIGN - 
      ACTION_UNLINK - 
      ACTION_UPDATE - 
  minChangeTime: string, Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
  userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
  ids: string, Select only change logs with these IDs. (repeated)
  objectIds: string, Select only change logs with these object IDs. (repeated)

Returns:
  An object of the form:

    { # Change Log List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
    "changeLogs": [ # Change log collection.
      { # Describes a change that a user has made to a resource.
        "changeTime": "A String", # Time when the object was modified.
        "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
        "subaccountId": "A String", # Subaccount ID of the modified object.
        "userProfileId": "A String", # ID of the user who modified the object.
        "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
        "newValue": "A String", # New value of the object field.
        "userProfileName": "A String", # User profile name of the user who modified the object.
        "fieldName": "A String", # Field name of the object which changed.
        "oldValue": "A String", # Old value of the object field.
        "action": "A String", # Action which caused the change.
        "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
        "objectType": "A String", # Object type of the change log.
        "id": "A String", # ID of this change log.
        "accountId": "A String", # Account ID of the modified object.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.cities.html000066400000000000000000000061251300622755700255610ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . cities

Instance Methods

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)

Retrieves a list of cities, possibly filtered.

Method Details

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None) 
Retrieves a list of cities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartIds: string, Select only cities with these DART IDs. (repeated)
  namePrefix: string, Select only cities with names starting with this prefix.
  regionDartIds: string, Select only cities from these regions. (repeated)
  countryDartIds: string, Select only cities from these countries. (repeated)

Returns:
  An object of the form:

    { # City List Response
    "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
    "cities": [ # City collection.
      { # Contains information about a city that can be targeted by ads.
        "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
        "countryDartId": "A String", # DART ID of the country to which this city belongs.
        "name": "A String", # Name of this city.
        "countryCode": "A String", # Country code of the country to which this city belongs.
        "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
        "regionCode": "A String", # Region code of the region to which this city belongs.
        "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
        "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
        "regionDartId": "A String", # DART ID of the region to which this city belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.connectionTypes.html000066400000000000000000000061311300622755700274620ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . connectionTypes

Instance Methods

get(profileId, id)

Gets one connection type by ID.

list(profileId)

Retrieves a list of connection types.

Method Details

get(profileId, id) 
Gets one connection type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Connection type ID. (required)

Returns:
  An object of the form:

    { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
    "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
    "id": "A String", # ID of this connection type.
    "name": "A String", # Name of this connection type.
  }
list(profileId) 
Retrieves a list of connection types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Connection Type List Response
    "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
    "connectionTypes": [ # Collection of connection types such as broadband and mobile.
      { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
        "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
        "id": "A String", # ID of this connection type.
        "name": "A String", # Name of this connection type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.contentCategories.html000066400000000000000000000261311300622755700277600ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . contentCategories

Instance Methods

delete(profileId, id)

Deletes an existing content category.

get(profileId, id)

Gets one content category by ID.

insert(profileId, body)

Inserts a new content category.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of content categories, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing content category. This method supports patch semantics.

update(profileId, body)

Updates an existing content category.

Method Details

delete(profileId, id) 
Deletes an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
get(profileId, id) 
Gets one content category by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)

Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of content categories, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only content categories with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Content Category List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
    "contentCategories": [ # Content category collection.
      { # Organizes placements according to the contents of their associated webpages.
          "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
          "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
          "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
          "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing content category. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.conversions.html000066400000000000000000000201651300622755700266510ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . conversions

Instance Methods

batchinsert(profileId, body)

Inserts conversions.

Method Details

batchinsert(profileId, body) 
Inserts conversions.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Insert Conversions Request.
    "conversions": [ # The set of conversions to insert.
      { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
        "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
        "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
        "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
        "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
        "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
        "customVariables": [ # Custom floodlight variables.
          { # A custom floodlight variable.
            "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
            "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
            "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
          },
        ],
        "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
        "value": 3.14, # The value of the conversion.
        "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
        "quantity": "A String", # The quantity of the conversion.
        "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
        "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
      },
    ],
    "kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
    "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
      "kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
      "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
      "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
      "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
    },
  }


Returns:
  An object of the form:

    { # Insert Conversions Response.
    "status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
      { # The original conversion that was inserted or updated and whether there were any errors.
        "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
          "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
          "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
          "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
          "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
          "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
          "customVariables": [ # Custom floodlight variables.
            { # A custom floodlight variable.
              "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
              "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
              "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
            },
          ],
          "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
          "value": 3.14, # The value of the conversion.
          "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
          "quantity": "A String", # The quantity of the conversion.
          "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
          "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
        },
        "errors": [ # A list of errors related to this conversion.
          { # The error code and description for a conversion that failed to insert or update.
            "kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
            "code": "A String", # The error code.
            "message": "A String", # A description of the error.
          },
        ],
        "kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
      },
    ],
    "hasFailures": True or False, # Indicates that some or all conversions failed to insert.
    "kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.countries.html000066400000000000000000000062531300622755700263160ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . countries

Instance Methods

get(profileId, dartId)

Gets one country by ID.

list(profileId)

Retrieves a list of countries.

Method Details

get(profileId, dartId) 
Gets one country by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Country DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about a country that can be targeted by ads.
    "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
    "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
    "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
    "countryCode": "A String", # Country code.
    "name": "A String", # Name of this country.
  }
list(profileId) 
Retrieves a list of countries.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Country List Response
    "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
    "countries": [ # Country collection.
      { # Contains information about a country that can be targeted by ads.
        "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
        "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
        "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
        "countryCode": "A String", # Country code.
        "name": "A String", # Name of this country.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.creativeAssets.html000066400000000000000000000172641300622755700272740ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeAssets

Instance Methods

insert(profileId, advertiserId, body=None, media_body=None)

Inserts a new creative asset.

Method Details

insert(profileId, advertiserId, body=None, media_body=None) 
Inserts a new creative asset.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
  body: object, The request body.
    The object takes the form of:

{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
    "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
        # 
        # Possible values are:
        # - "ADMOB_REFERENCED"
        # - "ASSET_FORMAT_UNSUPPORTED_DCM"
        # - "ASSET_INVALID"
        # - "CLICK_TAG_HARD_CODED"
        # - "CLICK_TAG_INVALID"
        # - "CLICK_TAG_IN_GWD"
        # - "CLICK_TAG_MISSING"
        # - "CLICK_TAG_MORE_THAN_ONE"
        # - "CLICK_TAG_NON_TOP_LEVEL"
        # - "COMPONENT_UNSUPPORTED_DCM"
        # - "ENABLER_UNSUPPORTED_METHOD_DCM"
        # - "EXTERNAL_FILE_REFERENCED"
        # - "FILE_DETAIL_EMPTY"
        # - "FILE_TYPE_INVALID"
        # - "GWD_PROPERTIES_INVALID"
        # - "HTML5_FEATURE_UNSUPPORTED"
        # - "LINKED_FILE_NOT_FOUND"
        # - "MAX_FLASH_VERSION_11"
        # - "MRAID_REFERENCED"
        # - "NOT_SSL_COMPLIANT"
        # - "ORPHANED_ASSET"
        # - "PRIMARY_HTML_MISSING"
        # - "SVG_INVALID"
        # - "ZIP_INVALID"
      "A String",
    ],
    "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
      "A String",
    ],
    "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
    "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
      "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
      "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
    },
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
      "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
          #
          # Possible values are:
          # - "ADMOB_REFERENCED"
          # - "ASSET_FORMAT_UNSUPPORTED_DCM"
          # - "ASSET_INVALID"
          # - "CLICK_TAG_HARD_CODED"
          # - "CLICK_TAG_INVALID"
          # - "CLICK_TAG_IN_GWD"
          # - "CLICK_TAG_MISSING"
          # - "CLICK_TAG_MORE_THAN_ONE"
          # - "CLICK_TAG_NON_TOP_LEVEL"
          # - "COMPONENT_UNSUPPORTED_DCM"
          # - "ENABLER_UNSUPPORTED_METHOD_DCM"
          # - "EXTERNAL_FILE_REFERENCED"
          # - "FILE_DETAIL_EMPTY"
          # - "FILE_TYPE_INVALID"
          # - "GWD_PROPERTIES_INVALID"
          # - "HTML5_FEATURE_UNSUPPORTED"
          # - "LINKED_FILE_NOT_FOUND"
          # - "MAX_FLASH_VERSION_11"
          # - "MRAID_REFERENCED"
          # - "NOT_SSL_COMPLIANT"
          # - "ORPHANED_ASSET"
          # - "PRIMARY_HTML_MISSING"
          # - "SVG_INVALID"
          # - "ZIP_INVALID"
        "A String",
      ],
      "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
        "A String",
      ],
      "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
      "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
        "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
        "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.creativeFieldValues.html000066400000000000000000000241561300622755700302330ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFieldValues

Instance Methods

delete(profileId, creativeFieldId, id)

Deletes an existing creative field value.

get(profileId, creativeFieldId, id)

Gets one creative field value by ID.

insert(profileId, creativeFieldId, body)

Inserts a new creative field value.

list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)

Retrieves a list of creative field values, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, creativeFieldId, id, body)

Updates an existing creative field value. This method supports patch semantics.

update(profileId, creativeFieldId, body)

Updates an existing creative field value.

Method Details

delete(profileId, creativeFieldId, id) 
Deletes an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
get(profileId, creativeFieldId, id) 
Gets one creative field value by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
insert(profileId, creativeFieldId, body) 
Inserts a new creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves a list of creative field values, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      VALUE - 
  ids: string, Select only creative field values with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field Value List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
    "creativeFieldValues": [ # Creative field value collection.
      { # Contains properties of a creative field value.
          "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
          "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
          "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
        },
    ],
  }
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, creativeFieldId, id, body) 
Updates an existing creative field value. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
update(profileId, creativeFieldId, body) 
Updates an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.creativeFields.html000066400000000000000000000500231300622755700272260ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFields

Instance Methods

delete(profileId, id)

Deletes an existing creative field.

get(profileId, id)

Gets one creative field by ID.

insert(profileId, body)

Inserts a new creative field.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of creative fields, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative field. This method supports patch semantics.

update(profileId, body)

Updates an existing creative field.

Method Details

delete(profileId, id) 
Deletes an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
get(profileId, id) 
Gets one creative field by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of creative fields, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
  ids: string, Select only creative fields with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeFields": [ # Creative field collection.
      { # Contains properties of a creative field.
          "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
          "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
          "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
  }
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, id, body) 
Updates an existing creative field. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.creativeGroups.html000066400000000000000000000541451300622755700273100ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeGroups

Instance Methods

get(profileId, id)

Gets one creative group by ID.

insert(profileId, body)

Inserts a new creative group.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)

Retrieves a list of creative groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative group. This method supports patch semantics.

update(profileId, body)

Updates an existing creative group.

Method Details

get(profileId, id) 
Gets one creative group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None) 
Retrieves a list of creative groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
  groupNumber: integer, Select only creative groups that belong to this subgroup.
  maxResults: integer, Maximum number of results to return.
  ids: string, Select only creative groups with these IDs. (repeated)
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeGroups": [ # Creative group collection.
      { # Contains properties of a creative group.
          "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
          "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
          "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
              # Acceptable values are:
              # - 1
              # - 2
          "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
  }
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, id, body) 
Updates an existing creative group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.creatives.html000066400000000000000000012457311300622755700262770ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creatives

Instance Methods

get(profileId, id)

Gets one creative by ID.

insert(profileId, body)

Inserts a new creative.

list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)

Retrieves a list of creatives, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative. This method supports patch semantics.

update(profileId, body)

Updates an existing creative.

Method Details

get(profileId, id) 
Gets one creative by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
insert(profileId, body) 
Inserts a new creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None) 
Retrieves a list of creatives, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only creatives with this campaign ID.
  advertiserId: string, Select only creatives with this advertiser ID.
  sizeIds: string, Select only creatives with these size IDs. (repeated)
  archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  renderingIds: string, Select only creatives with these rendering IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
  companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
  types: string, Select only creatives with these creative types. (repeated)
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_DISPLAY - 
      CUSTOM_DISPLAY_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_IMAGE_GALLERY - 
      DISPLAY_REDIRECT - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      RICH_MEDIA_DISPLAY_BANNER - 
      RICH_MEDIA_DISPLAY_EXPANDING - 
      RICH_MEDIA_DISPLAY_INTERSTITIAL - 
      RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR_VIDEO - 
      VPAID_NON_LINEAR_VIDEO - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
  ids: string, Select only creatives with these IDs. (repeated)
  studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)

Returns:
  An object of the form:

    { # Creative List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
    "creatives": [ # Creative collection.
      { # Contains properties of a Creative.
          "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            { # Third-party Tracking URL.
              "url": "A String", # URL for the specified third-party URL type.
              "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
            },
          ],
          "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
          "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
          "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
            "windowHeight": 42, # Height of the window.
            "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
            "windowWidth": 42, # Width of the window.
            "positionOption": "A String", # Position in the browser where the window will open.
            "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
          },
          "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
          "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
          "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
          "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
          "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
          "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
          "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
          "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
            { # Creative Field Assignment.
              "creativeFieldId": "A String", # ID of the creative field.
              "creativeFieldValueId": "A String", # ID of the creative field value.
            },
          ],
          "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
          "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
          "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
          "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
            { # Creative Asset.
              "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
                "A String",
              ],
              "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
              "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
              "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
              "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
              "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
                  # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
                  # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
                  # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
                  # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
                  # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
                  # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
                  # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
                  # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
              "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
              "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
              "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
              "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
              "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
              "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
                "targetType": "A String", # Target type used by the event.
                "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
                "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
                "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                  "showStatusBar": True or False, # Whether to display the browser status bar.
                  "showScrollBar": True or False, # Whether to display the browser scroll bar.
                  "showAddressBar": True or False, # Whether to display the browser address bar.
                  "showMenuBar": True or False, # Whether to display the browser menu bar.
                  "title": "A String", # Title of popup window.
                  "showToolBar": True or False, # Whether to display the browser tool bar.
                  "positionType": "A String", # Popup window position either centered or at specific coordinate.
                  "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                    "top": 42, # Offset distance from top side of an asset or a window.
                    "left": 42, # Offset distance from left side of an asset or a window.
                  },
                  "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                    "width": 42, # Width of this size.
                    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                    "height": 42, # Height of this size.
                  },
                },
                "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
                "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
                "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
                "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
                "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
                "advertiserCustomEventName": "A String", # User-entered name for the event.
              },
              "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
                "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
                "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
              },
              "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
              "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
            },
          ],
          "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
          "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
          "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
          "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            { # Creative Click Tag.
              "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
              "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
            },
          ],
          "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "active": True or False, # Whether the creative is active. Applicable to all creative types.
          "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
              #
              # Acceptable values are:
              # - "APP"
              # - "APP_INTERSTITIAL"
              # - "IN_STREAM_VIDEO"
              # - "DISPLAY"
              # - "DISPLAY_INTERSTITIAL"
            "A String",
          ],
          "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
          "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
          "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
          "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
          "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
          "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
          "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            "A String",
          ],
          "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
          "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "customHtml": "A String", # User-entered value.
            "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
          },
          "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        },
    ],
  }
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, id, body) 
Updates an existing creative. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
update(profileId, body) 
Updates an existing creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.dimensionValues.html000066400000000000000000000115331300622755700274450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dimensionValues

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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.directorySiteContacts.html000066400000000000000000000142361300622755700306330ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySiteContacts

Instance Methods

get(profileId, id)

Gets one directory site contact by ID.

list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of directory site contacts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site contact by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site contact ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Site Directory contact.
    "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
    "firstName": "A String", # First name of this directory site contact.
    "title": "A String", # Title or designation of this directory site contact.
    "lastName": "A String", # Last name of this directory site contact.
    "email": "A String", # Email address of this directory site contact.
    "phone": "A String", # Phone number of this directory site contact.
    "role": "A String", # Directory site contact role.
    "address": "A String", # Address of this directory site contact.
    "type": "A String", # Directory site contact type.
    "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
  }
list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of directory site contacts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
  directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory site contacts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Directory Site Contact List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "directorySiteContacts": [ # Directory site contact collection
      { # Contains properties of a Site Directory contact.
        "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
        "firstName": "A String", # First name of this directory site contact.
        "title": "A String", # Title or designation of this directory site contact.
        "lastName": "A String", # Last name of this directory site contact.
        "email": "A String", # Email address of this directory site contact.
        "phone": "A String", # Phone number of this directory site contact.
        "role": "A String", # Directory site contact role.
        "address": "A String", # Address of this directory site contact.
        "type": "A String", # Directory site contact type.
        "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
      },
    ],
    "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.directorySites.html000066400000000000000000000667611300622755700273310ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySites

Instance Methods

get(profileId, id)

Gets one directory site by ID.

insert(profileId, body)

Inserts a new directory site.

list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)

Retrieves a list of directory sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site ID. (required)

Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
insert(profileId, body) 
Inserts a new directory site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
    "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
    "countryId": "A String", # Country ID of this directory site.
    "description": "A String", # Description of this directory site.
    "settings": { # Directory Site Settings # Directory site settings.
      "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
      "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
      "dfp_settings": { # DFP Settings # Directory site DFP settings.
        "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
        "dfp_network_name": "A String", # DFP network name for this directory site.
        "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
        "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
        "dfp_network_code": "A String", # DFP network code for this directory site.
      },
      "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
      "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
      "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
      "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
    },
    "currencyId": "A String", # Currency ID of this directory site.
        # Possible values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "inpageTagFormats": [ # Tag types for regular placements.
        # 
        # Acceptable values are:
        # - "STANDARD"
        # - "IFRAME_JAVASCRIPT_INPAGE"
        # - "INTERNAL_REDIRECT_INPAGE"
        # - "JAVASCRIPT_INPAGE"
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "interstitialTagFormats": [ # Tag types for interstitial placements.
        # 
        # Acceptable values are:
        # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
        # - "INTERNAL_REDIRECT_INTERSTITIAL"
        # - "JAVASCRIPT_INTERSTITIAL"
      "A String",
    ],
    "contactAssignments": [ # Directory site contacts.
      { # Directory Site Contact Assignment
        "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
        "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
      },
    ],
    "url": "A String", # URL of this directory site.
    "parentId": "A String", # Parent directory site ID.
    "active": True or False, # Whether this directory site is active.
    "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
    "name": "A String", # Name of this directory site.
  }


Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None) 
Retrieves a list of directory sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  countryId: string, Select only directory sites with this country ID.
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  parentId: string, Select only directory sites with this parent ID.
  acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
  searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory sites with these IDs. (repeated)
  dfp_network_code: string, Select only directory sites with this DFP network code.

Returns:
  An object of the form:

    { # Directory Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
    "directorySites": [ # Directory site collection.
      { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
          "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
          "countryId": "A String", # Country ID of this directory site.
          "description": "A String", # Description of this directory site.
          "settings": { # Directory Site Settings # Directory site settings.
            "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
            "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
            "dfp_settings": { # DFP Settings # Directory site DFP settings.
              "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
              "dfp_network_name": "A String", # DFP network name for this directory site.
              "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
              "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
              "dfp_network_code": "A String", # DFP network code for this directory site.
            },
            "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
            "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
            "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
            "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
          },
          "currencyId": "A String", # Currency ID of this directory site.
              # Possible values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "inpageTagFormats": [ # Tag types for regular placements.
              #
              # Acceptable values are:
              # - "STANDARD"
              # - "IFRAME_JAVASCRIPT_INPAGE"
              # - "INTERNAL_REDIRECT_INPAGE"
              # - "JAVASCRIPT_INPAGE"
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "interstitialTagFormats": [ # Tag types for interstitial placements.
              #
              # Acceptable values are:
              # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
              # - "INTERNAL_REDIRECT_INTERSTITIAL"
              # - "JAVASCRIPT_INTERSTITIAL"
            "A String",
          ],
          "contactAssignments": [ # Directory site contacts.
            { # Directory Site Contact Assignment
              "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
              "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
            },
          ],
          "url": "A String", # URL of this directory site.
          "parentId": "A String", # Parent directory site ID.
          "active": True or False, # Whether this directory site is active.
          "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
          "name": "A String", # Name of this directory site.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.dynamicTargetingKeys.html000066400000000000000000000162631300622755700304320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dynamicTargetingKeys

Instance Methods

delete(profileId, objectId, name, objectType)

Deletes an existing dynamic targeting key.

insert(profileId, body)

Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)

Retrieves a list of dynamic targeting keys.

Method Details

delete(profileId, objectId, name, objectType) 
Deletes an existing dynamic targeting key.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
  name: string, Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. (required)
  objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
    Allowed values
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_CREATIVE - 
      OBJECT_PLACEMENT -
insert(profileId, body) 
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
    "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
    "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
    "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
    "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
  }


Returns:
  An object of the form:

    { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
      "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
      "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
      "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
      "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
    }
list(profileId, advertiserId=None, objectId=None, names=None, objectType=None) 
Retrieves a list of dynamic targeting keys.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
  objectId: string, Select only dynamic targeting keys with this object ID.
  names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
  objectType: string, Select only dynamic targeting keys with this object type.
    Allowed values
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_CREATIVE - 
      OBJECT_PLACEMENT - 

Returns:
  An object of the form:

    { # Dynamic Targeting Key List Response
    "kind": "dfareporting#dynamicTargetingKeysListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
    "dynamicTargetingKeys": [ # Dynamic targeting key collection.
      { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
          "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
          "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
          "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
          "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.eventTags.html000066400000000000000000001223761300622755700262500ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . eventTags

Instance Methods

delete(profileId, id)

Deletes an existing event tag.

get(profileId, id)

Gets one event tag by ID.

insert(profileId, body)

Inserts a new event tag.

list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)

Retrieves a list of event tags, possibly filtered.

patch(profileId, id, body)

Updates an existing event tag. This method supports patch semantics.

update(profileId, body)

Updates an existing event tag.

Method Details

delete(profileId, id) 
Deletes an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
get(profileId, id) 
Gets one event tag by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)

Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None) 
Retrieves a list of event tags, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only event tags that belong to this campaign.
  advertiserId: string, Select only event tags that belong to this advertiser.
  adId: string, Select only event tags that belong to this ad.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  definitionsOnly: boolean, Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
  eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
    Allowed values
      CLICK_THROUGH_EVENT_TAG - 
      IMPRESSION_IMAGE_EVENT_TAG - 
      IMPRESSION_JAVASCRIPT_EVENT_TAG - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  enabled: boolean, Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
  ids: string, Select only event tags with these IDs. (repeated)

Returns:
  An object of the form:

    { # Event Tag List Response
    "eventTags": [ # Event tag collection.
      { # Contains properties of an event tag.
          "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
          "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
          "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
          "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
          "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
          "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
          "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
          "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
          "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
          "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
            "A String",
          ],
          "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
          "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
          "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
  }
patch(profileId, id, body) 
Updates an existing event tag. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.files.html000066400000000000000000000177121300622755700254070ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.floodlightActivities.html000066400000000000000000002332701300622755700304640ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivities

Instance Methods

delete(profileId, id)

Deletes an existing floodlight activity.

generatetag(profileId, floodlightActivityId=None)

Generates a tag for a floodlight activity.

get(profileId, id)

Gets one floodlight activity by ID.

insert(profileId, body)

Inserts a new floodlight activity.

list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)

Retrieves a list of floodlight activities, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity.

Method Details

delete(profileId, id) 
Deletes an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
generatetag(profileId, floodlightActivityId=None) 
Generates a tag for a floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.

Returns:
  An object of the form:

    { # Floodlight Activity GenerateTag Response
    "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
    "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
  }
get(profileId, id) 
Gets one floodlight activity by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
insert(profileId, body) 
Inserts a new floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None) 
Retrieves a list of floodlight activities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
  advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  tagString: string, Select only floodlight activities with the specified tag string.
  floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
  floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
  floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
    "floodlightActivities": [ # Floodlight activity collection.
      { # Contains properties of a Floodlight activity.
          "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
          "secure": True or False, # Whether this tag should use SSL.
          "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
          "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
          "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
          "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
          "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
          "publisherTags": [ # Publisher dynamic floodlight tags.
            { # Publisher Dynamic Tag
              "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
              "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
              "siteId": "A String", # Site ID of this dynamic tag.
              "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
                "tag": "A String", # Tag code.
                "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
                "name": "A String", # Name of this tag.
              },
              "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
              "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            },
          ],
          "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "hidden": True or False, # Whether this activity is archived.
          "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
          "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
          "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
          "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
          "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
          "notes": "A String", # General notes or implementation instructions for the tag.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
          "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
              # Acceptable values are:
              # - "U1"
              # - "U2"
              # - "U3"
              # - "U4"
              # - "U5"
              # - "U6"
              # - "U7"
              # - "U8"
              # - "U9"
              # - "U10"
              # - "U11"
              # - "U12"
              # - "U13"
              # - "U14"
              # - "U15"
              # - "U16"
              # - "U17"
              # - "U18"
              # - "U19"
              # - "U20"
            "A String",
          ],
          "defaultTags": [ # Dynamic floodlight tags.
            { # Dynamic Tag
              "tag": "A String", # Tag code.
              "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
              "name": "A String", # Name of this tag.
            },
          ],
          "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
          "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
update(profileId, body) 
Updates an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.floodlightActivityGroups.html000066400000000000000000001251721300622755700313550ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivityGroups

Instance Methods

get(profileId, id)

Gets one floodlight activity group by ID.

insert(profileId, body)

Inserts a new floodlight activity group.

list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)

Retrieves a list of floodlight activity groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity group. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity group.

Method Details

get(profileId, id) 
Gets one floodlight activity group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None) 
Retrieves a list of floodlight activity groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only floodlight activity groups with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
    "floodlightActivityGroups": [ # Floodlight activity group collection.
      { # Contains properties of a Floodlight activity group.
          "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
          "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.floodlightConfigurations.html000066400000000000000000001153651300622755700313560ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightConfigurations

Instance Methods

get(profileId, id)

Gets one floodlight configuration by ID.

list(profileId, ids=None)

Retrieves a list of floodlight configurations, possibly filtered.

patch(profileId, id, body)

Updates an existing floodlight configuration. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight configuration.

Method Details

get(profileId, id) 
Gets one floodlight configuration by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
list(profileId, ids=None) 
Retrieves a list of floodlight configurations, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)

Returns:
  An object of the form:

    { # Floodlight Configuration List Response
    "floodlightConfigurations": [ # Floodlight configuration collection.
      { # Contains properties of a Floodlight configuration.
          "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
          "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
          "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
            "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
            "imageTagEnabled": True or False, # Whether image tags are enabled.
          },
          "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
          "standardVariableTypes": [ # List of standard variables enabled for this configuration.
              #
              # Acceptable values are:
              # - "ORD"
              # - "NUM"
            "A String",
          ],
          "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
            "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
            "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
          },
          "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
          "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
          "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
          "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
          "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
            { # Third Party Authentication Token
              "name": "A String", # Name of the third-party authentication token.
              "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
            },
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
          "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
            { # User Defined Variable configuration.
              "dataType": "A String", # Data type for the variable. This is a required field.
              "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
              "variableType": "A String", # Variable name in the tag. This is a required field.
            },
          ],
          "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
  }
patch(profileId, id, body) 
Updates an existing floodlight configuration. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight configuration.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.html000066400000000000000000000274121300622755700243040ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API

Instance Methods

accountActiveAdSummaries()

Returns the accountActiveAdSummaries Resource.

accountPermissionGroups()

Returns the accountPermissionGroups Resource.

accountPermissions()

Returns the accountPermissions Resource.

accountUserProfiles()

Returns the accountUserProfiles Resource.

accounts()

Returns the accounts Resource.

ads()

Returns the ads Resource.

advertiserGroups()

Returns the advertiserGroups Resource.

advertisers()

Returns the advertisers Resource.

browsers()

Returns the browsers Resource.

campaignCreativeAssociations()

Returns the campaignCreativeAssociations Resource.

campaigns()

Returns the campaigns Resource.

changeLogs()

Returns the changeLogs Resource.

cities()

Returns the cities Resource.

connectionTypes()

Returns the connectionTypes Resource.

contentCategories()

Returns the contentCategories Resource.

conversions()

Returns the conversions Resource.

countries()

Returns the countries Resource.

creativeAssets()

Returns the creativeAssets Resource.

creativeFieldValues()

Returns the creativeFieldValues Resource.

creativeFields()

Returns the creativeFields Resource.

creativeGroups()

Returns the creativeGroups Resource.

creatives()

Returns the creatives Resource.

dimensionValues()

Returns the dimensionValues Resource.

directorySiteContacts()

Returns the directorySiteContacts Resource.

directorySites()

Returns the directorySites Resource.

dynamicTargetingKeys()

Returns the dynamicTargetingKeys Resource.

eventTags()

Returns the eventTags Resource.

files()

Returns the files Resource.

floodlightActivities()

Returns the floodlightActivities Resource.

floodlightActivityGroups()

Returns the floodlightActivityGroups Resource.

floodlightConfigurations()

Returns the floodlightConfigurations Resource.

inventoryItems()

Returns the inventoryItems Resource.

landingPages()

Returns the landingPages Resource.

metros()

Returns the metros Resource.

mobileCarriers()

Returns the mobileCarriers Resource.

operatingSystemVersions()

Returns the operatingSystemVersions Resource.

operatingSystems()

Returns the operatingSystems Resource.

orderDocuments()

Returns the orderDocuments Resource.

orders()

Returns the orders Resource.

placementGroups()

Returns the placementGroups Resource.

placementStrategies()

Returns the placementStrategies Resource.

placements()

Returns the placements Resource.

platformTypes()

Returns the platformTypes Resource.

postalCodes()

Returns the postalCodes Resource.

projects()

Returns the projects Resource.

regions()

Returns the regions Resource.

remarketingListShares()

Returns the remarketingListShares Resource.

remarketingLists()

Returns the remarketingLists Resource.

reports()

Returns the reports Resource.

sites()

Returns the sites Resource.

sizes()

Returns the sizes Resource.

subaccounts()

Returns the subaccounts Resource.

targetableRemarketingLists()

Returns the targetableRemarketingLists Resource.

userProfiles()

Returns the userProfiles Resource.

userRolePermissionGroups()

Returns the userRolePermissionGroups Resource.

userRolePermissions()

Returns the userRolePermissions Resource.

userRoles()

Returns the userRoles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.inventoryItems.html000066400000000000000000000316271300622755700273450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . inventoryItems

Instance Methods

get(profileId, projectId, id)

Gets one inventory item by ID.

list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)

Retrieves a list of inventory items, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one inventory item by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Inventory item ID. (required)

Returns:
  An object of the form:

    { # Represents a buy from the DoubleClick Planning inventory store.
    "orderId": "A String", # Order ID of this inventory item.
    "pricing": { # Pricing Information # Pricing of this inventory item.
      "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
      "startDate": "A String", # Start date of this inventory item.
      "endDate": "A String", # End date of this inventory item.
      "pricingType": "A String", # Pricing type of this inventory item.
      "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
        { # Flight
          "rateOrCost": "A String", # Rate or cost of this flight.
          "startDate": "A String", # Inventory item flight start date.
          "units": "A String", # Units of this flight.
          "endDate": "A String", # Inventory item flight end date.
        },
      ],
      "capCostType": "A String", # Cap cost type of this inventory item.
    },
    "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
    "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
    "subaccountId": "A String", # Subaccount ID of this inventory item.
    "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
    "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
    "inPlan": True or False, # Whether this inventory item is in plan.
    "id": "A String", # ID of this inventory item.
    "advertiserId": "A String", # Advertiser ID of this inventory item.
    "siteId": "A String", # ID of the site this inventory item is associated with.
    "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
      { # Ad Slot
        "comment": "A String", # Comment for this ad slot.
        "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
        "name": "A String", # Name of this ad slot.
        "primary": True or False, # Primary ad slot of a roadblock inventory item.
        "height": "A String", # Height of this ad slot.
        "width": "A String", # Width of this ad slot.
        "paymentSourceType": "A String", # Payment source type of this ad slot.
        "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
      },
    ],
    "projectId": "A String", # Project ID of this inventory item.
    "rfpId": "A String", # RFP ID of this inventory item.
    "type": "A String", # Type of inventory item.
    "contentCategoryId": "A String", # Content category ID of this inventory item.
    "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
    "accountId": "A String", # Account ID of this inventory item.
  }
list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None) 
Retrieves a list of inventory items, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  inPlan: boolean, Select only inventory items that are in plan.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only inventory items with this type.
    Allowed values
      PLANNING_PLACEMENT_TYPE_CREDIT - 
      PLANNING_PLACEMENT_TYPE_REGULAR - 
  orderId: string, Select only inventory items that belong to specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only inventory items that are associated with these sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only inventory items with these IDs. (repeated)

Returns:
  An object of the form:

    { # Inventory item List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#inventoryItemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
    "inventoryItems": [ # Inventory item collection
      { # Represents a buy from the DoubleClick Planning inventory store.
        "orderId": "A String", # Order ID of this inventory item.
        "pricing": { # Pricing Information # Pricing of this inventory item.
          "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
          "startDate": "A String", # Start date of this inventory item.
          "endDate": "A String", # End date of this inventory item.
          "pricingType": "A String", # Pricing type of this inventory item.
          "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
            { # Flight
              "rateOrCost": "A String", # Rate or cost of this flight.
              "startDate": "A String", # Inventory item flight start date.
              "units": "A String", # Units of this flight.
              "endDate": "A String", # Inventory item flight end date.
            },
          ],
          "capCostType": "A String", # Cap cost type of this inventory item.
        },
        "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
        "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
        "subaccountId": "A String", # Subaccount ID of this inventory item.
        "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
        "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
        "inPlan": True or False, # Whether this inventory item is in plan.
        "id": "A String", # ID of this inventory item.
        "advertiserId": "A String", # Advertiser ID of this inventory item.
        "siteId": "A String", # ID of the site this inventory item is associated with.
        "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
          { # Ad Slot
            "comment": "A String", # Comment for this ad slot.
            "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
            "name": "A String", # Name of this ad slot.
            "primary": True or False, # Primary ad slot of a roadblock inventory item.
            "height": "A String", # Height of this ad slot.
            "width": "A String", # Width of this ad slot.
            "paymentSourceType": "A String", # Payment source type of this ad slot.
            "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
          },
        ],
        "projectId": "A String", # Project ID of this inventory item.
        "rfpId": "A String", # RFP ID of this inventory item.
        "type": "A String", # Type of inventory item.
        "contentCategoryId": "A String", # Content category ID of this inventory item.
        "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
        "accountId": "A String", # Account ID of this inventory item.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.landingPages.html000066400000000000000000000262211300622755700266740ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . landingPages

Instance Methods

delete(profileId, campaignId, id)

Deletes an existing campaign landing page.

get(profileId, campaignId, id)

Gets one campaign landing page by ID.

insert(profileId, campaignId, body)

Inserts a new landing page for the specified campaign.

list(profileId, campaignId)

Retrieves the list of landing pages for the specified campaign.

patch(profileId, campaignId, id, body)

Updates an existing campaign landing page. This method supports patch semantics.

update(profileId, campaignId, body)

Updates an existing campaign landing page.

Method Details

delete(profileId, campaignId, id) 
Deletes an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
get(profileId, campaignId, id) 
Gets one campaign landing page by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)

Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
insert(profileId, campaignId, body) 
Inserts a new landing page for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
list(profileId, campaignId) 
Retrieves the list of landing pages for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)

Returns:
  An object of the form:

    { # Landing Page List Response
    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
    "landingPages": [ # Landing page collection
      { # Contains information about where a user's browser is taken after the user clicks an ad.
          "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
          "url": "A String", # URL of this landing page. This is a required field.
          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
        },
    ],
  }
patch(profileId, campaignId, id, body) 
Updates an existing campaign landing page. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
update(profileId, campaignId, body) 
Updates an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.metros.html000066400000000000000000000047421300622755700256150ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . metros

Instance Methods

list(profileId)

Retrieves a list of metros.

Method Details

list(profileId) 
Retrieves a list of metros.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Metro List Response
    "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
    "metros": [ # Metro collection.
      { # Contains information about a metro region that can be targeted by ads.
        "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
        "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
        "name": "A String", # Name of this metro region.
        "countryCode": "A String", # Country code of the country to which this metro region belongs.
        "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
        "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
        "dartId": "A String", # DART ID of this metro region.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.mobileCarriers.html000066400000000000000000000064101300622755700272400ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . mobileCarriers

Instance Methods

get(profileId, id)

Gets one mobile carrier by ID.

list(profileId)

Retrieves a list of mobile carriers.

Method Details

get(profileId, id) 
Gets one mobile carrier by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Mobile carrier ID. (required)

Returns:
  An object of the form:

    { # Contains information about a mobile carrier that can be targeted by ads.
    "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
    "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
    "id": "A String", # ID of this mobile carrier.
    "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
    "name": "A String", # Name of this mobile carrier.
  }
list(profileId) 
Retrieves a list of mobile carriers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Mobile Carrier List Response
    "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
    "mobileCarriers": [ # Mobile carrier collection.
      { # Contains information about a mobile carrier that can be targeted by ads.
        "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
        "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
        "id": "A String", # ID of this mobile carrier.
        "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
        "name": "A String", # Name of this mobile carrier.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.operatingSystemVersions.html000066400000000000000000000114331300622755700312250ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystemVersions

Instance Methods

get(profileId, id)

Gets one operating system version by ID.

list(profileId)

Retrieves a list of operating system versions.

Method Details

get(profileId, id) 
Gets one operating system version by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Operating system version ID. (required)

Returns:
  An object of the form:

    { # Contains information about a particular version of an operating system that can be targeted by ads.
    "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
    "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
    "name": "A String", # Name of this operating system version.
    "id": "A String", # ID of this operating system version.
    "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
      "mobile": True or False, # Whether this operating system is for mobile.
      "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
      "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
      "name": "A String", # Name of this operating system.
      "desktop": True or False, # Whether this operating system is for desktop.
    },
    "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
  }
list(profileId) 
Retrieves a list of operating system versions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System Version List Response
    "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
    "operatingSystemVersions": [ # Operating system version collection.
      { # Contains information about a particular version of an operating system that can be targeted by ads.
        "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
        "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
        "name": "A String", # Name of this operating system version.
        "id": "A String", # ID of this operating system version.
        "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
        "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.operatingSystems.html000066400000000000000000000065271300622755700276670ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystems

Instance Methods

get(profileId, dartId)

Gets one operating system by DART ID.

list(profileId)

Retrieves a list of operating systems.

Method Details

get(profileId, dartId) 
Gets one operating system by DART ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Operating system DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about an operating system that can be targeted by ads.
    "mobile": True or False, # Whether this operating system is for mobile.
    "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
    "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
    "name": "A String", # Name of this operating system.
    "desktop": True or False, # Whether this operating system is for desktop.
  }
list(profileId) 
Retrieves a list of operating systems.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System List Response
    "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
    "operatingSystems": [ # Operating system collection.
      { # Contains information about an operating system that can be targeted by ads.
        "mobile": True or False, # Whether this operating system is for mobile.
        "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
        "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
        "name": "A String", # Name of this operating system.
        "desktop": True or False, # Whether this operating system is for desktop.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.orderDocuments.html000066400000000000000000000200461300622755700272740ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orderDocuments

Instance Methods

get(profileId, projectId, id)

Gets one order document by ID.

list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)

Retrieves a list of order documents, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order document by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Order document ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning order document.
    "orderId": "A String", # ID of the order from which this order document is created.
    "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
      "A String",
    ],
    "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
    "subaccountId": "A String", # Subaccount ID of this order document.
    "effectiveDate": "A String", # Effective date of this order document.
    "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
    "lastSentRecipients": [ # List of email addresses that received the last sent document.
      "A String",
    ],
    "title": "A String", # Title of this order document.
    "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
    "signed": True or False, # Whether this order document has been signed.
    "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "advertiserId": "A String", # Advertiser ID of this order document.
    "projectId": "A String", # Project ID of this order document.
    "cancelled": True or False, # Whether this order document is cancelled.
    "type": "A String", # Type of this order document
    "id": "A String", # ID of this order document.
    "accountId": "A String", # Account ID of this order document.
  }
list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None) 
Retrieves a list of order documents, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  orderId: string, Select only order documents for specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only order documents that are associated with these sites. (repeated)
  approved: boolean, Select only order documents that have been approved by at least one user.
  searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only order documents with these IDs. (repeated)

Returns:
  An object of the form:

    { # Order document List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#orderDocumentsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
    "orderDocuments": [ # Order document collection
      { # Contains properties of a DoubleClick Planning order document.
        "orderId": "A String", # ID of the order from which this order document is created.
        "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
          "A String",
        ],
        "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
        "subaccountId": "A String", # Subaccount ID of this order document.
        "effectiveDate": "A String", # Effective date of this order document.
        "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
        "lastSentRecipients": [ # List of email addresses that received the last sent document.
          "A String",
        ],
        "title": "A String", # Title of this order document.
        "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
        "signed": True or False, # Whether this order document has been signed.
        "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "advertiserId": "A String", # Advertiser ID of this order document.
        "projectId": "A String", # Project ID of this order document.
        "cancelled": True or False, # Whether this order document is cancelled.
        "type": "A String", # Type of this order document
        "id": "A String", # ID of this order document.
        "accountId": "A String", # Account ID of this order document.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.orders.html000066400000000000000000000213671300622755700256040ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orders

Instance Methods

get(profileId, projectId, id)

Gets one order by ID.

list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)

Retrieves a list of orders, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  id: string, Order ID. (required)

Returns:
  An object of the form:

    { # Describes properties of a DoubleClick Planning order.
    "termsAndConditions": "A String", # Terms and conditions of this order.
    "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
    "sellerOrganizationName": "A String", # Name of the seller organization.
    "subaccountId": "A String", # Subaccount ID of this order.
    "name": "A String", # Name of this order.
    "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "notes": "A String", # Notes of this order.
    "contacts": [ # Contacts for this order.
      { # Contact of an order.
        "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
        "contactTitle": "A String", # Title of this contact.
        "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
        "contactName": "A String", # Name of this contact.
        "contactType": "A String", # Type of this contact.
      },
    ],
    "buyerOrganizationName": "A String", # Name of the buyer organization.
    "comments": "A String", # Comments in this order.
    "advertiserId": "A String", # Advertiser ID of this order.
    "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
      "A String",
    ],
    "siteId": [ # Site IDs this order is associated with.
      "A String",
    ],
    "sellerOrderId": "A String", # Seller order ID associated with this order.
    "projectId": "A String", # Project ID of this order.
    "siteNames": [ # Free-form site names this order is associated with.
      "A String",
    ],
    "planningTermId": "A String", # ID of the terms and conditions template used in this order.
    "id": "A String", # ID of this order. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this order.
  }
list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None) 
Retrieves a list of orders, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only orders with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  siteId: string, Select only orders that are associated with these site IDs. (repeated)

Returns:
  An object of the form:

    { # Order List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
    "orders": [ # Order collection.
      { # Describes properties of a DoubleClick Planning order.
        "termsAndConditions": "A String", # Terms and conditions of this order.
        "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
        "sellerOrganizationName": "A String", # Name of the seller organization.
        "subaccountId": "A String", # Subaccount ID of this order.
        "name": "A String", # Name of this order.
        "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "notes": "A String", # Notes of this order.
        "contacts": [ # Contacts for this order.
          { # Contact of an order.
            "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
            "contactTitle": "A String", # Title of this contact.
            "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
            "contactName": "A String", # Name of this contact.
            "contactType": "A String", # Type of this contact.
          },
        ],
        "buyerOrganizationName": "A String", # Name of the buyer organization.
        "comments": "A String", # Comments in this order.
        "advertiserId": "A String", # Advertiser ID of this order.
        "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
          "A String",
        ],
        "siteId": [ # Site IDs this order is associated with.
          "A String",
        ],
        "sellerOrderId": "A String", # Seller order ID associated with this order.
        "projectId": "A String", # Project ID of this order.
        "siteNames": [ # Free-form site names this order is associated with.
          "A String",
        ],
        "planningTermId": "A String", # ID of the terms and conditions template used in this order.
        "id": "A String", # ID of this order. This is a read-only, auto-generated field.
        "accountId": "A String", # Account ID of this order.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.placementGroups.html000066400000000000000000003050101300622755700274440ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementGroups

Instance Methods

get(profileId, id)

Gets one placement group by ID.

insert(profileId, body)

Inserts a new placement group.

list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)

Retrieves a list of placement groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement group. This method supports patch semantics.

update(profileId, body)

Updates an existing placement group.

Method Details

get(profileId, id) 
Gets one placement group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None) 
Retrieves a list of placement groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placement groups that are associated with these sites. (repeated)
  placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
    Allowed values
      PLACEMENT_PACKAGE - 
      PLACEMENT_ROADBLOCK - 
  pricingTypes: string, Select only placement groups with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
  ids: string, Select only placement groups with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Placement Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
    "placementGroups": [ # Placement group collection.
      { # Contains properties of a package or roadblock.
          "comment": "A String", # Comments for this placement group.
          "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
          "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
          "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this placement group is archived.
          "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
            "A String",
          ],
          "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
          "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
          "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.placementStrategies.html000066400000000000000000000257571300622755700303200ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementStrategies

Instance Methods

delete(profileId, id)

Deletes an existing placement strategy.

get(profileId, id)

Gets one placement strategy by ID.

insert(profileId, body)

Inserts a new placement strategy.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of placement strategies, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement strategy. This method supports patch semantics.

update(profileId, body)

Updates an existing placement strategy.

Method Details

delete(profileId, id) 
Deletes an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
get(profileId, id) 
Gets one placement strategy by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of placement strategies, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placement strategies with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Placement Strategy List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
    "placementStrategies": [ # Placement strategy collection.
      { # Contains properties of a placement strategy.
          "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
          "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
          "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
          "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing placement strategy. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.placements.html000066400000000000000000004054451300622755700264440ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placements

Instance Methods

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)

Generates tags for a placement.

get(profileId, id)

Gets one placement by ID.

insert(profileId, body)

Inserts a new placement.

list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)

Retrieves a list of placements, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement. This method supports patch semantics.

update(profileId, body)

Updates an existing placement.

Method Details

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None) 
Generates tags for a placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Generate placements belonging to this campaign. This is a required field.
  tagFormats: string, Tag formats to generate for these placements. (repeated)
    Allowed values
      PLACEMENT_TAG_CLICK_COMMANDS - 
      PLACEMENT_TAG_IFRAME_ILAYER - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 - 
      PLACEMENT_TAG_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_JAVASCRIPT - 
      PLACEMENT_TAG_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_STANDARD - 
      PLACEMENT_TAG_TRACKING - 
      PLACEMENT_TAG_TRACKING_IFRAME - 
      PLACEMENT_TAG_TRACKING_JAVASCRIPT - 
  placementIds: string, Generate tags for these placements. (repeated)

Returns:
  An object of the form:

    { # Placement GenerateTags Response
    "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
    "placementTags": [ # Set of generated tags for the specified placements.
      { # Placement Tag
        "tagDatas": [ # Tags generated for this placement.
          { # Placement Tag Data
            "clickTag": "A String", # Tag string to record a click.
            "impressionTag": "A String", # Tag string for serving an ad.
            "creativeId": "A String", # Creative associated with this placement tag.
            "adId": "A String", # Ad associated with this placement tag.
            "format": "A String", # TagData tag format of this tag.
          },
        ],
        "placementId": "A String", # Placement ID
      },
    ],
  }
get(profileId, id) 
Gets one placement by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None) 
Retrieves a list of placements, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placements that are associated with these sites. (repeated)
  paymentSource: string, Select only placements with this payment source.
    Allowed values
      PLACEMENT_AGENCY_PAID - 
      PLACEMENT_PUBLISHER_PAID - 
  pricingTypes: string, Select only placements with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placements that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
  sizeIds: string, Select only placements that are associated with these sizes. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placements with these IDs. (repeated)
  groupIds: string, Select only placements that belong to these placement groups. (repeated)

Returns:
  An object of the form:

    { # Placement List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
    "placements": [ # Placement collection.
      { # Contains properties of a placement.
          "comment": "A String", # Comments for this placement.
          "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
          "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
          "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement. This field can be left blank.
          "archived": True or False, # Whether this placement is archived.
          "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
              # Acceptable values are:
              # - "PLACEMENT_TAG_STANDARD"
              # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_IFRAME_ILAYER"
              # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
              # - "PLACEMENT_TAG_CLICK_COMMANDS"
              # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
              # - "PLACEMENT_TAG_TRACKING"
              # - "PLACEMENT_TAG_TRACKING_IFRAME"
              # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
            "A String",
          ],
          "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
          "tagSetting": { # Tag Settings # Tag settings for this placement.
            "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
            "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
            "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
            "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
          },
          "contentCategoryId": "A String", # ID of the content category assigned to this placement.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
          "status": "A String", # Third-party placement status.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
          "placementGroupId": "A String", # ID of this placement's group, if applicable.
          "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
          "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
          "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
          "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.platformTypes.html000066400000000000000000000055441300622755700271560ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . platformTypes

Instance Methods

get(profileId, id)

Gets one platform type by ID.

list(profileId)

Retrieves a list of platform types.

Method Details

get(profileId, id) 
Gets one platform type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Platform type ID. (required)

Returns:
  An object of the form:

    { # Contains information about a platform type that can be targeted by ads.
    "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
    "id": "A String", # ID of this platform type.
    "name": "A String", # Name of this platform type.
  }
list(profileId) 
Retrieves a list of platform types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Platform Type List Response
    "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
    "platformTypes": [ # Platform type collection.
      { # Contains information about a platform type that can be targeted by ads.
        "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
        "id": "A String", # ID of this platform type.
        "name": "A String", # Name of this platform type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.postalCodes.html000066400000000000000000000063561300622755700265670ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . postalCodes

Instance Methods

get(profileId, code)

Gets one postal code by ID.

list(profileId)

Retrieves a list of postal codes.

Method Details

get(profileId, code) 
Gets one postal code by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  code: string, Postal code ID. (required)

Returns:
  An object of the form:

    { # Contains information about a postal code that can be targeted by ads.
    "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
    "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
    "code": "A String", # Postal code. This is equivalent to the id field.
    "id": "A String", # ID of this postal code.
    "countryCode": "A String", # Country code of the country to which this postal code belongs.
  }
list(profileId) 
Retrieves a list of postal codes.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Postal Code List Response
    "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
    "postalCodes": [ # Postal code collection.
      { # Contains information about a postal code that can be targeted by ads.
        "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
        "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
        "code": "A String", # Postal code. This is equivalent to the id field.
        "id": "A String", # ID of this postal code.
        "countryCode": "A String", # Country code of the country to which this postal code belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.projects.html000066400000000000000000000177221300622755700261370ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . projects

Instance Methods

get(profileId, id)

Gets one project by ID.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of projects, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one project by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Project ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning project.
    "startDate": "A String", # Start date of the project.
    "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
    "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
    "endDate": "A String", # End date of the project.
    "name": "A String", # Name of this project.
    "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
    "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
    "clientBillingCode": "A String", # Client billing code of this project.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
    "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
    "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
    "advertiserId": "A String", # Advertiser ID of this project.
    "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
    "overview": "A String", # Overview of this project.
    "audienceAgeGroup": "A String", # Audience age group of this project.
    "subaccountId": "A String", # Subaccount ID of this project.
    "audienceGender": "A String", # Audience gender of this project.
    "id": "A String", # ID of this project. This is a read-only, auto-generated field.
    "clientName": "A String", # Name of the project client.
    "accountId": "A String", # Account ID of this project.
  }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of projects, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
  ids: string, Select only projects with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Project List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
    "projects": [ # Project collection.
      { # Contains properties of a DoubleClick Planning project.
        "startDate": "A String", # Start date of the project.
        "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
        "endDate": "A String", # End date of the project.
        "name": "A String", # Name of this project.
        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
        "clientBillingCode": "A String", # Client billing code of this project.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
        "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
        "advertiserId": "A String", # Advertiser ID of this project.
        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
        "overview": "A String", # Overview of this project.
        "audienceAgeGroup": "A String", # Audience age group of this project.
        "subaccountId": "A String", # Subaccount ID of this project.
        "audienceGender": "A String", # Audience gender of this project.
        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
        "clientName": "A String", # Name of the project client.
        "accountId": "A String", # Account ID of this 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.regions.html000066400000000000000000000044071300622755700257500ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . regions

Instance Methods

list(profileId)

Retrieves a list of regions.

Method Details

list(profileId) 
Retrieves a list of regions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Region List Response
    "regions": [ # Region collection.
      { # Contains information about a region that can be targeted by ads.
        "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
        "countryDartId": "A String", # DART ID of the country to which this region belongs.
        "name": "A String", # Name of this region.
        "countryCode": "A String", # Country code of the country to which this region belongs.
        "regionCode": "A String", # Region code.
        "dartId": "A String", # DART ID of this region.
      },
    ],
    "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.remarketingListShares.html000066400000000000000000000146621300622755700306200ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingListShares

Instance Methods

get(profileId, remarketingListId)

Gets one remarketing list share by remarketing list ID.

patch(profileId, remarketingListId, body)

Updates an existing remarketing list share. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list share.

Method Details

get(profileId, remarketingListId) 
Gets one remarketing list share by remarketing list ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
patch(profileId, remarketingListId, body) 
Updates an existing remarketing list share. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
update(profileId, body) 
Updates an existing remarketing list share.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.remarketingLists.html000066400000000000000000001407631300622755700276370ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

insert(profileId, body)

Inserts a new remarketing list.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing remarketing list. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
insert(profileId, body) 
Inserts a new remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "remarketingLists": [ # Remarketing list collection.
      { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
          "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
            "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
            "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
              { # A group clause made up of list population terms representing constraints joined by ORs.
                "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
                  { # Remarketing List Population Rule Term.
                    "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                    "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                    "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                    "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                    "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                  },
                ],
              },
            ],
          },
          "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
          "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
          "description": "A String", # Remarketing list description.
          "listSize": "A String", # Number of users currently in the list. This is a read-only field.
          "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
          "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
          "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
          "listSource": "A String", # Product from which this remarketing list was originated.
          "active": True or False, # Whether this remarketing list is active.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        },
    ],
    "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
  }
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, id, body) 
Updates an existing remarketing list. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
update(profileId, body) 
Updates an existing remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.reports.compatibleFields.html000066400000000000000000001142221300622755700312420ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . compatibleFields

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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.reports.files.html000066400000000000000000000176051300622755700271050ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.reports.html000066400000000000000000007120561300622755700260060ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports

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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
              },
            ],
            "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.
            },
            "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.
              },
            ],
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
          },
          "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
          "subAccountId": "A String", # The subaccount 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.
                # 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. Note:
                # - "DAILY" also requires field "every" to be set.
                # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
                # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
            "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
              "A String",
            ],
          },
          "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              ],
            },
            "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
          },
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
          "fileName": "A String", # The filename used when generating report files for this report.
          "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.
            "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.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          "type": "A String", # The type of the report.
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "accountId": "A String", # The account ID to which this report belongs.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.sites.html000066400000000000000000001641231300622755700254330ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sites

Instance Methods

get(profileId, id)

Gets one site by ID.

insert(profileId, body)

Inserts a new site.

list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)

Retrieves a list of sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing site. This method supports patch semantics.

update(profileId, body)

Updates an existing site.

Method Details

get(profileId, id) 
Gets one site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None) 
Retrieves a list of sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
  campaignIds: string, Select only sites with these campaign IDs. (repeated)
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  adWordsSite: boolean, Select only AdWords sites.
  approved: boolean, Select only approved sites.
  searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
  subaccountId: string, Select only sites with this subaccount ID.
  directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only sites with these IDs. (repeated)

Returns:
  An object of the form:

    { # Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
    "sites": [ # Site collection.
      { # Contains properties of a site.
          "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
          "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
          "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteSettings": { # Site Settings # Site-wide settings.
            "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
            "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
            "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
            "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
            "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
              "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
              "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
              "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
              "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
            },
            "creativeSettings": { # Creative Settings # Site-wide creative settings.
              "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
              "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
            },
            "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
          },
          "approved": True or False, # Whether this site is approved.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteContacts": [ # Site contacts.
            { # Site Contact
              "firstName": "A String", # First name of this site contact.
              "title": "A String", # Title or designation of this site contact.
              "lastName": "A String", # Last name of this site contact.
              "address": "A String", # Address of this site contact.
              "email": "A String", # Email address of this site contact. This is a required field.
              "phone": "A String", # Primary phone number of this site contact.
              "contactType": "A String", # Site contact type.
              "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
            },
          ],
          "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this site. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing site. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.sizes.html000066400000000000000000000113601300622755700254330ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sizes

Instance Methods

get(profileId, id)

Gets one size by ID.

insert(profileId, body)

Inserts a new size.

list(profileId, iabStandard=None, width=None, ids=None, height=None)

Retrieves a list of sizes, possibly filtered.

Method Details

get(profileId, id) 
Gets one size by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Size ID. (required)

Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
insert(profileId, body) 
Inserts a new size.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents the dimensions of ads, placements, creatives, or creative assets.
  "width": 42, # Width of this size.
  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
  "height": 42, # Height of this size.
}


Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
list(profileId, iabStandard=None, width=None, ids=None, height=None) 
Retrieves a list of sizes, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  iabStandard: boolean, Select only IAB standard sizes.
  width: integer, Select only sizes with this width.
  ids: string, Select only sizes with these IDs. (repeated)
  height: integer, Select only sizes with this height.

Returns:
  An object of the form:

    { # Size List Response
    "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
    "sizes": [ # Size collection.
      { # Represents the dimensions of ads, placements, creatives, or creative assets.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.subaccounts.html000066400000000000000000000261311300622755700266310ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . subaccounts

Instance Methods

get(profileId, id)

Gets one subaccount by ID.

insert(profileId, body)

Inserts a new subaccount.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Gets a list of subaccounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing subaccount. This method supports patch semantics.

update(profileId, body)

Updates an existing subaccount.

Method Details

get(profileId, id) 
Gets one subaccount by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Gets a list of subaccounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only subaccounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Subaccount List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
    "subaccounts": [ # Subaccount collection.
      { # Contains properties of a DCM subaccount.
          "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
          "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
            "A String",
          ],
          "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
          "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
          "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing subaccount. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.targetableRemarketingLists.html000066400000000000000000000232141300622755700316210ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . targetableRemarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of targetable remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
    "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Targetable remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
    "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
    "listSource": "A String", # Product from which this targetable remarketing list was originated.
    "active": True or False, # Whether this targetable remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of targetable remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive targetable remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Targetable remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
    "targetableRemarketingLists": [ # Targetable remarketing list collection.
      { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
        "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
        "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        "description": "A String", # Targetable remarketing list description.
        "listSize": "A String", # Number of users currently in the list. This is a read-only field.
        "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
        "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
        "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
        "listSource": "A String", # Product from which this targetable remarketing list was originated.
        "active": True or False, # Whether this targetable remarketing list is active.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
        "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.userProfiles.html000066400000000000000000000067201300622755700267640ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userProfiles

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.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.userRolePermissionGroups.html000066400000000000000000000060741300622755700313550ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissionGroups

Instance Methods

get(profileId, id)

Gets one user role permission group by ID.

list(profileId)

Gets a list of all supported user role permission groups.

Method Details

get(profileId, id) 
Gets one user role permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission group ID. (required)

Returns:
  An object of the form:

    { # Represents a grouping of related user role permissions.
    "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
    "id": "A String", # ID of this user role permission.
    "name": "A String", # Name of this user role permission group.
  }
list(profileId) 
Gets a list of all supported user role permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # User Role Permission Group List Response
    "userRolePermissionGroups": [ # User role permission group collection.
      { # Represents a grouping of related user role permissions.
        "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
        "id": "A String", # ID of this user role permission.
        "name": "A String", # Name of this user role permission group.
      },
    ],
    "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.userRolePermissions.html000066400000000000000000000066751300622755700303470ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissions

Instance Methods

get(profileId, id)

Gets one user role permission by ID.

list(profileId, ids=None)

Gets a list of user role permissions, possibly filtered.

Method Details

get(profileId, id) 
Gets one user role permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a user role permission.
    "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
    "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
    "availability": "A String", # Levels of availability for a user role permission.
    "name": "A String", # Name of this user role permission.
    "id": "A String", # ID of this user role permission.
  }
list(profileId, ids=None) 
Gets a list of user role permissions, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Select only user role permissions with these IDs. (repeated)

Returns:
  An object of the form:

    { # User Role Permission List Response
    "userRolePermissions": [ # User role permission collection.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5.userRoles.html000066400000000000000000000523331300622755700262660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRoles

Instance Methods

delete(profileId, id)

Deletes an existing user role.

get(profileId, id)

Gets one user role by ID.

insert(profileId, body)

Inserts a new user role.

list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)

Retrieves a list of user roles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing user role. This method supports patch semantics.

update(profileId, body)

Updates an existing user role.

Method Details

delete(profileId, id) 
Deletes an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
get(profileId, id) 
Gets one user role by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)

Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None) 
Retrieves a list of user roles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
  subaccountId: string, Select only user roles that belong to this subaccount.
  pageToken: string, Value of the nextPageToken from the previous result page.
  ids: string, Select only user roles with the specified IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # User Role List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
    "userRoles": [ # User role collection.
      { # Contains properties of auser role, which is used to manage user access.
          "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
          "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
          "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
          "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
          "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
          "permissions": [ # List of permissions associated with this user role.
            { # Contains properties of a user role permission.
              "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
              "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
              "availability": "A String", # Levels of availability for a user role permission.
              "name": "A String", # Name of this user role permission.
              "id": "A String", # ID of this user role permission.
            },
          ],
          "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing user role. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.accountActiveAdSummaries.html000066400000000000000000000042401300622755700321350ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountActiveAdSummaries

Instance Methods

get(profileId, summaryAccountId)

Gets the account's active ad summary by account ID.

Method Details

get(profileId, summaryAccountId) 
Gets the account's active ad summary by account ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  summaryAccountId: string, Account ID. (required)

Returns:
  An object of the form:

    { # Gets a summary of active ads in an account.
    "availableAds": "A String", # Ads that can be activated for the account.
    "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
    "activeAds": "A String", # Ads that have been activated for the account
    "accountId": "A String", # ID of the account.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.accountPermissionGroups.html000066400000000000000000000063011300622755700321170ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissionGroups

Instance Methods

get(profileId, id)

Gets one account permission group by ID.

list(profileId)

Retrieves the list of account permission groups.

Method Details

get(profileId, id) 
Gets one account permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission group ID. (required)

Returns:
  An object of the form:

    { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
    "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
    "id": "A String", # ID of this account permission group.
    "name": "A String", # Name of this account permission group.
  }
list(profileId) 
Retrieves the list of account permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission Group List Response
    "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
    "accountPermissionGroups": [ # Account permission group collection.
      { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
        "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
        "id": "A String", # ID of this account permission group.
        "name": "A String", # Name of this account permission group.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.accountPermissions.html000066400000000000000000000077161300622755700311150ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissions

Instance Methods

get(profileId, id)

Gets one account permission by ID.

list(profileId)

Retrieves the list of account permissions.

Method Details

get(profileId, id) 
Gets one account permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission ID. (required)

Returns:
  An object of the form:

    { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
    "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
    "name": "A String", # Name of this account permission.
    "level": "A String", # Administrative level required to enable this account permission.
    "permissionGroupId": "A String", # Permission group of this account permission.
    "accountProfiles": [ # Account profiles associated with this account permission.
        #
        # Possible values are:
        # - "ACCOUNT_PROFILE_BASIC"
        # - "ACCOUNT_PROFILE_STANDARD"
      "A String",
    ],
    "id": "A String", # ID of this account permission.
  }
list(profileId) 
Retrieves the list of account permissions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission List Response
    "accountPermissions": [ # Account permission collection.
      { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
        "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
        "name": "A String", # Name of this account permission.
        "level": "A String", # Administrative level required to enable this account permission.
        "permissionGroupId": "A String", # Permission group of this account permission.
        "accountProfiles": [ # Account profiles associated with this account permission.
            #
            # Possible values are:
            # - "ACCOUNT_PROFILE_BASIC"
            # - "ACCOUNT_PROFILE_STANDARD"
          "A String",
        ],
        "id": "A String", # ID of this account permission.
      },
    ],
    "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.accountUserProfiles.html000066400000000000000000001271121300622755700312150ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountUserProfiles

Instance Methods

get(profileId, id)

Gets one account user profile by ID.

insert(profileId, body)

Inserts a new account user profile.

list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)

Retrieves a list of account user profiles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account user profile. This method supports patch semantics.

update(profileId, body)

Updates an existing account user profile.

Method Details

get(profileId, id) 
Gets one account user profile by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)

Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None) 
Retrieves a list of account user profiles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
  subaccountId: string, Select only user profiles with the specified subaccount ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only user profiles with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  userRoleId: string, Select only user profiles with the specified user role ID.
  active: boolean, Select only active user profiles.

Returns:
  An object of the form:

    { # Account User Profile List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "accountUserProfiles": [ # Account user profile collection.
      { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
          "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
          "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
          "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
          "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "locale": "A String", # Locale of the user profile. This is a required field.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "comments": "A String", # Comments for this user profile.
          "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
          "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "userRoleId": "A String", # User role ID of the user profile. This is a required field.
          "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
          "traffickerType": "A String", # Trafficker type of this user profile.
          "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
          "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
          "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
  }
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, id, body) 
Updates an existing account user profile. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.accounts.html000066400000000000000000001147161300622755700270430ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accounts

Instance Methods

get(profileId, id)

Gets one account by ID.

list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)

Retrieves the list of accounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account. This method supports patch semantics.

update(profileId, body)

Updates an existing account.

Method Details

get(profileId, id) 
Gets one account by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None) 
Retrieves the list of accounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only accounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.

Returns:
  An object of the form:

    { # Account List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
    "accounts": [ # Account collection.
      { # Contains properties of a DCM account.
          "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
          "countryId": "A String", # ID of the country associated with this account.
          "availablePermissionIds": [ # User role permissions available to the user roles of this account.
            "A String",
          ],
          "description": "A String", # Description of this account.
          "maximumImageSize": "A String", # Maximum image size allowed for this account.
          "currencyId": "A String", # ID of currency associated with this account. This is a required field.
              # Acceptable values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
          "accountPermissionIds": [ # Account permissions assigned to this account.
            "A String",
          ],
          "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
          "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
          "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
          "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
          "locale": "A String", # Locale of this account.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
          "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
            "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
                # Acceptable values are:
                #
                # - "1" for "America/New_York"
                # - "2" for "Europe/London"
                # - "3" for "Europe/Paris"
                # - "4" for "Africa/Johannesburg"
                # - "5" for "Asia/Jerusalem"
                # - "6" for "Asia/Shanghai"
                # - "7" for "Asia/Hong_Kong"
                # - "8" for "Asia/Tokyo"
                # - "9" for "Australia/Sydney"
                # - "10" for "Asia/Dubai"
                # - "11" for "America/Los_Angeles"
                # - "12" for "Pacific/Auckland"
                # - "13" for "America/Sao_Paulo"
            "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
            "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
          },
          "active": True or False, # Whether this account is active.
          "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
          "id": "A String", # ID of this account. This is a read-only, auto-generated field.
          "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
        },
    ],
  }
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, id, body) 
Updates an existing account. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
update(profileId, body) 
Updates an existing account.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.ads.html000066400000000000000000010522141300622755700257660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . ads

Instance Methods

get(profileId, id)

Gets one ad by ID.

insert(profileId, body)

Inserts a new ad.

list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)

Retrieves a list of ads, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing ad. This method supports patch semantics.

update(profileId, body)

Updates an existing ad.

Method Details

get(profileId, id) 
Gets one ad by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
insert(profileId, body) 
Inserts a new ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None) 
Retrieves a list of ads, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  landingPageIds: string, Select only ads with these landing page IDs. (repeated)
  overriddenEventTagId: string, Select only ads with this event tag override ID.
  campaignIds: string, Select only ads with these campaign IDs. (repeated)
  sizeIds: string, Select only ads with these size IDs. (repeated)
  archived: boolean, Select only archived ads.
  creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
  sslCompliant: boolean, Select only ads that are SSL-compliant.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only ads with these types. (repeated)
    Allowed values
      AD_SERVING_CLICK_TRACKER - 
      AD_SERVING_DEFAULT_AD - 
      AD_SERVING_STANDARD_AD - 
      AD_SERVING_TRACKING - 
  sslRequired: boolean, Select only ads that require SSL.
  creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
  remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  creativeType: string, Select only ads with the specified creativeType.
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_INPAGE - 
      CUSTOM_INTERSTITIAL - 
      ENHANCED_BANNER - 
      ENHANCED_IMAGE - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      REDIRECT - 
      RICH_MEDIA_EXPANDING - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_INTERSTITIAL_FLOAT - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_MULTI_FLOATING - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR - 
      VPAID_NON_LINEAR - 
  placementIds: string, Select only ads with these placement IDs assigned. (repeated)
  active: boolean, Select only active ads.
  compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  advertiserId: string, Select only ads with this advertiser ID.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
  audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
  ids: string, Select only ads with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Returns:
  An object of the form:

    { # Ad List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
    "ads": [ # Ad collection.
      { # Contains properties of a DCM ad.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
          "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
          "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
              { # Contains information about a country that can be targeted by ads.
                "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
                "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
                "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
                "countryCode": "A String", # Country code.
                "name": "A String", # Name of this country.
              },
            ],
            "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
            "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
              { # Contains information about a postal code that can be targeted by ads.
                "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
                "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
                "code": "A String", # Postal code. This is equivalent to the id field.
                "id": "A String", # ID of this postal code.
                "countryCode": "A String", # Country code of the country to which this postal code belongs.
              },
            ],
            "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
              { # Contains information about a region that can be targeted by ads.
                "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
                "countryDartId": "A String", # DART ID of the country to which this region belongs.
                "name": "A String", # Name of this region.
                "countryCode": "A String", # Country code of the country to which this region belongs.
                "regionCode": "A String", # Region code.
                "dartId": "A String", # DART ID of this region.
              },
            ],
            "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
              { # Contains information about a city that can be targeted by ads.
                "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
                "countryDartId": "A String", # DART ID of the country to which this city belongs.
                "name": "A String", # Name of this city.
                "countryCode": "A String", # Country code of the country to which this city belongs.
                "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
                "regionCode": "A String", # Region code of the region to which this city belongs.
                "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
                "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
                "regionDartId": "A String", # DART ID of the region to which this city belongs.
              },
            ],
            "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
              { # Contains information about a metro region that can be targeted by ads.
                "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
                "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
                "name": "A String", # Name of this metro region.
                "countryCode": "A String", # Country code of the country to which this metro region belongs.
                "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
                "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
                "dartId": "A String", # DART ID of this metro region.
              },
            ],
          },
          "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
            "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
            "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
            "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
              "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
              "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
            },
            "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Event tag overrides for this ad.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this ad is archived.
          "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a platform type that can be targeted by ads.
                "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
                "id": "A String", # ID of this platform type.
                "name": "A String", # Name of this platform type.
              },
            ],
            "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
              { # Contains information about a particular version of an operating system that can be targeted by ads.
                "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
                "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
                "name": "A String", # Name of this operating system version.
                "id": "A String", # ID of this operating system version.
                "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
                  "mobile": True or False, # Whether this operating system is for mobile.
                  "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                  "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                  "name": "A String", # Name of this operating system.
                  "desktop": True or False, # Whether this operating system is for desktop.
                },
                "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
              },
            ],
            "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a browser that can be targeted by ads.
                "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
                "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
                "name": "A String", # Name of this browser.
                "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
                "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
                "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
              },
            ],
            "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
              { # Contains information about an operating system that can be targeted by ads.
                "mobile": True or False, # Whether this operating system is for mobile.
                "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                "name": "A String", # Name of this operating system.
                "desktop": True or False, # Whether this operating system is for desktop.
              },
            ],
            "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
              { # Contains information about a mobile carrier that can be targeted by ads.
                "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
                "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
                "id": "A String", # ID of this mobile carrier.
                "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
                "name": "A String", # Name of this mobile carrier.
              },
            ],
            "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
                "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
                "id": "A String", # ID of this connection type.
                "name": "A String", # Name of this connection type.
              },
            ],
          },
          "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
            "creativeAssignments": [ # Creative assignments in this creative rotation.
              { # Creative Assignment.
                "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
                "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
                "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
                "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                    # Applicable when the creative type is any of the following:
                    # - RICH_MEDIA_INPAGE
                    # - RICH_MEDIA_INPAGE_FLOATING
                    # - RICH_MEDIA_IM_EXPAND
                    # - RICH_MEDIA_EXPANDING
                    # - RICH_MEDIA_INTERSTITIAL_FLOAT
                    # - RICH_MEDIA_MOBILE_IN_APP
                    # - RICH_MEDIA_MULTI_FLOATING
                    # - RICH_MEDIA_PEEL_DOWN
                    # - ADVANCED_BANNER
                    # - VPAID_LINEAR
                    # - VPAID_NON_LINEAR
                  { # Rich Media Exit Override.
                    "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                    "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                    "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
                  },
                ],
                "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
                "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
                  { # Creative Group Assignment.
                    "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                    "creativeGroupId": "A String", # ID of the creative group to be assigned.
                  },
                ],
                "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
                  { # Companion Click-through override.
                    "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                    },
                    "creativeId": "A String", # ID of the creative for this companion click-through override.
                  },
                ],
                "startTime": "A String", # Date and time that the assigned creative should start serving.
                "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
                "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
                "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
                "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              },
            ],
            "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
            "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
            "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
          },
          "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "comments": "A String", # Comments for this ad.
          "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Expression describing which lists are being targeted by the ad.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
          "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
          "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Keyword expression being targeted by the ad.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
          "active": True or False, # Whether this ad is active.
          "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
          "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
          "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
          "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
          "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
            "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
              42,
            ],
            "daysOfWeek": [ # Days of the week when the ad will serve.
                #
                # Acceptable values are:
                # - "SUNDAY"
                # - "MONDAY"
                # - "TUESDAY"
                # - "WEDNESDAY"
                # - "THURSDAY"
                # - "FRIDAY"
                # - "SATURDAY"
              "A String",
            ],
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "placementAssignments": [ # Placement assignments for this ad.
            { # Placement Assignment.
              "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
              "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "placementId": "A String", # ID of the placement to be assigned. This is a required field.
              "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
            },
          ],
          "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
          "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
        },
    ],
  }
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, id, body) 
Updates an existing ad. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
update(profileId, body) 
Updates an existing ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.advertiserGroups.html000066400000000000000000000263011300622755700305640ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertiserGroups

Instance Methods

delete(profileId, id)

Deletes an existing advertiser group.

get(profileId, id)

Gets one advertiser group by ID.

insert(profileId, body)

Inserts a new advertiser group.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of advertiser groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser group. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser group.

Method Details

delete(profileId, id) 
Deletes an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
get(profileId, id) 
Gets one advertiser group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of advertiser groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only advertiser groups with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Advertiser Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
    "advertiserGroups": [ # Advertiser group collection.
      { # Groups advertisers together so that reports can be generated for the entire group at once.
          "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
          "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
          "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing advertiser group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.advertisers.html000066400000000000000000001217161300622755700275550ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertisers

Instance Methods

get(profileId, id)

Gets one advertiser by ID.

insert(profileId, body)

Inserts a new advertiser.

list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)

Retrieves a list of advertisers, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser.

Method Details

get(profileId, id) 
Gets one advertiser by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None) 
Retrieves a list of advertisers, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
  onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  status: string, Select only advertisers with the specified status.
    Allowed values
      APPROVED - 
      ON_HOLD - 
  maxResults: integer, Maximum number of results to return.
  advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
  subaccountId: string, Select only advertisers with these subaccount IDs.
  ids: string, Select only advertisers with these IDs. (repeated)
  floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Advertiser List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "advertisers": [ # Advertiser collection.
      { # Contains properties of a DCM advertiser.
          "status": "A String", # Status of this advertiser.
          "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
          "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
          "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
          "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
          "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
          "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
              # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
              # - This advertiser's original floodlight configuration is not already shared with another advertiser.
          "suspended": True or False, # Suspension status of this advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultEmail": "A String", # Default email address used in sender field for tag emails.
          "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
  }
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, id, body) 
Updates an existing advertiser. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.browsers.html000066400000000000000000000065421300622755700270670ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . browsers

Instance Methods

list(profileId)

Retrieves a list of browsers.

Method Details

list(profileId) 
Retrieves a list of browsers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Browser List Response
    "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
    "browsers": [ # Browser collection.
      { # Contains information about a browser that can be targeted by ads.
        "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
        "name": "A String", # Name of this browser.
        "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
        "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
        "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.campaignCreativeAssociations.html000066400000000000000000000121101300622755700330270ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaignCreativeAssociations

Instance Methods

insert(profileId, campaignId, body)

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)

Retrieves the list of creative IDs associated with the specified campaign.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

insert(profileId, campaignId, body) 
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Identifies a creative which has been associated with a given campaign.
    "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
    "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
  }


Returns:
  An object of the form:

    { # Identifies a creative which has been associated with a given campaign.
      "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
      "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
    }
list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves the list of creative IDs associated with the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Campaign Creative Association List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "campaignCreativeAssociations": [ # Campaign creative association collection
      { # Identifies a creative which has been associated with a given campaign.
          "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
          "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
        },
    ],
    "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.campaigns.html000066400000000000000000003133731300622755700271660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaigns

Instance Methods

get(profileId, id)

Gets one campaign by ID.

insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)

Inserts a new campaign.

list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)

Retrieves a list of campaigns, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing campaign. This method supports patch semantics.

update(profileId, body)

Updates an existing campaign.

Method Details

get(profileId, id) 
Gets one campaign by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body) 
Inserts a new campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
  defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None) 
Retrieves a list of campaigns, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
  archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
  advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  excludedIds: string, Exclude campaigns with these IDs. (repeated)
  advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
  searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
  subaccountId: string, Select only campaigns that belong to this subaccount.
  ids: string, Select only campaigns with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.

Returns:
  An object of the form:

    { # Campaign List Response
    "campaigns": [ # Campaign collection.
      { # Contains properties of a DCM campaign.
          "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
          "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
          "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
            "optimizationActivitys": [ # List of optimization activities associated with this configuration.
              { # Creative optimization activity.
                "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
                "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
              },
            ],
            "optimizationModel": "A String", # Optimization model for this configuration.
            "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
            "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
          },
          "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
          "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
          "traffickerEmails": [ # Campaign trafficker contact emails.
            "A String",
          ],
          "archived": True or False, # Whether this campaign has been archived.
          "externalId": "A String", # External ID for this campaign.
          "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
          "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
          "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
            "A String",
          ],
          "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
            { # Creative optimization settings.
              "optimizationActivitys": [ # List of optimization activities associated with this configuration.
                { # Creative optimization activity.
                  "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                  "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                    "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                  },
                  "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
                },
              ],
              "optimizationModel": "A String", # Optimization model for this configuration.
              "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
              "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
            },
          ],
          "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
          "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
          "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
            { # Audience Segment Group.
              "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
                { # Audience Segment.
                  "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
                  "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
                  "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
                },
              ],
              "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
            },
          ],
        },
    ],
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
  }
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, id, body) 
Updates an existing campaign. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
update(profileId, body) 
Updates an existing campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.changeLogs.html000066400000000000000000000214651300622755700272740ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . changeLogs

Instance Methods

get(profileId, id)

Gets one change log by ID.

list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)

Retrieves a list of change logs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one change log by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Change log ID. (required)

Returns:
  An object of the form:

    { # Describes a change that a user has made to a resource.
    "changeTime": "A String", # Time when the object was modified.
    "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
    "subaccountId": "A String", # Subaccount ID of the modified object.
    "userProfileId": "A String", # ID of the user who modified the object.
    "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
    "newValue": "A String", # New value of the object field.
    "userProfileName": "A String", # User profile name of the user who modified the object.
    "fieldName": "A String", # Field name of the object which changed.
    "oldValue": "A String", # Old value of the object field.
    "action": "A String", # Action which caused the change.
    "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
    "objectType": "A String", # Object type of the change log.
    "id": "A String", # ID of this change log.
    "accountId": "A String", # Account ID of the modified object.
  }
list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None) 
Retrieves a list of change logs.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectType: string, Select only change logs with the specified object type.
    Allowed values
      OBJECT_ACCOUNT - 
      OBJECT_ACCOUNT_BILLING_FEATURE - 
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_ADVERTISER_GROUP - 
      OBJECT_BILLING_ACCOUNT_GROUP - 
      OBJECT_BILLING_FEATURE - 
      OBJECT_BILLING_MINIMUM_FEE - 
      OBJECT_BILLING_PROFILE - 
      OBJECT_CAMPAIGN - 
      OBJECT_CONTENT_CATEGORY - 
      OBJECT_CREATIVE - 
      OBJECT_CREATIVE_ASSET - 
      OBJECT_CREATIVE_BUNDLE - 
      OBJECT_CREATIVE_FIELD - 
      OBJECT_CREATIVE_GROUP - 
      OBJECT_DFA_SITE - 
      OBJECT_EVENT_TAG - 
      OBJECT_FLOODLIGHT_ACTIVITY_GROUP - 
      OBJECT_FLOODLIGHT_ACTVITY - 
      OBJECT_FLOODLIGHT_CONFIGURATION - 
      OBJECT_INSTREAM_CREATIVE - 
      OBJECT_LANDING_PAGE - 
      OBJECT_MEDIA_ORDER - 
      OBJECT_PLACEMENT - 
      OBJECT_PLACEMENT_STRATEGY - 
      OBJECT_PLAYSTORE_LINK - 
      OBJECT_PROVIDED_LIST_CLIENT - 
      OBJECT_RATE_CARD - 
      OBJECT_REMARKETING_LIST - 
      OBJECT_RICHMEDIA_CREATIVE - 
      OBJECT_SD_SITE - 
      OBJECT_SIZE - 
      OBJECT_SUBACCOUNT - 
      OBJECT_TARGETING_TEMPLATE - 
      OBJECT_USER_PROFILE - 
      OBJECT_USER_PROFILE_FILTER - 
      OBJECT_USER_ROLE - 
  maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxResults: integer, Maximum number of results to return.
  action: string, Select only change logs with the specified action.
    Allowed values
      ACTION_ADD - 
      ACTION_ASSIGN - 
      ACTION_ASSOCIATE - 
      ACTION_CREATE - 
      ACTION_DELETE - 
      ACTION_DISABLE - 
      ACTION_EMAIL_TAGS - 
      ACTION_ENABLE - 
      ACTION_LINK - 
      ACTION_MARK_AS_DEFAULT - 
      ACTION_PUSH - 
      ACTION_REMOVE - 
      ACTION_SEND - 
      ACTION_SHARE - 
      ACTION_UNASSIGN - 
      ACTION_UNLINK - 
      ACTION_UPDATE - 
  minChangeTime: string, Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
  userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
  ids: string, Select only change logs with these IDs. (repeated)
  objectIds: string, Select only change logs with these object IDs. (repeated)

Returns:
  An object of the form:

    { # Change Log List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
    "changeLogs": [ # Change log collection.
      { # Describes a change that a user has made to a resource.
        "changeTime": "A String", # Time when the object was modified.
        "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
        "subaccountId": "A String", # Subaccount ID of the modified object.
        "userProfileId": "A String", # ID of the user who modified the object.
        "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
        "newValue": "A String", # New value of the object field.
        "userProfileName": "A String", # User profile name of the user who modified the object.
        "fieldName": "A String", # Field name of the object which changed.
        "oldValue": "A String", # Old value of the object field.
        "action": "A String", # Action which caused the change.
        "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
        "objectType": "A String", # Object type of the change log.
        "id": "A String", # ID of this change log.
        "accountId": "A String", # Account ID of the modified object.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.cities.html000066400000000000000000000061371300622755700265010ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . cities

Instance Methods

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)

Retrieves a list of cities, possibly filtered.

Method Details

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None) 
Retrieves a list of cities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartIds: string, Select only cities with these DART IDs. (repeated)
  namePrefix: string, Select only cities with names starting with this prefix.
  regionDartIds: string, Select only cities from these regions. (repeated)
  countryDartIds: string, Select only cities from these countries. (repeated)

Returns:
  An object of the form:

    { # City List Response
    "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
    "cities": [ # City collection.
      { # Contains information about a city that can be targeted by ads.
        "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
        "countryDartId": "A String", # DART ID of the country to which this city belongs.
        "name": "A String", # Name of this city.
        "countryCode": "A String", # Country code of the country to which this city belongs.
        "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
        "regionCode": "A String", # Region code of the region to which this city belongs.
        "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
        "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
        "regionDartId": "A String", # DART ID of the region to which this city belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.connectionTypes.html000066400000000000000000000061431300622755700304020ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . connectionTypes

Instance Methods

get(profileId, id)

Gets one connection type by ID.

list(profileId)

Retrieves a list of connection types.

Method Details

get(profileId, id) 
Gets one connection type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Connection type ID. (required)

Returns:
  An object of the form:

    { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
    "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
    "id": "A String", # ID of this connection type.
    "name": "A String", # Name of this connection type.
  }
list(profileId) 
Retrieves a list of connection types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Connection Type List Response
    "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
    "connectionTypes": [ # Collection of connection types such as broadband and mobile.
      { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
        "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
        "id": "A String", # ID of this connection type.
        "name": "A String", # Name of this connection type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.contentCategories.html000066400000000000000000000261431300622755700307000ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . contentCategories

Instance Methods

delete(profileId, id)

Deletes an existing content category.

get(profileId, id)

Gets one content category by ID.

insert(profileId, body)

Inserts a new content category.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of content categories, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing content category. This method supports patch semantics.

update(profileId, body)

Updates an existing content category.

Method Details

delete(profileId, id) 
Deletes an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
get(profileId, id) 
Gets one content category by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)

Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of content categories, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only content categories with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Content Category List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
    "contentCategories": [ # Content category collection.
      { # Organizes placements according to the contents of their associated webpages.
          "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
          "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
          "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
          "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing content category. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.conversions.html000066400000000000000000000201771300622755700275710ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . conversions

Instance Methods

batchinsert(profileId, body)

Inserts conversions.

Method Details

batchinsert(profileId, body) 
Inserts conversions.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Insert Conversions Request.
    "conversions": [ # The set of conversions to insert.
      { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
        "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
        "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
        "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
        "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
        "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
        "customVariables": [ # Custom floodlight variables.
          { # A custom floodlight variable.
            "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
            "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
            "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
          },
        ],
        "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
        "value": 3.14, # The value of the conversion.
        "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
        "quantity": "A String", # The quantity of the conversion.
        "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
        "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
      },
    ],
    "kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
    "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
      "kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
      "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
      "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
      "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
    },
  }


Returns:
  An object of the form:

    { # Insert Conversions Response.
    "status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
      { # The original conversion that was inserted or updated and whether there were any errors.
        "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
          "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
          "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
          "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
          "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
          "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
          "customVariables": [ # Custom floodlight variables.
            { # A custom floodlight variable.
              "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
              "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
              "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
            },
          ],
          "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
          "value": 3.14, # The value of the conversion.
          "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
          "quantity": "A String", # The quantity of the conversion.
          "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
          "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
        },
        "errors": [ # A list of errors related to this conversion.
          { # The error code and description for a conversion that failed to insert or update.
            "kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
            "code": "A String", # The error code.
            "message": "A String", # A description of the error.
          },
        ],
        "kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
      },
    ],
    "hasFailures": True or False, # Indicates that some or all conversions failed to insert.
    "kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.countries.html000066400000000000000000000062651300622755700272360ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . countries

Instance Methods

get(profileId, dartId)

Gets one country by ID.

list(profileId)

Retrieves a list of countries.

Method Details

get(profileId, dartId) 
Gets one country by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Country DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about a country that can be targeted by ads.
    "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
    "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
    "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
    "countryCode": "A String", # Country code.
    "name": "A String", # Name of this country.
  }
list(profileId) 
Retrieves a list of countries.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Country List Response
    "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
    "countries": [ # Country collection.
      { # Contains information about a country that can be targeted by ads.
        "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
        "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
        "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
        "countryCode": "A String", # Country code.
        "name": "A String", # Name of this country.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.creativeAssets.html000066400000000000000000000172621300622755700302070ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeAssets

Instance Methods

insert(profileId, advertiserId, body=None, media_body=None)

Inserts a new creative asset.

Method Details

insert(profileId, advertiserId, body=None, media_body=None) 
Inserts a new creative asset.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
  body: object, The request body.
    The object takes the form of:

{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
    "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
        # 
        # Possible values are:
        # - "ADMOB_REFERENCED"
        # - "ASSET_FORMAT_UNSUPPORTED_DCM"
        # - "ASSET_INVALID"
        # - "CLICK_TAG_HARD_CODED"
        # - "CLICK_TAG_INVALID"
        # - "CLICK_TAG_IN_GWD"
        # - "CLICK_TAG_MISSING"
        # - "CLICK_TAG_MORE_THAN_ONE"
        # - "CLICK_TAG_NON_TOP_LEVEL"
        # - "COMPONENT_UNSUPPORTED_DCM"
        # - "ENABLER_UNSUPPORTED_METHOD_DCM"
        # - "EXTERNAL_FILE_REFERENCED"
        # - "FILE_DETAIL_EMPTY"
        # - "FILE_TYPE_INVALID"
        # - "GWD_PROPERTIES_INVALID"
        # - "HTML5_FEATURE_UNSUPPORTED"
        # - "LINKED_FILE_NOT_FOUND"
        # - "MAX_FLASH_VERSION_11"
        # - "MRAID_REFERENCED"
        # - "NOT_SSL_COMPLIANT"
        # - "ORPHANED_ASSET"
        # - "PRIMARY_HTML_MISSING"
        # - "SVG_INVALID"
        # - "ZIP_INVALID"
      "A String",
    ],
    "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
      "A String",
    ],
    "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
    "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
      "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
      "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
    },
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
      "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
          #
          # Possible values are:
          # - "ADMOB_REFERENCED"
          # - "ASSET_FORMAT_UNSUPPORTED_DCM"
          # - "ASSET_INVALID"
          # - "CLICK_TAG_HARD_CODED"
          # - "CLICK_TAG_INVALID"
          # - "CLICK_TAG_IN_GWD"
          # - "CLICK_TAG_MISSING"
          # - "CLICK_TAG_MORE_THAN_ONE"
          # - "CLICK_TAG_NON_TOP_LEVEL"
          # - "COMPONENT_UNSUPPORTED_DCM"
          # - "ENABLER_UNSUPPORTED_METHOD_DCM"
          # - "EXTERNAL_FILE_REFERENCED"
          # - "FILE_DETAIL_EMPTY"
          # - "FILE_TYPE_INVALID"
          # - "GWD_PROPERTIES_INVALID"
          # - "HTML5_FEATURE_UNSUPPORTED"
          # - "LINKED_FILE_NOT_FOUND"
          # - "MAX_FLASH_VERSION_11"
          # - "MRAID_REFERENCED"
          # - "NOT_SSL_COMPLIANT"
          # - "ORPHANED_ASSET"
          # - "PRIMARY_HTML_MISSING"
          # - "SVG_INVALID"
          # - "ZIP_INVALID"
        "A String",
      ],
      "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
        "A String",
      ],
      "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
      "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
        "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
        "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.creativeFieldValues.html000066400000000000000000000241701300622755700311440ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFieldValues

Instance Methods

delete(profileId, creativeFieldId, id)

Deletes an existing creative field value.

get(profileId, creativeFieldId, id)

Gets one creative field value by ID.

insert(profileId, creativeFieldId, body)

Inserts a new creative field value.

list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)

Retrieves a list of creative field values, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, creativeFieldId, id, body)

Updates an existing creative field value. This method supports patch semantics.

update(profileId, creativeFieldId, body)

Updates an existing creative field value.

Method Details

delete(profileId, creativeFieldId, id) 
Deletes an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
get(profileId, creativeFieldId, id) 
Gets one creative field value by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
insert(profileId, creativeFieldId, body) 
Inserts a new creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves a list of creative field values, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      VALUE - 
  ids: string, Select only creative field values with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field Value List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
    "creativeFieldValues": [ # Creative field value collection.
      { # Contains properties of a creative field value.
          "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
          "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
          "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
        },
    ],
  }
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, creativeFieldId, id, body) 
Updates an existing creative field value. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
update(profileId, creativeFieldId, body) 
Updates an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.creativeFields.html000066400000000000000000000500351300622755700301460ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFields

Instance Methods

delete(profileId, id)

Deletes an existing creative field.

get(profileId, id)

Gets one creative field by ID.

insert(profileId, body)

Inserts a new creative field.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of creative fields, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative field. This method supports patch semantics.

update(profileId, body)

Updates an existing creative field.

Method Details

delete(profileId, id) 
Deletes an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
get(profileId, id) 
Gets one creative field by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of creative fields, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
  ids: string, Select only creative fields with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeFields": [ # Creative field collection.
      { # Contains properties of a creative field.
          "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
          "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
          "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
  }
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, id, body) 
Updates an existing creative field. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.creativeGroups.html000066400000000000000000000541571300622755700302300ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeGroups

Instance Methods

get(profileId, id)

Gets one creative group by ID.

insert(profileId, body)

Inserts a new creative group.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)

Retrieves a list of creative groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative group. This method supports patch semantics.

update(profileId, body)

Updates an existing creative group.

Method Details

get(profileId, id) 
Gets one creative group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None) 
Retrieves a list of creative groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
  groupNumber: integer, Select only creative groups that belong to this subgroup.
  maxResults: integer, Maximum number of results to return.
  ids: string, Select only creative groups with these IDs. (repeated)
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeGroups": [ # Creative group collection.
      { # Contains properties of a creative group.
          "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
          "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
          "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
              # Acceptable values are:
              # - 1
              # - 2
          "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
  }
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, id, body) 
Updates an existing creative group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.creatives.html000066400000000000000000012432101300622755700272020ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creatives

Instance Methods

get(profileId, id)

Gets one creative by ID.

insert(profileId, body)

Inserts a new creative.

list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)

Retrieves a list of creatives, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative. This method supports patch semantics.

update(profileId, body)

Updates an existing creative.

Method Details

get(profileId, id) 
Gets one creative by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
insert(profileId, body) 
Inserts a new creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None) 
Retrieves a list of creatives, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only creatives with this campaign ID.
  advertiserId: string, Select only creatives with this advertiser ID.
  sizeIds: string, Select only creatives with these size IDs. (repeated)
  archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  renderingIds: string, Select only creatives with these rendering IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
  companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
  types: string, Select only creatives with these creative types. (repeated)
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_INPAGE - 
      CUSTOM_INTERSTITIAL - 
      ENHANCED_BANNER - 
      ENHANCED_IMAGE - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      REDIRECT - 
      RICH_MEDIA_EXPANDING - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_INTERSTITIAL_FLOAT - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_MULTI_FLOATING - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR - 
      VPAID_NON_LINEAR - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
  ids: string, Select only creatives with these IDs. (repeated)
  studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)

Returns:
  An object of the form:

    { # Creative List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
    "creatives": [ # Creative collection.
      { # Contains properties of a Creative.
          "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            { # Third-party Tracking URL.
              "url": "A String", # URL for the specified third-party URL type.
              "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
            },
          ],
          "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
          "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
          "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
            "windowHeight": 42, # Height of the window.
            "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
            "windowWidth": 42, # Width of the window.
            "positionOption": "A String", # Position in the browser where the window will open.
            "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
          },
          "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
          "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
          "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
          "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
          "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
          "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
          "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
            { # Creative Field Assignment.
              "creativeFieldId": "A String", # ID of the creative field.
              "creativeFieldValueId": "A String", # ID of the creative field value.
            },
          ],
          "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
          "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
          "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
          "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
            { # Creative Asset.
              "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
              "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
                "A String",
              ],
              "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
              "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
              "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
              "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
              "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
                  # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
                  # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
                  # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
                  # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
                  # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
                  # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
                  # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
                  # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
              "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
              "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
              "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
              "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
              "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
              "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
                "targetType": "A String", # Target type used by the event.
                "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
                "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
                "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                  "showStatusBar": True or False, # Whether to display the browser status bar.
                  "showScrollBar": True or False, # Whether to display the browser scroll bar.
                  "showAddressBar": True or False, # Whether to display the browser address bar.
                  "showMenuBar": True or False, # Whether to display the browser menu bar.
                  "title": "A String", # Title of popup window.
                  "showToolBar": True or False, # Whether to display the browser tool bar.
                  "positionType": "A String", # Popup window position either centered or at specific coordinate.
                  "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                    "top": 42, # Offset distance from top side of an asset or a window.
                    "left": 42, # Offset distance from left side of an asset or a window.
                  },
                  "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                    "width": 42, # Width of this size.
                    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                    "height": 42, # Height of this size.
                  },
                },
                "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
                "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
                "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
                "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
                "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
                "advertiserCustomEventName": "A String", # User-entered name for the event.
              },
              "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
              "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
                "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
                "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
              },
              "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
              "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
            },
          ],
          "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
          "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
          "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
          "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            { # Creative Click Tag.
              "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
              "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
              "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
            },
          ],
          "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "active": True or False, # Whether the creative is active. Applicable to all creative types.
          "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
              #
              # Acceptable values are:
              # - "APP"
              # - "APP_INTERSTITIAL"
              # - "IN_STREAM_VIDEO"
              # - "DISPLAY"
              # - "DISPLAY_INTERSTITIAL"
            "A String",
          ],
          "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
          "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
          "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
          "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
          "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
          "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
          "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            "A String",
          ],
          "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
          "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
            "A String",
          ],
          "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "customHtml": "A String", # User-entered value.
            "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
          },
          "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        },
    ],
  }
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, id, body) 
Updates an existing creative. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
update(profileId, body) 
Updates an existing creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
          "A String",
        ],
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
        "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "A String",
    ],
    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
            "A String",
          ],
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
          "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        "A String",
      ],
      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.dimensionValues.html000066400000000000000000000115451300622755700303650ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dimensionValues

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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.directorySiteContacts.html000066400000000000000000000142501300622755700315440ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySiteContacts

Instance Methods

get(profileId, id)

Gets one directory site contact by ID.

list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of directory site contacts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site contact by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site contact ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Site Directory contact.
    "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
    "firstName": "A String", # First name of this directory site contact.
    "title": "A String", # Title or designation of this directory site contact.
    "lastName": "A String", # Last name of this directory site contact.
    "email": "A String", # Email address of this directory site contact.
    "phone": "A String", # Phone number of this directory site contact.
    "role": "A String", # Directory site contact role.
    "address": "A String", # Address of this directory site contact.
    "type": "A String", # Directory site contact type.
    "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
  }
list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of directory site contacts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
  directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory site contacts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Directory Site Contact List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "directorySiteContacts": [ # Directory site contact collection
      { # Contains properties of a Site Directory contact.
        "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
        "firstName": "A String", # First name of this directory site contact.
        "title": "A String", # Title or designation of this directory site contact.
        "lastName": "A String", # Last name of this directory site contact.
        "email": "A String", # Email address of this directory site contact.
        "phone": "A String", # Phone number of this directory site contact.
        "role": "A String", # Directory site contact role.
        "address": "A String", # Address of this directory site contact.
        "type": "A String", # Directory site contact type.
        "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
      },
    ],
    "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.directorySites.html000066400000000000000000000667731300622755700302510ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySites

Instance Methods

get(profileId, id)

Gets one directory site by ID.

insert(profileId, body)

Inserts a new directory site.

list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)

Retrieves a list of directory sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site ID. (required)

Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
insert(profileId, body) 
Inserts a new directory site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
    "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
    "countryId": "A String", # Country ID of this directory site.
    "description": "A String", # Description of this directory site.
    "settings": { # Directory Site Settings # Directory site settings.
      "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
      "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
      "dfp_settings": { # DFP Settings # Directory site DFP settings.
        "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
        "dfp_network_name": "A String", # DFP network name for this directory site.
        "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
        "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
        "dfp_network_code": "A String", # DFP network code for this directory site.
      },
      "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
      "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
      "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
      "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
    },
    "currencyId": "A String", # Currency ID of this directory site.
        # Possible values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "inpageTagFormats": [ # Tag types for regular placements.
        # 
        # Acceptable values are:
        # - "STANDARD"
        # - "IFRAME_JAVASCRIPT_INPAGE"
        # - "INTERNAL_REDIRECT_INPAGE"
        # - "JAVASCRIPT_INPAGE"
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "interstitialTagFormats": [ # Tag types for interstitial placements.
        # 
        # Acceptable values are:
        # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
        # - "INTERNAL_REDIRECT_INTERSTITIAL"
        # - "JAVASCRIPT_INTERSTITIAL"
      "A String",
    ],
    "contactAssignments": [ # Directory site contacts.
      { # Directory Site Contact Assignment
        "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
        "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
      },
    ],
    "url": "A String", # URL of this directory site.
    "parentId": "A String", # Parent directory site ID.
    "active": True or False, # Whether this directory site is active.
    "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
    "name": "A String", # Name of this directory site.
  }


Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None) 
Retrieves a list of directory sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  countryId: string, Select only directory sites with this country ID.
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  parentId: string, Select only directory sites with this parent ID.
  acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
  searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory sites with these IDs. (repeated)
  dfp_network_code: string, Select only directory sites with this DFP network code.

Returns:
  An object of the form:

    { # Directory Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
    "directorySites": [ # Directory site collection.
      { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
          "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
          "countryId": "A String", # Country ID of this directory site.
          "description": "A String", # Description of this directory site.
          "settings": { # Directory Site Settings # Directory site settings.
            "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
            "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
            "dfp_settings": { # DFP Settings # Directory site DFP settings.
              "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
              "dfp_network_name": "A String", # DFP network name for this directory site.
              "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
              "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
              "dfp_network_code": "A String", # DFP network code for this directory site.
            },
            "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
            "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
            "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
            "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
          },
          "currencyId": "A String", # Currency ID of this directory site.
              # Possible values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "inpageTagFormats": [ # Tag types for regular placements.
              #
              # Acceptable values are:
              # - "STANDARD"
              # - "IFRAME_JAVASCRIPT_INPAGE"
              # - "INTERNAL_REDIRECT_INPAGE"
              # - "JAVASCRIPT_INPAGE"
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "interstitialTagFormats": [ # Tag types for interstitial placements.
              #
              # Acceptable values are:
              # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
              # - "INTERNAL_REDIRECT_INTERSTITIAL"
              # - "JAVASCRIPT_INTERSTITIAL"
            "A String",
          ],
          "contactAssignments": [ # Directory site contacts.
            { # Directory Site Contact Assignment
              "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
              "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
            },
          ],
          "url": "A String", # URL of this directory site.
          "parentId": "A String", # Parent directory site ID.
          "active": True or False, # Whether this directory site is active.
          "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
          "name": "A String", # Name of this directory site.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.dynamicTargetingKeys.html000066400000000000000000000162751300622755700313520ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dynamicTargetingKeys

Instance Methods

delete(profileId, objectId, name, objectType)

Deletes an existing dynamic targeting key.

insert(profileId, body)

Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)

Retrieves a list of dynamic targeting keys.

Method Details

delete(profileId, objectId, name, objectType) 
Deletes an existing dynamic targeting key.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
  name: string, Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. (required)
  objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
    Allowed values
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_CREATIVE - 
      OBJECT_PLACEMENT -
insert(profileId, body) 
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
    "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
    "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
    "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
    "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
  }


Returns:
  An object of the form:

    { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
      "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
      "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
      "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
      "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
    }
list(profileId, advertiserId=None, objectId=None, names=None, objectType=None) 
Retrieves a list of dynamic targeting keys.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
  objectId: string, Select only dynamic targeting keys with this object ID.
  names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
  objectType: string, Select only dynamic targeting keys with this object type.
    Allowed values
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_CREATIVE - 
      OBJECT_PLACEMENT - 

Returns:
  An object of the form:

    { # Dynamic Targeting Key List Response
    "kind": "dfareporting#dynamicTargetingKeysListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
    "dynamicTargetingKeys": [ # Dynamic targeting key collection.
      { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
          "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
          "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
          "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
          "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.eventTags.html000066400000000000000000001224101300622755700271520ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . eventTags

Instance Methods

delete(profileId, id)

Deletes an existing event tag.

get(profileId, id)

Gets one event tag by ID.

insert(profileId, body)

Inserts a new event tag.

list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)

Retrieves a list of event tags, possibly filtered.

patch(profileId, id, body)

Updates an existing event tag. This method supports patch semantics.

update(profileId, body)

Updates an existing event tag.

Method Details

delete(profileId, id) 
Deletes an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
get(profileId, id) 
Gets one event tag by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)

Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None) 
Retrieves a list of event tags, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only event tags that belong to this campaign.
  advertiserId: string, Select only event tags that belong to this advertiser.
  adId: string, Select only event tags that belong to this ad.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  definitionsOnly: boolean, Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
  eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
    Allowed values
      CLICK_THROUGH_EVENT_TAG - 
      IMPRESSION_IMAGE_EVENT_TAG - 
      IMPRESSION_JAVASCRIPT_EVENT_TAG - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  enabled: boolean, Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
  ids: string, Select only event tags with these IDs. (repeated)

Returns:
  An object of the form:

    { # Event Tag List Response
    "eventTags": [ # Event tag collection.
      { # Contains properties of an event tag.
          "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
          "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
          "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
          "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
          "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
          "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
          "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
          "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
          "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
          "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
            "A String",
          ],
          "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
          "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
          "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
  }
patch(profileId, id, body) 
Updates an existing event tag. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.files.html000066400000000000000000000177241300622755700263270ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.floodlightActivities.html000066400000000000000000002333021300622755700313750ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivities

Instance Methods

delete(profileId, id)

Deletes an existing floodlight activity.

generatetag(profileId, floodlightActivityId=None)

Generates a tag for a floodlight activity.

get(profileId, id)

Gets one floodlight activity by ID.

insert(profileId, body)

Inserts a new floodlight activity.

list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)

Retrieves a list of floodlight activities, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity.

Method Details

delete(profileId, id) 
Deletes an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
generatetag(profileId, floodlightActivityId=None) 
Generates a tag for a floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.

Returns:
  An object of the form:

    { # Floodlight Activity GenerateTag Response
    "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
    "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
  }
get(profileId, id) 
Gets one floodlight activity by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
insert(profileId, body) 
Inserts a new floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None) 
Retrieves a list of floodlight activities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
  advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  tagString: string, Select only floodlight activities with the specified tag string.
  floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
  floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
  floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
    "floodlightActivities": [ # Floodlight activity collection.
      { # Contains properties of a Floodlight activity.
          "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
          "secure": True or False, # Whether this tag should use SSL.
          "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
          "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
          "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
          "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
          "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
          "publisherTags": [ # Publisher dynamic floodlight tags.
            { # Publisher Dynamic Tag
              "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
              "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
              "siteId": "A String", # Site ID of this dynamic tag.
              "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
                "tag": "A String", # Tag code.
                "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
                "name": "A String", # Name of this tag.
              },
              "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
              "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            },
          ],
          "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "hidden": True or False, # Whether this activity is archived.
          "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
          "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
          "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
          "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
          "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
          "notes": "A String", # General notes or implementation instructions for the tag.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
          "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
              # Acceptable values are:
              # - "U1"
              # - "U2"
              # - "U3"
              # - "U4"
              # - "U5"
              # - "U6"
              # - "U7"
              # - "U8"
              # - "U9"
              # - "U10"
              # - "U11"
              # - "U12"
              # - "U13"
              # - "U14"
              # - "U15"
              # - "U16"
              # - "U17"
              # - "U18"
              # - "U19"
              # - "U20"
            "A String",
          ],
          "defaultTags": [ # Dynamic floodlight tags.
            { # Dynamic Tag
              "tag": "A String", # Tag code.
              "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
              "name": "A String", # Name of this tag.
            },
          ],
          "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
          "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
update(profileId, body) 
Updates an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.floodlightActivityGroups.html000066400000000000000000001252041300622755700322660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivityGroups

Instance Methods

get(profileId, id)

Gets one floodlight activity group by ID.

insert(profileId, body)

Inserts a new floodlight activity group.

list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)

Retrieves a list of floodlight activity groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity group. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity group.

Method Details

get(profileId, id) 
Gets one floodlight activity group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None) 
Retrieves a list of floodlight activity groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only floodlight activity groups with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
    "floodlightActivityGroups": [ # Floodlight activity group collection.
      { # Contains properties of a Floodlight activity group.
          "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
          "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.floodlightConfigurations.html000066400000000000000000001153771300622755700322760ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightConfigurations

Instance Methods

get(profileId, id)

Gets one floodlight configuration by ID.

list(profileId, ids=None)

Retrieves a list of floodlight configurations, possibly filtered.

patch(profileId, id, body)

Updates an existing floodlight configuration. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight configuration.

Method Details

get(profileId, id) 
Gets one floodlight configuration by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
list(profileId, ids=None) 
Retrieves a list of floodlight configurations, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)

Returns:
  An object of the form:

    { # Floodlight Configuration List Response
    "floodlightConfigurations": [ # Floodlight configuration collection.
      { # Contains properties of a Floodlight configuration.
          "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
          "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
          "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
            "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
            "imageTagEnabled": True or False, # Whether image tags are enabled.
          },
          "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
          "standardVariableTypes": [ # List of standard variables enabled for this configuration.
              #
              # Acceptable values are:
              # - "ORD"
              # - "NUM"
            "A String",
          ],
          "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
            "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
            "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
          },
          "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
          "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
          "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
          "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
          "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
            { # Third Party Authentication Token
              "name": "A String", # Name of the third-party authentication token.
              "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
            },
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
          "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
            { # User Defined Variable configuration.
              "dataType": "A String", # Data type for the variable. This is a required field.
              "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
              "variableType": "A String", # Variable name in the tag. This is a required field.
            },
          ],
          "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
  }
patch(profileId, id, body) 
Updates an existing floodlight configuration. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight configuration.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.html000066400000000000000000000300541300622755700252150ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API

Instance Methods

accountActiveAdSummaries()

Returns the accountActiveAdSummaries Resource.

accountPermissionGroups()

Returns the accountPermissionGroups Resource.

accountPermissions()

Returns the accountPermissions Resource.

accountUserProfiles()

Returns the accountUserProfiles Resource.

accounts()

Returns the accounts Resource.

ads()

Returns the ads Resource.

advertiserGroups()

Returns the advertiserGroups Resource.

advertisers()

Returns the advertisers Resource.

browsers()

Returns the browsers Resource.

campaignCreativeAssociations()

Returns the campaignCreativeAssociations Resource.

campaigns()

Returns the campaigns Resource.

changeLogs()

Returns the changeLogs Resource.

cities()

Returns the cities Resource.

connectionTypes()

Returns the connectionTypes Resource.

contentCategories()

Returns the contentCategories Resource.

conversions()

Returns the conversions Resource.

countries()

Returns the countries Resource.

creativeAssets()

Returns the creativeAssets Resource.

creativeFieldValues()

Returns the creativeFieldValues Resource.

creativeFields()

Returns the creativeFields Resource.

creativeGroups()

Returns the creativeGroups Resource.

creatives()

Returns the creatives Resource.

dimensionValues()

Returns the dimensionValues Resource.

directorySiteContacts()

Returns the directorySiteContacts Resource.

directorySites()

Returns the directorySites Resource.

dynamicTargetingKeys()

Returns the dynamicTargetingKeys Resource.

eventTags()

Returns the eventTags Resource.

files()

Returns the files Resource.

floodlightActivities()

Returns the floodlightActivities Resource.

floodlightActivityGroups()

Returns the floodlightActivityGroups Resource.

floodlightConfigurations()

Returns the floodlightConfigurations Resource.

inventoryItems()

Returns the inventoryItems Resource.

landingPages()

Returns the landingPages Resource.

metros()

Returns the metros Resource.

mobileCarriers()

Returns the mobileCarriers Resource.

operatingSystemVersions()

Returns the operatingSystemVersions Resource.

operatingSystems()

Returns the operatingSystems Resource.

orderDocuments()

Returns the orderDocuments Resource.

orders()

Returns the orders Resource.

placementGroups()

Returns the placementGroups Resource.

placementStrategies()

Returns the placementStrategies Resource.

placements()

Returns the placements Resource.

platformTypes()

Returns the platformTypes Resource.

postalCodes()

Returns the postalCodes Resource.

projects()

Returns the projects Resource.

regions()

Returns the regions Resource.

remarketingListShares()

Returns the remarketingListShares Resource.

remarketingLists()

Returns the remarketingLists Resource.

reports()

Returns the reports Resource.

sites()

Returns the sites Resource.

sizes()

Returns the sizes Resource.

subaccounts()

Returns the subaccounts Resource.

targetableRemarketingLists()

Returns the targetableRemarketingLists Resource.

userProfiles()

Returns the userProfiles Resource.

userRolePermissionGroups()

Returns the userRolePermissionGroups Resource.

userRolePermissions()

Returns the userRolePermissions Resource.

userRoles()

Returns the userRoles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.inventoryItems.html000066400000000000000000000316411300622755700302560ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . inventoryItems

Instance Methods

get(profileId, projectId, id)

Gets one inventory item by ID.

list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)

Retrieves a list of inventory items, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one inventory item by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Inventory item ID. (required)

Returns:
  An object of the form:

    { # Represents a buy from the DoubleClick Planning inventory store.
    "orderId": "A String", # Order ID of this inventory item.
    "pricing": { # Pricing Information # Pricing of this inventory item.
      "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
      "startDate": "A String", # Start date of this inventory item.
      "endDate": "A String", # End date of this inventory item.
      "pricingType": "A String", # Pricing type of this inventory item.
      "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
        { # Flight
          "rateOrCost": "A String", # Rate or cost of this flight.
          "startDate": "A String", # Inventory item flight start date.
          "units": "A String", # Units of this flight.
          "endDate": "A String", # Inventory item flight end date.
        },
      ],
      "capCostType": "A String", # Cap cost type of this inventory item.
    },
    "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
    "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
    "subaccountId": "A String", # Subaccount ID of this inventory item.
    "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
    "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
    "inPlan": True or False, # Whether this inventory item is in plan.
    "id": "A String", # ID of this inventory item.
    "advertiserId": "A String", # Advertiser ID of this inventory item.
    "siteId": "A String", # ID of the site this inventory item is associated with.
    "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
      { # Ad Slot
        "comment": "A String", # Comment for this ad slot.
        "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
        "name": "A String", # Name of this ad slot.
        "primary": True or False, # Primary ad slot of a roadblock inventory item.
        "height": "A String", # Height of this ad slot.
        "width": "A String", # Width of this ad slot.
        "paymentSourceType": "A String", # Payment source type of this ad slot.
        "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
      },
    ],
    "projectId": "A String", # Project ID of this inventory item.
    "rfpId": "A String", # RFP ID of this inventory item.
    "type": "A String", # Type of inventory item.
    "contentCategoryId": "A String", # Content category ID of this inventory item.
    "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
    "accountId": "A String", # Account ID of this inventory item.
  }
list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None) 
Retrieves a list of inventory items, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  inPlan: boolean, Select only inventory items that are in plan.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only inventory items with this type.
    Allowed values
      PLANNING_PLACEMENT_TYPE_CREDIT - 
      PLANNING_PLACEMENT_TYPE_REGULAR - 
  orderId: string, Select only inventory items that belong to specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only inventory items that are associated with these sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only inventory items with these IDs. (repeated)

Returns:
  An object of the form:

    { # Inventory item List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#inventoryItemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
    "inventoryItems": [ # Inventory item collection
      { # Represents a buy from the DoubleClick Planning inventory store.
        "orderId": "A String", # Order ID of this inventory item.
        "pricing": { # Pricing Information # Pricing of this inventory item.
          "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
          "startDate": "A String", # Start date of this inventory item.
          "endDate": "A String", # End date of this inventory item.
          "pricingType": "A String", # Pricing type of this inventory item.
          "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
            { # Flight
              "rateOrCost": "A String", # Rate or cost of this flight.
              "startDate": "A String", # Inventory item flight start date.
              "units": "A String", # Units of this flight.
              "endDate": "A String", # Inventory item flight end date.
            },
          ],
          "capCostType": "A String", # Cap cost type of this inventory item.
        },
        "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
        "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
        "subaccountId": "A String", # Subaccount ID of this inventory item.
        "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
        "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
        "inPlan": True or False, # Whether this inventory item is in plan.
        "id": "A String", # ID of this inventory item.
        "advertiserId": "A String", # Advertiser ID of this inventory item.
        "siteId": "A String", # ID of the site this inventory item is associated with.
        "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
          { # Ad Slot
            "comment": "A String", # Comment for this ad slot.
            "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
            "name": "A String", # Name of this ad slot.
            "primary": True or False, # Primary ad slot of a roadblock inventory item.
            "height": "A String", # Height of this ad slot.
            "width": "A String", # Width of this ad slot.
            "paymentSourceType": "A String", # Payment source type of this ad slot.
            "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
          },
        ],
        "projectId": "A String", # Project ID of this inventory item.
        "rfpId": "A String", # RFP ID of this inventory item.
        "type": "A String", # Type of inventory item.
        "contentCategoryId": "A String", # Content category ID of this inventory item.
        "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
        "accountId": "A String", # Account ID of this inventory item.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.landingPages.html000066400000000000000000000262331300622755700276140ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . landingPages

Instance Methods

delete(profileId, campaignId, id)

Deletes an existing campaign landing page.

get(profileId, campaignId, id)

Gets one campaign landing page by ID.

insert(profileId, campaignId, body)

Inserts a new landing page for the specified campaign.

list(profileId, campaignId)

Retrieves the list of landing pages for the specified campaign.

patch(profileId, campaignId, id, body)

Updates an existing campaign landing page. This method supports patch semantics.

update(profileId, campaignId, body)

Updates an existing campaign landing page.

Method Details

delete(profileId, campaignId, id) 
Deletes an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
get(profileId, campaignId, id) 
Gets one campaign landing page by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)

Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
insert(profileId, campaignId, body) 
Inserts a new landing page for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
list(profileId, campaignId) 
Retrieves the list of landing pages for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)

Returns:
  An object of the form:

    { # Landing Page List Response
    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
    "landingPages": [ # Landing page collection
      { # Contains information about where a user's browser is taken after the user clicks an ad.
          "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
          "url": "A String", # URL of this landing page. This is a required field.
          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
        },
    ],
  }
patch(profileId, campaignId, id, body) 
Updates an existing campaign landing page. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
update(profileId, campaignId, body) 
Updates an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.metros.html000066400000000000000000000047541300622755700265350ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . metros

Instance Methods

list(profileId)

Retrieves a list of metros.

Method Details

list(profileId) 
Retrieves a list of metros.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Metro List Response
    "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
    "metros": [ # Metro collection.
      { # Contains information about a metro region that can be targeted by ads.
        "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
        "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
        "name": "A String", # Name of this metro region.
        "countryCode": "A String", # Country code of the country to which this metro region belongs.
        "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
        "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
        "dartId": "A String", # DART ID of this metro region.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.mobileCarriers.html000066400000000000000000000064221300622755700301600ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . mobileCarriers

Instance Methods

get(profileId, id)

Gets one mobile carrier by ID.

list(profileId)

Retrieves a list of mobile carriers.

Method Details

get(profileId, id) 
Gets one mobile carrier by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Mobile carrier ID. (required)

Returns:
  An object of the form:

    { # Contains information about a mobile carrier that can be targeted by ads.
    "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
    "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
    "id": "A String", # ID of this mobile carrier.
    "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
    "name": "A String", # Name of this mobile carrier.
  }
list(profileId) 
Retrieves a list of mobile carriers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Mobile Carrier List Response
    "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
    "mobileCarriers": [ # Mobile carrier collection.
      { # Contains information about a mobile carrier that can be targeted by ads.
        "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
        "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
        "id": "A String", # ID of this mobile carrier.
        "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
        "name": "A String", # Name of this mobile carrier.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.operatingSystemVersions.html000066400000000000000000000114451300622755700321450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystemVersions

Instance Methods

get(profileId, id)

Gets one operating system version by ID.

list(profileId)

Retrieves a list of operating system versions.

Method Details

get(profileId, id) 
Gets one operating system version by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Operating system version ID. (required)

Returns:
  An object of the form:

    { # Contains information about a particular version of an operating system that can be targeted by ads.
    "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
    "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
    "name": "A String", # Name of this operating system version.
    "id": "A String", # ID of this operating system version.
    "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
      "mobile": True or False, # Whether this operating system is for mobile.
      "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
      "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
      "name": "A String", # Name of this operating system.
      "desktop": True or False, # Whether this operating system is for desktop.
    },
    "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
  }
list(profileId) 
Retrieves a list of operating system versions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System Version List Response
    "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
    "operatingSystemVersions": [ # Operating system version collection.
      { # Contains information about a particular version of an operating system that can be targeted by ads.
        "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
        "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
        "name": "A String", # Name of this operating system version.
        "id": "A String", # ID of this operating system version.
        "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
        "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.operatingSystems.html000066400000000000000000000065411300622755700306000ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystems

Instance Methods

get(profileId, dartId)

Gets one operating system by DART ID.

list(profileId)

Retrieves a list of operating systems.

Method Details

get(profileId, dartId) 
Gets one operating system by DART ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Operating system DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about an operating system that can be targeted by ads.
    "mobile": True or False, # Whether this operating system is for mobile.
    "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
    "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
    "name": "A String", # Name of this operating system.
    "desktop": True or False, # Whether this operating system is for desktop.
  }
list(profileId) 
Retrieves a list of operating systems.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System List Response
    "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
    "operatingSystems": [ # Operating system collection.
      { # Contains information about an operating system that can be targeted by ads.
        "mobile": True or False, # Whether this operating system is for mobile.
        "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
        "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
        "name": "A String", # Name of this operating system.
        "desktop": True or False, # Whether this operating system is for desktop.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.orderDocuments.html000066400000000000000000000200601300622755700302050ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orderDocuments

Instance Methods

get(profileId, projectId, id)

Gets one order document by ID.

list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)

Retrieves a list of order documents, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order document by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Order document ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning order document.
    "orderId": "A String", # ID of the order from which this order document is created.
    "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
      "A String",
    ],
    "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
    "subaccountId": "A String", # Subaccount ID of this order document.
    "effectiveDate": "A String", # Effective date of this order document.
    "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
    "lastSentRecipients": [ # List of email addresses that received the last sent document.
      "A String",
    ],
    "title": "A String", # Title of this order document.
    "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
    "signed": True or False, # Whether this order document has been signed.
    "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "advertiserId": "A String", # Advertiser ID of this order document.
    "projectId": "A String", # Project ID of this order document.
    "cancelled": True or False, # Whether this order document is cancelled.
    "type": "A String", # Type of this order document
    "id": "A String", # ID of this order document.
    "accountId": "A String", # Account ID of this order document.
  }
list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None) 
Retrieves a list of order documents, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  orderId: string, Select only order documents for specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only order documents that are associated with these sites. (repeated)
  approved: boolean, Select only order documents that have been approved by at least one user.
  searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only order documents with these IDs. (repeated)

Returns:
  An object of the form:

    { # Order document List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#orderDocumentsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
    "orderDocuments": [ # Order document collection
      { # Contains properties of a DoubleClick Planning order document.
        "orderId": "A String", # ID of the order from which this order document is created.
        "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
          "A String",
        ],
        "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
        "subaccountId": "A String", # Subaccount ID of this order document.
        "effectiveDate": "A String", # Effective date of this order document.
        "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
        "lastSentRecipients": [ # List of email addresses that received the last sent document.
          "A String",
        ],
        "title": "A String", # Title of this order document.
        "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
        "signed": True or False, # Whether this order document has been signed.
        "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "advertiserId": "A String", # Advertiser ID of this order document.
        "projectId": "A String", # Project ID of this order document.
        "cancelled": True or False, # Whether this order document is cancelled.
        "type": "A String", # Type of this order document
        "id": "A String", # ID of this order document.
        "accountId": "A String", # Account ID of this order document.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.orders.html000066400000000000000000000214011300622755700265060ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orders

Instance Methods

get(profileId, projectId, id)

Gets one order by ID.

list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)

Retrieves a list of orders, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  id: string, Order ID. (required)

Returns:
  An object of the form:

    { # Describes properties of a DoubleClick Planning order.
    "termsAndConditions": "A String", # Terms and conditions of this order.
    "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
    "sellerOrganizationName": "A String", # Name of the seller organization.
    "subaccountId": "A String", # Subaccount ID of this order.
    "name": "A String", # Name of this order.
    "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "notes": "A String", # Notes of this order.
    "contacts": [ # Contacts for this order.
      { # Contact of an order.
        "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
        "contactTitle": "A String", # Title of this contact.
        "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
        "contactName": "A String", # Name of this contact.
        "contactType": "A String", # Type of this contact.
      },
    ],
    "buyerOrganizationName": "A String", # Name of the buyer organization.
    "comments": "A String", # Comments in this order.
    "advertiserId": "A String", # Advertiser ID of this order.
    "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
      "A String",
    ],
    "siteId": [ # Site IDs this order is associated with.
      "A String",
    ],
    "sellerOrderId": "A String", # Seller order ID associated with this order.
    "projectId": "A String", # Project ID of this order.
    "siteNames": [ # Free-form site names this order is associated with.
      "A String",
    ],
    "planningTermId": "A String", # ID of the terms and conditions template used in this order.
    "id": "A String", # ID of this order. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this order.
  }
list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None) 
Retrieves a list of orders, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only orders with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  siteId: string, Select only orders that are associated with these site IDs. (repeated)

Returns:
  An object of the form:

    { # Order List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
    "orders": [ # Order collection.
      { # Describes properties of a DoubleClick Planning order.
        "termsAndConditions": "A String", # Terms and conditions of this order.
        "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
        "sellerOrganizationName": "A String", # Name of the seller organization.
        "subaccountId": "A String", # Subaccount ID of this order.
        "name": "A String", # Name of this order.
        "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "notes": "A String", # Notes of this order.
        "contacts": [ # Contacts for this order.
          { # Contact of an order.
            "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
            "contactTitle": "A String", # Title of this contact.
            "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
            "contactName": "A String", # Name of this contact.
            "contactType": "A String", # Type of this contact.
          },
        ],
        "buyerOrganizationName": "A String", # Name of the buyer organization.
        "comments": "A String", # Comments in this order.
        "advertiserId": "A String", # Advertiser ID of this order.
        "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
          "A String",
        ],
        "siteId": [ # Site IDs this order is associated with.
          "A String",
        ],
        "sellerOrderId": "A String", # Seller order ID associated with this order.
        "projectId": "A String", # Project ID of this order.
        "siteNames": [ # Free-form site names this order is associated with.
          "A String",
        ],
        "planningTermId": "A String", # ID of the terms and conditions template used in this order.
        "id": "A String", # ID of this order. This is a read-only, auto-generated field.
        "accountId": "A String", # Account ID of this order.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.placementGroups.html000066400000000000000000003050221300622755700303640ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementGroups

Instance Methods

get(profileId, id)

Gets one placement group by ID.

insert(profileId, body)

Inserts a new placement group.

list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)

Retrieves a list of placement groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement group. This method supports patch semantics.

update(profileId, body)

Updates an existing placement group.

Method Details

get(profileId, id) 
Gets one placement group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None) 
Retrieves a list of placement groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placement groups that are associated with these sites. (repeated)
  placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
    Allowed values
      PLACEMENT_PACKAGE - 
      PLACEMENT_ROADBLOCK - 
  pricingTypes: string, Select only placement groups with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
  ids: string, Select only placement groups with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Placement Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
    "placementGroups": [ # Placement group collection.
      { # Contains properties of a package or roadblock.
          "comment": "A String", # Comments for this placement group.
          "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
          "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
          "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this placement group is archived.
          "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
            "A String",
          ],
          "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
          "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
          "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.placementStrategies.html000066400000000000000000000257711300622755700312310ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementStrategies

Instance Methods

delete(profileId, id)

Deletes an existing placement strategy.

get(profileId, id)

Gets one placement strategy by ID.

insert(profileId, body)

Inserts a new placement strategy.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of placement strategies, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement strategy. This method supports patch semantics.

update(profileId, body)

Updates an existing placement strategy.

Method Details

delete(profileId, id) 
Deletes an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
get(profileId, id) 
Gets one placement strategy by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of placement strategies, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placement strategies with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Placement Strategy List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
    "placementStrategies": [ # Placement strategy collection.
      { # Contains properties of a placement strategy.
          "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
          "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
          "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
          "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing placement strategy. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.placements.html000066400000000000000000004054571300622755700273640ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placements

Instance Methods

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)

Generates tags for a placement.

get(profileId, id)

Gets one placement by ID.

insert(profileId, body)

Inserts a new placement.

list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)

Retrieves a list of placements, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement. This method supports patch semantics.

update(profileId, body)

Updates an existing placement.

Method Details

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None) 
Generates tags for a placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Generate placements belonging to this campaign. This is a required field.
  tagFormats: string, Tag formats to generate for these placements. (repeated)
    Allowed values
      PLACEMENT_TAG_CLICK_COMMANDS - 
      PLACEMENT_TAG_IFRAME_ILAYER - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 - 
      PLACEMENT_TAG_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_JAVASCRIPT - 
      PLACEMENT_TAG_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_STANDARD - 
      PLACEMENT_TAG_TRACKING - 
      PLACEMENT_TAG_TRACKING_IFRAME - 
      PLACEMENT_TAG_TRACKING_JAVASCRIPT - 
  placementIds: string, Generate tags for these placements. (repeated)

Returns:
  An object of the form:

    { # Placement GenerateTags Response
    "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
    "placementTags": [ # Set of generated tags for the specified placements.
      { # Placement Tag
        "tagDatas": [ # Tags generated for this placement.
          { # Placement Tag Data
            "clickTag": "A String", # Tag string to record a click.
            "impressionTag": "A String", # Tag string for serving an ad.
            "creativeId": "A String", # Creative associated with this placement tag.
            "adId": "A String", # Ad associated with this placement tag.
            "format": "A String", # TagData tag format of this tag.
          },
        ],
        "placementId": "A String", # Placement ID
      },
    ],
  }
get(profileId, id) 
Gets one placement by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None) 
Retrieves a list of placements, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placements that are associated with these sites. (repeated)
  paymentSource: string, Select only placements with this payment source.
    Allowed values
      PLACEMENT_AGENCY_PAID - 
      PLACEMENT_PUBLISHER_PAID - 
  pricingTypes: string, Select only placements with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placements that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
  sizeIds: string, Select only placements that are associated with these sizes. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placements with these IDs. (repeated)
  groupIds: string, Select only placements that belong to these placement groups. (repeated)

Returns:
  An object of the form:

    { # Placement List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
    "placements": [ # Placement collection.
      { # Contains properties of a placement.
          "comment": "A String", # Comments for this placement.
          "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
          "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
          "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement. This field can be left blank.
          "archived": True or False, # Whether this placement is archived.
          "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
              # Acceptable values are:
              # - "PLACEMENT_TAG_STANDARD"
              # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_IFRAME_ILAYER"
              # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
              # - "PLACEMENT_TAG_CLICK_COMMANDS"
              # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
              # - "PLACEMENT_TAG_TRACKING"
              # - "PLACEMENT_TAG_TRACKING_IFRAME"
              # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
            "A String",
          ],
          "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
          "tagSetting": { # Tag Settings # Tag settings for this placement.
            "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
            "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
            "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
            "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
          },
          "contentCategoryId": "A String", # ID of the content category assigned to this placement.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
          "status": "A String", # Third-party placement status.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
          "placementGroupId": "A String", # ID of this placement's group, if applicable.
          "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
          "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
          "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
          "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.platformTypes.html000066400000000000000000000055561300622755700300760ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . platformTypes

Instance Methods

get(profileId, id)

Gets one platform type by ID.

list(profileId)

Retrieves a list of platform types.

Method Details

get(profileId, id) 
Gets one platform type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Platform type ID. (required)

Returns:
  An object of the form:

    { # Contains information about a platform type that can be targeted by ads.
    "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
    "id": "A String", # ID of this platform type.
    "name": "A String", # Name of this platform type.
  }
list(profileId) 
Retrieves a list of platform types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Platform Type List Response
    "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
    "platformTypes": [ # Platform type collection.
      { # Contains information about a platform type that can be targeted by ads.
        "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
        "id": "A String", # ID of this platform type.
        "name": "A String", # Name of this platform type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.postalCodes.html000066400000000000000000000063701300622755700275000ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . postalCodes

Instance Methods

get(profileId, code)

Gets one postal code by ID.

list(profileId)

Retrieves a list of postal codes.

Method Details

get(profileId, code) 
Gets one postal code by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  code: string, Postal code ID. (required)

Returns:
  An object of the form:

    { # Contains information about a postal code that can be targeted by ads.
    "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
    "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
    "code": "A String", # Postal code. This is equivalent to the id field.
    "id": "A String", # ID of this postal code.
    "countryCode": "A String", # Country code of the country to which this postal code belongs.
  }
list(profileId) 
Retrieves a list of postal codes.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Postal Code List Response
    "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
    "postalCodes": [ # Postal code collection.
      { # Contains information about a postal code that can be targeted by ads.
        "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
        "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
        "code": "A String", # Postal code. This is equivalent to the id field.
        "id": "A String", # ID of this postal code.
        "countryCode": "A String", # Country code of the country to which this postal code belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.projects.html000066400000000000000000000177341300622755700270570ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . projects

Instance Methods

get(profileId, id)

Gets one project by ID.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of projects, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one project by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Project ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning project.
    "startDate": "A String", # Start date of the project.
    "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
    "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
    "endDate": "A String", # End date of the project.
    "name": "A String", # Name of this project.
    "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
    "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
    "clientBillingCode": "A String", # Client billing code of this project.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
    "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
    "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
    "advertiserId": "A String", # Advertiser ID of this project.
    "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
    "overview": "A String", # Overview of this project.
    "audienceAgeGroup": "A String", # Audience age group of this project.
    "subaccountId": "A String", # Subaccount ID of this project.
    "audienceGender": "A String", # Audience gender of this project.
    "id": "A String", # ID of this project. This is a read-only, auto-generated field.
    "clientName": "A String", # Name of the project client.
    "accountId": "A String", # Account ID of this project.
  }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of projects, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
  ids: string, Select only projects with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Project List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
    "projects": [ # Project collection.
      { # Contains properties of a DoubleClick Planning project.
        "startDate": "A String", # Start date of the project.
        "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
        "endDate": "A String", # End date of the project.
        "name": "A String", # Name of this project.
        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
        "clientBillingCode": "A String", # Client billing code of this project.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
        "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
        "advertiserId": "A String", # Advertiser ID of this project.
        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
        "overview": "A String", # Overview of this project.
        "audienceAgeGroup": "A String", # Audience age group of this project.
        "subaccountId": "A String", # Subaccount ID of this project.
        "audienceGender": "A String", # Audience gender of this project.
        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
        "clientName": "A String", # Name of the project client.
        "accountId": "A String", # Account ID of this 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.regions.html000066400000000000000000000044211300622755700266610ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . regions

Instance Methods

list(profileId)

Retrieves a list of regions.

Method Details

list(profileId) 
Retrieves a list of regions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Region List Response
    "regions": [ # Region collection.
      { # Contains information about a region that can be targeted by ads.
        "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
        "countryDartId": "A String", # DART ID of the country to which this region belongs.
        "name": "A String", # Name of this region.
        "countryCode": "A String", # Country code of the country to which this region belongs.
        "regionCode": "A String", # Region code.
        "dartId": "A String", # DART ID of this region.
      },
    ],
    "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.remarketingListShares.html000066400000000000000000000146741300622755700315400ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingListShares

Instance Methods

get(profileId, remarketingListId)

Gets one remarketing list share by remarketing list ID.

patch(profileId, remarketingListId, body)

Updates an existing remarketing list share. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list share.

Method Details

get(profileId, remarketingListId) 
Gets one remarketing list share by remarketing list ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
patch(profileId, remarketingListId, body) 
Updates an existing remarketing list share. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
update(profileId, body) 
Updates an existing remarketing list share.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.remarketingLists.html000066400000000000000000001407751300622755700305570ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

insert(profileId, body)

Inserts a new remarketing list.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing remarketing list. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
insert(profileId, body) 
Inserts a new remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "remarketingLists": [ # Remarketing list collection.
      { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
          "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
            "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
            "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
              { # A group clause made up of list population terms representing constraints joined by ORs.
                "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
                  { # Remarketing List Population Rule Term.
                    "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                    "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                    "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                    "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                    "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                  },
                ],
              },
            ],
          },
          "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
          "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
          "description": "A String", # Remarketing list description.
          "listSize": "A String", # Number of users currently in the list. This is a read-only field.
          "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
          "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
          "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
          "listSource": "A String", # Product from which this remarketing list was originated.
          "active": True or False, # Whether this remarketing list is active.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        },
    ],
    "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
  }
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, id, body) 
Updates an existing remarketing list. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
update(profileId, body) 
Updates an existing remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.reports.compatibleFields.html000066400000000000000000001142411300622755700321600ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . compatibleFields

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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.reports.files.html000066400000000000000000000176241300622755700300230ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.reports.html000066400000000000000000007121021300622755700267130ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports

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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
              },
            ],
            "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.
            },
            "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.
              },
            ],
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
          },
          "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
          "subAccountId": "A String", # The subaccount 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.
                # 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. Note:
                # - "DAILY" also requires field "every" to be set.
                # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
                # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
            "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
              "A String",
            ],
          },
          "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              ],
            },
            "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
          },
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
          "fileName": "A String", # The filename used when generating report files for this report.
          "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.
            "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.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          "type": "A String", # The type of the report.
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "accountId": "A String", # The account ID to which this report belongs.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.sites.html000066400000000000000000001641351300622755700263530ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sites

Instance Methods

get(profileId, id)

Gets one site by ID.

insert(profileId, body)

Inserts a new site.

list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)

Retrieves a list of sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing site. This method supports patch semantics.

update(profileId, body)

Updates an existing site.

Method Details

get(profileId, id) 
Gets one site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None) 
Retrieves a list of sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
  campaignIds: string, Select only sites with these campaign IDs. (repeated)
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  adWordsSite: boolean, Select only AdWords sites.
  approved: boolean, Select only approved sites.
  searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
  subaccountId: string, Select only sites with this subaccount ID.
  directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only sites with these IDs. (repeated)

Returns:
  An object of the form:

    { # Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
    "sites": [ # Site collection.
      { # Contains properties of a site.
          "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
          "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
          "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteSettings": { # Site Settings # Site-wide settings.
            "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
            "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
            "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
            "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
            "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
              "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
              "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
              "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
              "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
            },
            "creativeSettings": { # Creative Settings # Site-wide creative settings.
              "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
              "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
            },
            "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
          },
          "approved": True or False, # Whether this site is approved.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteContacts": [ # Site contacts.
            { # Site Contact
              "firstName": "A String", # First name of this site contact.
              "title": "A String", # Title or designation of this site contact.
              "lastName": "A String", # Last name of this site contact.
              "address": "A String", # Address of this site contact.
              "email": "A String", # Email address of this site contact. This is a required field.
              "phone": "A String", # Primary phone number of this site contact.
              "contactType": "A String", # Site contact type.
              "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
            },
          ],
          "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this site. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing site. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.sizes.html000066400000000000000000000113721300622755700263530ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sizes

Instance Methods

get(profileId, id)

Gets one size by ID.

insert(profileId, body)

Inserts a new size.

list(profileId, iabStandard=None, width=None, ids=None, height=None)

Retrieves a list of sizes, possibly filtered.

Method Details

get(profileId, id) 
Gets one size by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Size ID. (required)

Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
insert(profileId, body) 
Inserts a new size.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents the dimensions of ads, placements, creatives, or creative assets.
  "width": 42, # Width of this size.
  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
  "height": 42, # Height of this size.
}


Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
list(profileId, iabStandard=None, width=None, ids=None, height=None) 
Retrieves a list of sizes, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  iabStandard: boolean, Select only IAB standard sizes.
  width: integer, Select only sizes with this width.
  ids: string, Select only sizes with these IDs. (repeated)
  height: integer, Select only sizes with this height.

Returns:
  An object of the form:

    { # Size List Response
    "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
    "sizes": [ # Size collection.
      { # Represents the dimensions of ads, placements, creatives, or creative assets.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.subaccounts.html000066400000000000000000000261431300622755700275510ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . subaccounts

Instance Methods

get(profileId, id)

Gets one subaccount by ID.

insert(profileId, body)

Inserts a new subaccount.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Gets a list of subaccounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing subaccount. This method supports patch semantics.

update(profileId, body)

Updates an existing subaccount.

Method Details

get(profileId, id) 
Gets one subaccount by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Gets a list of subaccounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only subaccounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Subaccount List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
    "subaccounts": [ # Subaccount collection.
      { # Contains properties of a DCM subaccount.
          "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
          "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
            "A String",
          ],
          "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
          "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
          "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing subaccount. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.targetableRemarketingLists.html000066400000000000000000000232261300622755700325410ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . targetableRemarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of targetable remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
    "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Targetable remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
    "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
    "listSource": "A String", # Product from which this targetable remarketing list was originated.
    "active": True or False, # Whether this targetable remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of targetable remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive targetable remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Targetable remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
    "targetableRemarketingLists": [ # Targetable remarketing list collection.
      { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
        "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
        "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        "description": "A String", # Targetable remarketing list description.
        "listSize": "A String", # Number of users currently in the list. This is a read-only field.
        "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
        "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
        "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
        "listSource": "A String", # Product from which this targetable remarketing list was originated.
        "active": True or False, # Whether this targetable remarketing list is active.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
        "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.userProfiles.html000066400000000000000000000067321300622755700277040ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userProfiles

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.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.userRolePermissionGroups.html000066400000000000000000000061061300622755700322660ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissionGroups

Instance Methods

get(profileId, id)

Gets one user role permission group by ID.

list(profileId)

Gets a list of all supported user role permission groups.

Method Details

get(profileId, id) 
Gets one user role permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission group ID. (required)

Returns:
  An object of the form:

    { # Represents a grouping of related user role permissions.
    "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
    "id": "A String", # ID of this user role permission.
    "name": "A String", # Name of this user role permission group.
  }
list(profileId) 
Gets a list of all supported user role permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # User Role Permission Group List Response
    "userRolePermissionGroups": [ # User role permission group collection.
      { # Represents a grouping of related user role permissions.
        "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
        "id": "A String", # ID of this user role permission.
        "name": "A String", # Name of this user role permission group.
      },
    ],
    "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.userRolePermissions.html000066400000000000000000000067071300622755700312600ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissions

Instance Methods

get(profileId, id)

Gets one user role permission by ID.

list(profileId, ids=None)

Gets a list of user role permissions, possibly filtered.

Method Details

get(profileId, id) 
Gets one user role permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a user role permission.
    "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
    "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
    "availability": "A String", # Levels of availability for a user role permission.
    "name": "A String", # Name of this user role permission.
    "id": "A String", # ID of this user role permission.
  }
list(profileId, ids=None) 
Gets a list of user role permissions, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Select only user role permissions with these IDs. (repeated)

Returns:
  An object of the form:

    { # User Role Permission List Response
    "userRolePermissions": [ # User role permission collection.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_5beta1.userRoles.html000066400000000000000000000523451300622755700272060ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRoles

Instance Methods

delete(profileId, id)

Deletes an existing user role.

get(profileId, id)

Gets one user role by ID.

insert(profileId, body)

Inserts a new user role.

list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)

Retrieves a list of user roles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing user role. This method supports patch semantics.

update(profileId, body)

Updates an existing user role.

Method Details

delete(profileId, id) 
Deletes an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
get(profileId, id) 
Gets one user role by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)

Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None) 
Retrieves a list of user roles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
  subaccountId: string, Select only user roles that belong to this subaccount.
  pageToken: string, Value of the nextPageToken from the previous result page.
  ids: string, Select only user roles with the specified IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # User Role List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
    "userRoles": [ # User role collection.
      { # Contains properties of auser role, which is used to manage user access.
          "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
          "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
          "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
          "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
          "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
          "permissions": [ # List of permissions associated with this user role.
            { # Contains properties of a user role permission.
              "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
              "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
              "availability": "A String", # Levels of availability for a user role permission.
              "name": "A String", # Name of this user role permission.
              "id": "A String", # ID of this user role permission.
            },
          ],
          "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing user role. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.accountActiveAdSummaries.html000066400000000000000000000042261300622755700312250ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountActiveAdSummaries

Instance Methods

get(profileId, summaryAccountId)

Gets the account's active ad summary by account ID.

Method Details

get(profileId, summaryAccountId) 
Gets the account's active ad summary by account ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  summaryAccountId: string, Account ID. (required)

Returns:
  An object of the form:

    { # Gets a summary of active ads in an account.
    "availableAds": "A String", # Ads that can be activated for the account.
    "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
    "activeAds": "A String", # Ads that have been activated for the account
    "accountId": "A String", # ID of the account.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.accountPermissionGroups.html000066400000000000000000000062671300622755700312160ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissionGroups

Instance Methods

get(profileId, id)

Gets one account permission group by ID.

list(profileId)

Retrieves the list of account permission groups.

Method Details

get(profileId, id) 
Gets one account permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission group ID. (required)

Returns:
  An object of the form:

    { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
    "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
    "id": "A String", # ID of this account permission group.
    "name": "A String", # Name of this account permission group.
  }
list(profileId) 
Retrieves the list of account permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission Group List Response
    "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
    "accountPermissionGroups": [ # Account permission group collection.
      { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
        "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
        "id": "A String", # ID of this account permission group.
        "name": "A String", # Name of this account permission group.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.accountPermissions.html000066400000000000000000000077041300622755700301760ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountPermissions

Instance Methods

get(profileId, id)

Gets one account permission by ID.

list(profileId)

Retrieves the list of account permissions.

Method Details

get(profileId, id) 
Gets one account permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account permission ID. (required)

Returns:
  An object of the form:

    { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
    "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
    "name": "A String", # Name of this account permission.
    "level": "A String", # Administrative level required to enable this account permission.
    "permissionGroupId": "A String", # Permission group of this account permission.
    "accountProfiles": [ # Account profiles associated with this account permission.
        #
        # Possible values are:
        # - "ACCOUNT_PROFILE_BASIC"
        # - "ACCOUNT_PROFILE_STANDARD"
      "A String",
    ],
    "id": "A String", # ID of this account permission.
  }
list(profileId) 
Retrieves the list of account permissions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Account Permission List Response
    "accountPermissions": [ # Account permission collection.
      { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
        "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
        "name": "A String", # Name of this account permission.
        "level": "A String", # Administrative level required to enable this account permission.
        "permissionGroupId": "A String", # Permission group of this account permission.
        "accountProfiles": [ # Account profiles associated with this account permission.
            #
            # Possible values are:
            # - "ACCOUNT_PROFILE_BASIC"
            # - "ACCOUNT_PROFILE_STANDARD"
          "A String",
        ],
        "id": "A String", # ID of this account permission.
      },
    ],
    "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.accountUserProfiles.html000066400000000000000000001271001300622755700302760ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accountUserProfiles

Instance Methods

get(profileId, id)

Gets one account user profile by ID.

insert(profileId, body)

Inserts a new account user profile.

list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)

Retrieves a list of account user profiles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account user profile. This method supports patch semantics.

update(profileId, body)

Updates an existing account user profile.

Method Details

get(profileId, id) 
Gets one account user profile by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)

Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None) 
Retrieves a list of account user profiles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
  subaccountId: string, Select only user profiles with the specified subaccount ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only user profiles with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  userRoleId: string, Select only user profiles with the specified user role ID.
  active: boolean, Select only active user profiles.

Returns:
  An object of the form:

    { # Account User Profile List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "accountUserProfiles": [ # Account user profile collection.
      { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
          "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
          "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
          "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
          "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "locale": "A String", # Locale of the user profile. This is a required field.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "comments": "A String", # Comments for this user profile.
          "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
          "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
              "A String",
            ],
            "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
          },
          "userRoleId": "A String", # User role ID of the user profile. This is a required field.
          "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
          "traffickerType": "A String", # Trafficker type of this user profile.
          "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
          "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
          "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
  }
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, id, body) 
Updates an existing account user profile. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User profile ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing account user profile.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
    "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "locale": "A String", # Locale of the user profile. This is a required field.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "comments": "A String", # Comments for this user profile.
    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
        "A String",
      ],
      "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
    },
    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
    "traffickerType": "A String", # Trafficker type of this user profile.
    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
    "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
      "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "locale": "A String", # Locale of the user profile. This is a required field.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "comments": "A String", # Comments for this user profile.
      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
          "A String",
        ],
        "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
      },
      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
      "traffickerType": "A String", # Trafficker type of this user profile.
      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
      "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.accounts.html000066400000000000000000001143621300622755700261240ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . accounts

Instance Methods

get(profileId, id)

Gets one account by ID.

list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)

Retrieves the list of accounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing account. This method supports patch semantics.

update(profileId, body)

Updates an existing account.

Method Details

get(profileId, id) 
Gets one account by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None) 
Retrieves the list of accounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only accounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.

Returns:
  An object of the form:

    { # Account List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
    "accounts": [ # Account collection.
      { # Contains properties of a DCM account.
          "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
          "countryId": "A String", # ID of the country associated with this account.
          "availablePermissionIds": [ # User role permissions available to the user roles of this account.
            "A String",
          ],
          "description": "A String", # Description of this account.
          "maximumImageSize": "A String", # Maximum image size allowed for this account.
          "currencyId": "A String", # ID of currency associated with this account. This is a required field.
              # Acceptable values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
          "accountPermissionIds": [ # Account permissions assigned to this account.
            "A String",
          ],
          "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
          "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
          "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
          "locale": "A String", # Locale of this account.
              # Acceptable values are:
              # - "cs" (Czech)
              # - "de" (German)
              # - "en" (English)
              # - "en-GB" (English United Kingdom)
              # - "es" (Spanish)
              # - "fr" (French)
              # - "it" (Italian)
              # - "ja" (Japanese)
              # - "ko" (Korean)
              # - "pl" (Polish)
              # - "pt-BR" (Portuguese Brazil)
              # - "ru" (Russian)
              # - "sv" (Swedish)
              # - "tr" (Turkish)
              # - "zh-CN" (Chinese Simplified)
              # - "zh-TW" (Chinese Traditional)
          "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
          "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
            "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
                # Acceptable values are:
                #
                # - "1" for "America/New_York"
                # - "2" for "Europe/London"
                # - "3" for "Europe/Paris"
                # - "4" for "Africa/Johannesburg"
                # - "5" for "Asia/Jerusalem"
                # - "6" for "Asia/Shanghai"
                # - "7" for "Asia/Hong_Kong"
                # - "8" for "Asia/Tokyo"
                # - "9" for "Australia/Sydney"
                # - "10" for "Asia/Dubai"
                # - "11" for "America/Los_Angeles"
                # - "12" for "Pacific/Auckland"
                # - "13" for "America/Sao_Paulo"
            "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
            "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
          },
          "active": True or False, # Whether this account is active.
          "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
          "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
          "id": "A String", # ID of this account. This is a read-only, auto-generated field.
          "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
        },
    ],
  }
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, id, body) 
Updates an existing account. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
update(profileId, body) 
Updates an existing account.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM account.
    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
    "countryId": "A String", # ID of the country associated with this account.
    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
      "A String",
    ],
    "description": "A String", # Description of this account.
    "maximumImageSize": "A String", # Maximum image size allowed for this account.
    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
        # Acceptable values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
    "accountPermissionIds": [ # Account permissions assigned to this account.
      "A String",
    ],
    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
    "locale": "A String", # Locale of this account.
        # Acceptable values are:
        # - "cs" (Czech)
        # - "de" (German)
        # - "en" (English)
        # - "en-GB" (English United Kingdom)
        # - "es" (Spanish)
        # - "fr" (French)
        # - "it" (Italian)
        # - "ja" (Japanese)
        # - "ko" (Korean)
        # - "pl" (Polish)
        # - "pt-BR" (Portuguese Brazil)
        # - "ru" (Russian)
        # - "sv" (Swedish)
        # - "tr" (Turkish)
        # - "zh-CN" (Chinese Simplified)
        # - "zh-TW" (Chinese Traditional)
    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
          # Acceptable values are:
          #
          # - "1" for "America/New_York"
          # - "2" for "Europe/London"
          # - "3" for "Europe/Paris"
          # - "4" for "Africa/Johannesburg"
          # - "5" for "Asia/Jerusalem"
          # - "6" for "Asia/Shanghai"
          # - "7" for "Asia/Hong_Kong"
          # - "8" for "Asia/Tokyo"
          # - "9" for "Australia/Sydney"
          # - "10" for "Asia/Dubai"
          # - "11" for "America/Los_Angeles"
          # - "12" for "Pacific/Auckland"
          # - "13" for "America/Sao_Paulo"
      "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
    },
    "active": True or False, # Whether this account is active.
    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
    "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM account.
      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
      "countryId": "A String", # ID of the country associated with this account.
      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
        "A String",
      ],
      "description": "A String", # Description of this account.
      "maximumImageSize": "A String", # Maximum image size allowed for this account.
      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
          # Acceptable values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
      "accountPermissionIds": [ # Account permissions assigned to this account.
        "A String",
      ],
      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
      "locale": "A String", # Locale of this account.
          # Acceptable values are:
          # - "cs" (Czech)
          # - "de" (German)
          # - "en" (English)
          # - "en-GB" (English United Kingdom)
          # - "es" (Spanish)
          # - "fr" (French)
          # - "it" (Italian)
          # - "ja" (Japanese)
          # - "ko" (Korean)
          # - "pl" (Polish)
          # - "pt-BR" (Portuguese Brazil)
          # - "ru" (Russian)
          # - "sv" (Swedish)
          # - "tr" (Turkish)
          # - "zh-CN" (Chinese Simplified)
          # - "zh-TW" (Chinese Traditional)
      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
            # Acceptable values are:
            #
            # - "1" for "America/New_York"
            # - "2" for "Europe/London"
            # - "3" for "Europe/Paris"
            # - "4" for "Africa/Johannesburg"
            # - "5" for "Asia/Jerusalem"
            # - "6" for "Asia/Shanghai"
            # - "7" for "Asia/Hong_Kong"
            # - "8" for "Asia/Tokyo"
            # - "9" for "Australia/Sydney"
            # - "10" for "Asia/Dubai"
            # - "11" for "America/Los_Angeles"
            # - "12" for "Pacific/Auckland"
            # - "13" for "America/Sao_Paulo"
        "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
        "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
      },
      "active": True or False, # Whether this account is active.
      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
      "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.ads.html000066400000000000000000011215371300622755700250570ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . ads

Instance Methods

get(profileId, id)

Gets one ad by ID.

insert(profileId, body)

Inserts a new ad.

list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)

Retrieves a list of ads, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing ad. This method supports patch semantics.

update(profileId, body)

Updates an existing ad.

Method Details

get(profileId, id) 
Gets one ad by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
insert(profileId, body) 
Inserts a new ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a language that can be targeted by ads.
          "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
          "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
          "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
          "name": "A String", # Name of this language.
        },
      ],
    },
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None) 
Retrieves a list of ads, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  landingPageIds: string, Select only ads with these landing page IDs. (repeated)
  overriddenEventTagId: string, Select only ads with this event tag override ID.
  campaignIds: string, Select only ads with these campaign IDs. (repeated)
  sizeIds: string, Select only ads with these size IDs. (repeated)
  archived: boolean, Select only archived ads.
  creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
  sslCompliant: boolean, Select only ads that are SSL-compliant.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only ads with these types. (repeated)
    Allowed values
      AD_SERVING_CLICK_TRACKER - 
      AD_SERVING_DEFAULT_AD - 
      AD_SERVING_STANDARD_AD - 
      AD_SERVING_TRACKING - 
  sslRequired: boolean, Select only ads that require SSL.
  creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
  remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  creativeType: string, Select only ads with the specified creativeType.
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_DISPLAY - 
      CUSTOM_DISPLAY_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_IMAGE_GALLERY - 
      DISPLAY_REDIRECT - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      RICH_MEDIA_DISPLAY_BANNER - 
      RICH_MEDIA_DISPLAY_EXPANDING - 
      RICH_MEDIA_DISPLAY_INTERSTITIAL - 
      RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR_VIDEO - 
      VPAID_NON_LINEAR_VIDEO - 
  placementIds: string, Select only ads with these placement IDs assigned. (repeated)
  active: boolean, Select only active ads.
  compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  advertiserId: string, Select only ads with this advertiser ID.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
  audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
  ids: string, Select only ads with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Returns:
  An object of the form:

    { # Ad List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
    "ads": [ # Ad collection.
      { # Contains properties of a DCM ad.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
          "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a language that can be targeted by ads.
                "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
                "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
                "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
                "name": "A String", # Name of this language.
              },
            ],
          },
          "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
          "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
              { # Contains information about a country that can be targeted by ads.
                "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
                "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
                "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
                "countryCode": "A String", # Country code.
                "name": "A String", # Name of this country.
              },
            ],
            "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
            "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
              { # Contains information about a postal code that can be targeted by ads.
                "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
                "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
                "code": "A String", # Postal code. This is equivalent to the id field.
                "id": "A String", # ID of this postal code.
                "countryCode": "A String", # Country code of the country to which this postal code belongs.
              },
            ],
            "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
              { # Contains information about a region that can be targeted by ads.
                "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
                "countryDartId": "A String", # DART ID of the country to which this region belongs.
                "name": "A String", # Name of this region.
                "countryCode": "A String", # Country code of the country to which this region belongs.
                "regionCode": "A String", # Region code.
                "dartId": "A String", # DART ID of this region.
              },
            ],
            "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
              { # Contains information about a city that can be targeted by ads.
                "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
                "countryDartId": "A String", # DART ID of the country to which this city belongs.
                "name": "A String", # Name of this city.
                "countryCode": "A String", # Country code of the country to which this city belongs.
                "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
                "regionCode": "A String", # Region code of the region to which this city belongs.
                "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
                "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
                "regionDartId": "A String", # DART ID of the region to which this city belongs.
              },
            ],
            "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
              { # Contains information about a metro region that can be targeted by ads.
                "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
                "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
                "name": "A String", # Name of this metro region.
                "countryCode": "A String", # Country code of the country to which this metro region belongs.
                "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
                "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
                "dartId": "A String", # DART ID of this metro region.
              },
            ],
          },
          "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
            "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
            "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
            "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
              "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
              "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
            },
            "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Event tag overrides for this ad.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this ad is archived.
          "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
          "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a platform type that can be targeted by ads.
                "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
                "id": "A String", # ID of this platform type.
                "name": "A String", # Name of this platform type.
              },
            ],
            "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
              { # Contains information about a particular version of an operating system that can be targeted by ads.
                "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
                "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
                "name": "A String", # Name of this operating system version.
                "id": "A String", # ID of this operating system version.
                "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
                  "mobile": True or False, # Whether this operating system is for mobile.
                  "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                  "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                  "name": "A String", # Name of this operating system.
                  "desktop": True or False, # Whether this operating system is for desktop.
                },
                "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
              },
            ],
            "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a browser that can be targeted by ads.
                "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
                "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
                "name": "A String", # Name of this browser.
                "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
                "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
                "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
              },
            ],
            "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
              { # Contains information about an operating system that can be targeted by ads.
                "mobile": True or False, # Whether this operating system is for mobile.
                "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                "name": "A String", # Name of this operating system.
                "desktop": True or False, # Whether this operating system is for desktop.
              },
            ],
            "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
              { # Contains information about a mobile carrier that can be targeted by ads.
                "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
                "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
                "id": "A String", # ID of this mobile carrier.
                "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
                "name": "A String", # Name of this mobile carrier.
              },
            ],
            "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
                "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
                "id": "A String", # ID of this connection type.
                "name": "A String", # Name of this connection type.
              },
            ],
          },
          "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
            "creativeAssignments": [ # Creative assignments in this creative rotation.
              { # Creative Assignment.
                "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
                "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
                "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
                "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                    # Applicable when the creative type is any of the following:
                    # - RICH_MEDIA_INPAGE
                    # - RICH_MEDIA_INPAGE_FLOATING
                    # - RICH_MEDIA_IM_EXPAND
                    # - RICH_MEDIA_EXPANDING
                    # - RICH_MEDIA_INTERSTITIAL_FLOAT
                    # - RICH_MEDIA_MOBILE_IN_APP
                    # - RICH_MEDIA_MULTI_FLOATING
                    # - RICH_MEDIA_PEEL_DOWN
                    # - ADVANCED_BANNER
                    # - VPAID_LINEAR
                    # - VPAID_NON_LINEAR
                  { # Rich Media Exit Override.
                    "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                    },
                    "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
                    "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
                  },
                ],
                "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
                "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
                  { # Creative Group Assignment.
                    "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                    "creativeGroupId": "A String", # ID of the creative group to be assigned.
                  },
                ],
                "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
                  { # Companion Click-through override.
                    "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                    },
                    "creativeId": "A String", # ID of the creative for this companion click-through override.
                  },
                ],
                "startTime": "A String", # Date and time that the assigned creative should start serving.
                "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
                "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
                "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
                "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              },
            ],
            "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
            "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
            "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
          },
          "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "comments": "A String", # Comments for this ad.
          "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Expression describing which lists are being targeted by the ad.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
          "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
          "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "expression": "A String", # Keyword expression being targeted by the ad.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
          "active": True or False, # Whether this ad is active.
          "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
          "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
          "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
          "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
          "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
            "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
            "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
              42,
            ],
            "daysOfWeek": [ # Days of the week when the ad will serve.
                #
                # Acceptable values are:
                # - "SUNDAY"
                # - "MONDAY"
                # - "TUESDAY"
                # - "WEDNESDAY"
                # - "THURSDAY"
                # - "FRIDAY"
                # - "SATURDAY"
              "A String",
            ],
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "placementAssignments": [ # Placement assignments for this ad.
            { # Placement Assignment.
              "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
              "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "placementId": "A String", # ID of the placement to be assigned. This is a required field.
              "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
            },
          ],
          "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
          "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
        },
    ],
  }
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, id, body) 
Updates an existing ad. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Ad ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a language that can be targeted by ads.
          "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
          "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
          "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
          "name": "A String", # Name of this language.
        },
      ],
    },
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
update(profileId, body) 
Updates an existing ad.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM ad.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
    "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a language that can be targeted by ads.
          "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
          "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
          "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
          "name": "A String", # Name of this language.
        },
      ],
    },
    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
      { # Creative Group Assignment.
        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
        "creativeGroupId": "A String", # ID of the creative group to be assigned.
      },
    ],
    "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
      "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
      },
      "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Event tag overrides for this ad.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this ad is archived.
    "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
      "creativeAssignments": [ # Creative assignments in this creative rotation.
        { # Creative Assignment.
          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
          "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
              # Applicable when the creative type is any of the following:
              # - RICH_MEDIA_INPAGE
              # - RICH_MEDIA_INPAGE_FLOATING
              # - RICH_MEDIA_IM_EXPAND
              # - RICH_MEDIA_EXPANDING
              # - RICH_MEDIA_INTERSTITIAL_FLOAT
              # - RICH_MEDIA_MOBILE_IN_APP
              # - RICH_MEDIA_MULTI_FLOATING
              # - RICH_MEDIA_PEEL_DOWN
              # - ADVANCED_BANNER
              # - VPAID_LINEAR
              # - VPAID_NON_LINEAR
            { # Rich Media Exit Override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
            },
          ],
          "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
            { # Creative Group Assignment.
              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
              "creativeGroupId": "A String", # ID of the creative group to be assigned.
            },
          ],
          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
            { # Companion Click-through override.
              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
              },
              "creativeId": "A String", # ID of the creative for this companion click-through override.
            },
          ],
          "startTime": "A String", # Date and time that the assigned creative should start serving.
          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
          },
          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
      "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
    },
    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
    },
    "comments": "A String", # Comments for this ad.
    "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
    "active": True or False, # Whether this ad is active.
    "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
    "placementAssignments": [ # Placement assignments for this ad.
      { # Placement Assignment.
        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
        "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
      },
    ],
    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
    "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM ad.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
      "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
        { # Creative Group Assignment.
          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
          "creativeGroupId": "A String", # ID of the creative group to be assigned.
        },
      ],
      "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
        "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
        },
        "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Event tag overrides for this ad.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this ad is archived.
      "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
        "creativeAssignments": [ # Creative assignments in this creative rotation.
          { # Creative Assignment.
            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
            "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
                # Applicable when the creative type is any of the following:
                # - RICH_MEDIA_INPAGE
                # - RICH_MEDIA_INPAGE_FLOATING
                # - RICH_MEDIA_IM_EXPAND
                # - RICH_MEDIA_EXPANDING
                # - RICH_MEDIA_INTERSTITIAL_FLOAT
                # - RICH_MEDIA_MOBILE_IN_APP
                # - RICH_MEDIA_MULTI_FLOATING
                # - RICH_MEDIA_PEEL_DOWN
                # - ADVANCED_BANNER
                # - VPAID_LINEAR
                # - VPAID_NON_LINEAR
              { # Rich Media Exit Override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
              },
            ],
            "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
              { # Creative Group Assignment.
                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
                "creativeGroupId": "A String", # ID of the creative group to be assigned.
              },
            ],
            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
              { # Companion Click-through override.
                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
                },
                "creativeId": "A String", # ID of the creative for this companion click-through override.
              },
            ],
            "startTime": "A String", # Date and time that the assigned creative should start serving.
            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
            },
            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
        ],
        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
        "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
      },
      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
      },
      "comments": "A String", # Comments for this ad.
      "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
      "active": True or False, # Whether this ad is active.
      "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
      "placementAssignments": [ # Placement assignments for this ad.
        { # Placement Assignment.
          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
          "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
        },
      ],
      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
      "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.advertiserGroups.html000066400000000000000000000262671300622755700276630ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertiserGroups

Instance Methods

delete(profileId, id)

Deletes an existing advertiser group.

get(profileId, id)

Gets one advertiser group by ID.

insert(profileId, body)

Inserts a new advertiser group.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of advertiser groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser group. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser group.

Method Details

delete(profileId, id) 
Deletes an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
get(profileId, id) 
Gets one advertiser group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of advertiser groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only advertiser groups with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Advertiser Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
    "advertiserGroups": [ # Advertiser group collection.
      { # Groups advertisers together so that reports can be generated for the entire group at once.
          "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
          "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
          "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing advertiser group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Groups advertisers together so that reports can be generated for the entire group at once.
    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
    "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.advertisers.html000066400000000000000000001217041300622755700266360ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . advertisers

Instance Methods

get(profileId, id)

Gets one advertiser by ID.

insert(profileId, body)

Inserts a new advertiser.

list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)

Retrieves a list of advertisers, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing advertiser. This method supports patch semantics.

update(profileId, body)

Updates an existing advertiser.

Method Details

get(profileId, id) 
Gets one advertiser by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None) 
Retrieves a list of advertisers, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
  onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  status: string, Select only advertisers with the specified status.
    Allowed values
      APPROVED - 
      ON_HOLD - 
  maxResults: integer, Maximum number of results to return.
  advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
  subaccountId: string, Select only advertisers with these subaccount IDs.
  ids: string, Select only advertisers with these IDs. (repeated)
  floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Advertiser List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "advertisers": [ # Advertiser collection.
      { # Contains properties of a DCM advertiser.
          "status": "A String", # Status of this advertiser.
          "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
          "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
          "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
          "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
          "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
          "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
              # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
              # - This advertiser's original floodlight configuration is not already shared with another advertiser.
          "suspended": True or False, # Suspension status of this advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "defaultEmail": "A String", # Default email address used in sender field for tag emails.
          "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
  }
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, id, body) 
Updates an existing advertiser. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing advertiser.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM advertiser.
    "status": "A String", # Status of this advertiser.
    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
    "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
    "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
    "suspended": True or False, # Suspension status of this advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM advertiser.
      "status": "A String", # Status of this advertiser.
      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
      "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
      "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
      "suspended": True or False, # Suspension status of this advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.browsers.html000066400000000000000000000065301300622755700261500ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . browsers

Instance Methods

list(profileId)

Retrieves a list of browsers.

Method Details

list(profileId) 
Retrieves a list of browsers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Browser List Response
    "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
    "browsers": [ # Browser collection.
      { # Contains information about a browser that can be targeted by ads.
        "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
        "name": "A String", # Name of this browser.
        "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
        "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
        "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.campaignCreativeAssociations.html000066400000000000000000000120761300622755700321260ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaignCreativeAssociations

Instance Methods

insert(profileId, campaignId, body)

Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)

Retrieves the list of creative IDs associated with the specified campaign.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

insert(profileId, campaignId, body) 
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Identifies a creative which has been associated with a given campaign.
    "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
    "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
  }


Returns:
  An object of the form:

    { # Identifies a creative which has been associated with a given campaign.
      "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
      "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
    }
list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves the list of creative IDs associated with the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Campaign ID in this association. (required)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Campaign Creative Association List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "campaignCreativeAssociations": [ # Campaign creative association collection
      { # Identifies a creative which has been associated with a given campaign.
          "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
          "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
        },
    ],
    "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.campaigns.html000066400000000000000000003116531300622755700262510ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . campaigns

Instance Methods

get(profileId, id)

Gets one campaign by ID.

insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)

Inserts a new campaign.

list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)

Retrieves a list of campaigns, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing campaign. This method supports patch semantics.

update(profileId, body)

Updates an existing campaign.

Method Details

get(profileId, id) 
Gets one campaign by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body) 
Inserts a new campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
  defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None) 
Retrieves a list of campaigns, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
  archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
  advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  excludedIds: string, Exclude campaigns with these IDs. (repeated)
  advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
  searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
  subaccountId: string, Select only campaigns that belong to this subaccount.
  ids: string, Select only campaigns with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.

Returns:
  An object of the form:

    { # Campaign List Response
    "campaigns": [ # Campaign collection.
      { # Contains properties of a DCM campaign.
          "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
          "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
          "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
          },
          "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
            { # Event tag override information.
              "enabled": True or False, # Whether this override is enabled.
              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
            },
          ],
          "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
            "optimizationActivitys": [ # List of optimization activities associated with this configuration.
              { # Creative optimization activity.
                "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                  "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
                "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
              },
            ],
            "optimizationModel": "A String", # Optimization model for this configuration.
            "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
            "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
          },
          "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
          "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
          "traffickerEmails": [ # Campaign trafficker contact emails.
            "A String",
          ],
          "archived": True or False, # Whether this campaign has been archived.
          "externalId": "A String", # External ID for this campaign.
          "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
          "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
            "A String",
          ],
          "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
            { # Creative optimization settings.
              "optimizationActivitys": [ # List of optimization activities associated with this configuration.
                { # Creative optimization activity.
                  "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
                  "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                    "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                  },
                  "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
                },
              ],
              "optimizationModel": "A String", # Optimization model for this configuration.
              "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
              "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
            },
          ],
          "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
          },
          "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
          "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
          "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
            { # Audience Segment Group.
              "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
                { # Audience Segment.
                  "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
                  "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
                  "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
                },
              ],
              "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
            },
          ],
        },
    ],
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
  }
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, id, body) 
Updates an existing campaign. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
update(profileId, body) 
Updates an existing campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM campaign.
    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
    "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
    },
    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
      { # Event tag override information.
        "enabled": True or False, # Whether this override is enabled.
        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
      },
    ],
    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
        { # Creative optimization activity.
          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
        },
      ],
      "optimizationModel": "A String", # Optimization model for this configuration.
      "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
    },
    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
    "traffickerEmails": [ # Campaign trafficker contact emails.
      "A String",
    ],
    "archived": True or False, # Whether this campaign has been archived.
    "externalId": "A String", # External ID for this campaign.
    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
      "A String",
    ],
    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
      { # Creative optimization settings.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
    ],
    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
    },
    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
    "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
      { # Audience Segment Group.
        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
          { # Audience Segment.
            "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
          },
        ],
        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
      },
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM campaign.
      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
      "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
      "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
      },
      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
        { # Event tag override information.
          "enabled": True or False, # Whether this override is enabled.
          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
        },
      ],
      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
          { # Creative optimization activity.
            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
              "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
            "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
          },
        ],
        "optimizationModel": "A String", # Optimization model for this configuration.
        "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
      },
      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
      "traffickerEmails": [ # Campaign trafficker contact emails.
        "A String",
      ],
      "archived": True or False, # Whether this campaign has been archived.
      "externalId": "A String", # External ID for this campaign.
      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
        "A String",
      ],
      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
        { # Creative optimization settings.
          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
            { # Creative optimization activity.
              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
            },
          ],
          "optimizationModel": "A String", # Optimization model for this configuration.
          "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
        },
      ],
      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
      },
      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
      "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
        { # Audience Segment Group.
          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
            { # Audience Segment.
              "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
            },
          ],
          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.changeLogs.html000066400000000000000000000214531300622755700263550ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . changeLogs

Instance Methods

get(profileId, id)

Gets one change log by ID.

list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)

Retrieves a list of change logs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one change log by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Change log ID. (required)

Returns:
  An object of the form:

    { # Describes a change that a user has made to a resource.
    "changeTime": "A String", # Time when the object was modified.
    "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
    "subaccountId": "A String", # Subaccount ID of the modified object.
    "userProfileId": "A String", # ID of the user who modified the object.
    "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
    "newValue": "A String", # New value of the object field.
    "userProfileName": "A String", # User profile name of the user who modified the object.
    "fieldName": "A String", # Field name of the object which changed.
    "oldValue": "A String", # Old value of the object field.
    "action": "A String", # Action which caused the change.
    "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
    "objectType": "A String", # Object type of the change log.
    "id": "A String", # ID of this change log.
    "accountId": "A String", # Account ID of the modified object.
  }
list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None) 
Retrieves a list of change logs.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectType: string, Select only change logs with the specified object type.
    Allowed values
      OBJECT_ACCOUNT - 
      OBJECT_ACCOUNT_BILLING_FEATURE - 
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_ADVERTISER_GROUP - 
      OBJECT_BILLING_ACCOUNT_GROUP - 
      OBJECT_BILLING_FEATURE - 
      OBJECT_BILLING_MINIMUM_FEE - 
      OBJECT_BILLING_PROFILE - 
      OBJECT_CAMPAIGN - 
      OBJECT_CONTENT_CATEGORY - 
      OBJECT_CREATIVE - 
      OBJECT_CREATIVE_ASSET - 
      OBJECT_CREATIVE_BUNDLE - 
      OBJECT_CREATIVE_FIELD - 
      OBJECT_CREATIVE_GROUP - 
      OBJECT_DFA_SITE - 
      OBJECT_EVENT_TAG - 
      OBJECT_FLOODLIGHT_ACTIVITY_GROUP - 
      OBJECT_FLOODLIGHT_ACTVITY - 
      OBJECT_FLOODLIGHT_CONFIGURATION - 
      OBJECT_INSTREAM_CREATIVE - 
      OBJECT_LANDING_PAGE - 
      OBJECT_MEDIA_ORDER - 
      OBJECT_PLACEMENT - 
      OBJECT_PLACEMENT_STRATEGY - 
      OBJECT_PLAYSTORE_LINK - 
      OBJECT_PROVIDED_LIST_CLIENT - 
      OBJECT_RATE_CARD - 
      OBJECT_REMARKETING_LIST - 
      OBJECT_RICHMEDIA_CREATIVE - 
      OBJECT_SD_SITE - 
      OBJECT_SIZE - 
      OBJECT_SUBACCOUNT - 
      OBJECT_TARGETING_TEMPLATE - 
      OBJECT_USER_PROFILE - 
      OBJECT_USER_PROFILE_FILTER - 
      OBJECT_USER_ROLE - 
  maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxResults: integer, Maximum number of results to return.
  action: string, Select only change logs with the specified action.
    Allowed values
      ACTION_ADD - 
      ACTION_ASSIGN - 
      ACTION_ASSOCIATE - 
      ACTION_CREATE - 
      ACTION_DELETE - 
      ACTION_DISABLE - 
      ACTION_EMAIL_TAGS - 
      ACTION_ENABLE - 
      ACTION_LINK - 
      ACTION_MARK_AS_DEFAULT - 
      ACTION_PUSH - 
      ACTION_REMOVE - 
      ACTION_SEND - 
      ACTION_SHARE - 
      ACTION_UNASSIGN - 
      ACTION_UNLINK - 
      ACTION_UPDATE - 
  minChangeTime: string, Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
  searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
  userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
  ids: string, Select only change logs with these IDs. (repeated)
  objectIds: string, Select only change logs with these object IDs. (repeated)

Returns:
  An object of the form:

    { # Change Log List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
    "changeLogs": [ # Change log collection.
      { # Describes a change that a user has made to a resource.
        "changeTime": "A String", # Time when the object was modified.
        "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
        "subaccountId": "A String", # Subaccount ID of the modified object.
        "userProfileId": "A String", # ID of the user who modified the object.
        "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
        "newValue": "A String", # New value of the object field.
        "userProfileName": "A String", # User profile name of the user who modified the object.
        "fieldName": "A String", # Field name of the object which changed.
        "oldValue": "A String", # Old value of the object field.
        "action": "A String", # Action which caused the change.
        "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
        "objectType": "A String", # Object type of the change log.
        "id": "A String", # ID of this change log.
        "accountId": "A String", # Account ID of the modified object.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.cities.html000066400000000000000000000061251300622755700255620ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . cities

Instance Methods

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)

Retrieves a list of cities, possibly filtered.

Method Details

list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None) 
Retrieves a list of cities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartIds: string, Select only cities with these DART IDs. (repeated)
  namePrefix: string, Select only cities with names starting with this prefix.
  regionDartIds: string, Select only cities from these regions. (repeated)
  countryDartIds: string, Select only cities from these countries. (repeated)

Returns:
  An object of the form:

    { # City List Response
    "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
    "cities": [ # City collection.
      { # Contains information about a city that can be targeted by ads.
        "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
        "countryDartId": "A String", # DART ID of the country to which this city belongs.
        "name": "A String", # Name of this city.
        "countryCode": "A String", # Country code of the country to which this city belongs.
        "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
        "regionCode": "A String", # Region code of the region to which this city belongs.
        "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
        "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
        "regionDartId": "A String", # DART ID of the region to which this city belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.connectionTypes.html000066400000000000000000000061311300622755700274630ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . connectionTypes

Instance Methods

get(profileId, id)

Gets one connection type by ID.

list(profileId)

Retrieves a list of connection types.

Method Details

get(profileId, id) 
Gets one connection type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Connection type ID. (required)

Returns:
  An object of the form:

    { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
    "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
    "id": "A String", # ID of this connection type.
    "name": "A String", # Name of this connection type.
  }
list(profileId) 
Retrieves a list of connection types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Connection Type List Response
    "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
    "connectionTypes": [ # Collection of connection types such as broadband and mobile.
      { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
        "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
        "id": "A String", # ID of this connection type.
        "name": "A String", # Name of this connection type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.contentCategories.html000066400000000000000000000261311300622755700277610ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . contentCategories

Instance Methods

delete(profileId, id)

Deletes an existing content category.

get(profileId, id)

Gets one content category by ID.

insert(profileId, body)

Inserts a new content category.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of content categories, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing content category. This method supports patch semantics.

update(profileId, body)

Updates an existing content category.

Method Details

delete(profileId, id) 
Deletes an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
get(profileId, id) 
Gets one content category by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)

Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of content categories, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only content categories with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Content Category List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
    "contentCategories": [ # Content category collection.
      { # Organizes placements according to the contents of their associated webpages.
          "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
          "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
          "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
          "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing content category. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Content category ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing content category.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Organizes placements according to the contents of their associated webpages.
    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
    "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Organizes placements according to the contents of their associated webpages.
      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
      "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.conversions.html000066400000000000000000000224751300622755700266600ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . conversions

Instance Methods

batchinsert(profileId, body)

Inserts conversions.

Method Details

batchinsert(profileId, body) 
Inserts conversions.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Insert Conversions Request.
    "conversions": [ # The set of conversions to insert.
      { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
        "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
        "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
        "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
        "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
        "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
        "customVariables": [ # Custom floodlight variables.
          { # A custom floodlight variable.
            "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
            "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
            "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
          },
        ],
        "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
        "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
        "value": 3.14, # The value of the conversion.
        "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
        "quantity": "A String", # The quantity of the conversion.
        "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
        "encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field should only be used when calling conversions.batchinsert. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
          "A String",
        ],
      },
    ],
    "kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
    "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used.
      "kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
      "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
      "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
      "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
    },
  }


Returns:
  An object of the form:

    { # Insert Conversions Response.
    "status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
      { # The original conversion that was inserted or updated and whether there were any errors.
        "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
          "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
          "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
          "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
          "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
          "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
          "customVariables": [ # Custom floodlight variables.
            { # A custom floodlight variable.
              "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
              "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
              "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
            },
          ],
          "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
          "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
          "value": 3.14, # The value of the conversion.
          "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
          "quantity": "A String", # The quantity of the conversion.
          "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
          "encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field should only be used when calling conversions.batchinsert. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
            "A String",
          ],
        },
        "errors": [ # A list of errors related to this conversion.
          { # The error code and description for a conversion that failed to insert or update.
            "kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
            "code": "A String", # The error code.
            "message": "A String", # A description of the error.
          },
        ],
        "kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
      },
    ],
    "hasFailures": True or False, # Indicates that some or all conversions failed to insert.
    "kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.countries.html000066400000000000000000000062531300622755700263170ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . countries

Instance Methods

get(profileId, dartId)

Gets one country by ID.

list(profileId)

Retrieves a list of countries.

Method Details

get(profileId, dartId) 
Gets one country by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Country DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about a country that can be targeted by ads.
    "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
    "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
    "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
    "countryCode": "A String", # Country code.
    "name": "A String", # Name of this country.
  }
list(profileId) 
Retrieves a list of countries.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Country List Response
    "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
    "countries": [ # Country collection.
      { # Contains information about a country that can be targeted by ads.
        "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
        "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
        "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
        "countryCode": "A String", # Country code.
        "name": "A String", # Name of this country.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.creativeAssets.html000066400000000000000000000233101300622755700272620ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeAssets

Instance Methods

insert(profileId, advertiserId, body=None, media_body=None)

Inserts a new creative asset.

Method Details

insert(profileId, advertiserId, body=None, media_body=None) 
Inserts a new creative asset.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
  body: object, The request body.
    The object takes the form of:

{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
    "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
    "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
      "A String",
    ],
    "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
        # 
        # Possible values are:
        # - "ADMOB_REFERENCED"
        # - "ASSET_FORMAT_UNSUPPORTED_DCM"
        # - "ASSET_INVALID"
        # - "CLICK_TAG_HARD_CODED"
        # - "CLICK_TAG_INVALID"
        # - "CLICK_TAG_IN_GWD"
        # - "CLICK_TAG_MISSING"
        # - "CLICK_TAG_MORE_THAN_ONE"
        # - "CLICK_TAG_NON_TOP_LEVEL"
        # - "COMPONENT_UNSUPPORTED_DCM"
        # - "ENABLER_UNSUPPORTED_METHOD_DCM"
        # - "EXTERNAL_FILE_REFERENCED"
        # - "FILE_DETAIL_EMPTY"
        # - "FILE_TYPE_INVALID"
        # - "GWD_PROPERTIES_INVALID"
        # - "HTML5_FEATURE_UNSUPPORTED"
        # - "LINKED_FILE_NOT_FOUND"
        # - "MAX_FLASH_VERSION_11"
        # - "MRAID_REFERENCED"
        # - "NOT_SSL_COMPLIANT"
        # - "ORPHANED_ASSET"
        # - "PRIMARY_HTML_MISSING"
        # - "SVG_INVALID"
        # - "ZIP_INVALID"
      "A String",
    ],
    "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
      "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
      "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
    },
    "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Numeric ID of the asset. This is a read-only, auto-generated field.
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
      "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
      "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
        "A String",
      ],
      "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
          #
          # Possible values are:
          # - "ADMOB_REFERENCED"
          # - "ASSET_FORMAT_UNSUPPORTED_DCM"
          # - "ASSET_INVALID"
          # - "CLICK_TAG_HARD_CODED"
          # - "CLICK_TAG_INVALID"
          # - "CLICK_TAG_IN_GWD"
          # - "CLICK_TAG_MISSING"
          # - "CLICK_TAG_MORE_THAN_ONE"
          # - "CLICK_TAG_NON_TOP_LEVEL"
          # - "COMPONENT_UNSUPPORTED_DCM"
          # - "ENABLER_UNSUPPORTED_METHOD_DCM"
          # - "EXTERNAL_FILE_REFERENCED"
          # - "FILE_DETAIL_EMPTY"
          # - "FILE_TYPE_INVALID"
          # - "GWD_PROPERTIES_INVALID"
          # - "HTML5_FEATURE_UNSUPPORTED"
          # - "LINKED_FILE_NOT_FOUND"
          # - "MAX_FLASH_VERSION_11"
          # - "MRAID_REFERENCED"
          # - "NOT_SSL_COMPLIANT"
          # - "ORPHANED_ASSET"
          # - "PRIMARY_HTML_MISSING"
          # - "SVG_INVALID"
          # - "ZIP_INVALID"
        "A String",
      ],
      "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
        "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
        "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
      },
      "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Numeric ID of the asset. This is a read-only, auto-generated field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.creativeFieldValues.html000066400000000000000000000241561300622755700302340ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFieldValues

Instance Methods

delete(profileId, creativeFieldId, id)

Deletes an existing creative field value.

get(profileId, creativeFieldId, id)

Gets one creative field value by ID.

insert(profileId, creativeFieldId, body)

Inserts a new creative field value.

list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)

Retrieves a list of creative field values, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, creativeFieldId, id, body)

Updates an existing creative field value. This method supports patch semantics.

update(profileId, creativeFieldId, body)

Updates an existing creative field value.

Method Details

delete(profileId, creativeFieldId, id) 
Deletes an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
get(profileId, creativeFieldId, id) 
Gets one creative field value by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
insert(profileId, creativeFieldId, body) 
Inserts a new creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None) 
Retrieves a list of creative field values, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      VALUE - 
  ids: string, Select only creative field values with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field Value List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
    "creativeFieldValues": [ # Creative field value collection.
      { # Contains properties of a creative field value.
          "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
          "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
          "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
        },
    ],
  }
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, creativeFieldId, id, body) 
Updates an existing creative field value. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
update(profileId, creativeFieldId, body) 
Updates an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field value.
    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field value.
      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.creativeFields.html000066400000000000000000000500231300622755700272270ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeFields

Instance Methods

delete(profileId, id)

Deletes an existing creative field.

get(profileId, id)

Gets one creative field by ID.

insert(profileId, body)

Inserts a new creative field.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of creative fields, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative field. This method supports patch semantics.

update(profileId, body)

Updates an existing creative field.

Method Details

delete(profileId, id) 
Deletes an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
get(profileId, id) 
Gets one creative field by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)

Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of creative fields, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
  ids: string, Select only creative fields with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Field List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeFields": [ # Creative field collection.
      { # Contains properties of a creative field.
          "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
          "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
          "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
  }
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, id, body) 
Updates an existing creative field. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative Field ID (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative field.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative field.
    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative field.
      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.creativeGroups.html000066400000000000000000000541451300622755700273110ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creativeGroups

Instance Methods

get(profileId, id)

Gets one creative group by ID.

insert(profileId, body)

Inserts a new creative group.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)

Retrieves a list of creative groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative group. This method supports patch semantics.

update(profileId, body)

Updates an existing creative group.

Method Details

get(profileId, id) 
Gets one creative group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None) 
Retrieves a list of creative groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
  groupNumber: integer, Select only creative groups that belong to this subgroup.
  maxResults: integer, Maximum number of results to return.
  ids: string, Select only creative groups with these IDs. (repeated)
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Creative Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "creativeGroups": [ # Creative group collection.
      { # Contains properties of a creative group.
          "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
          "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
          "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
              # Acceptable values are:
              # - 1
              # - 2
          "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
  }
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, id, body) 
Updates an existing creative group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a creative group.
    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
    "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
        # Acceptable values are:
        # - 1
        # - 2
    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a creative group.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
          # Acceptable values are:
          # - 1
          # - 2
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.creatives.html000066400000000000000000013266041300622755700262770ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . creatives

Instance Methods

get(profileId, id)

Gets one creative by ID.

insert(profileId, body)

Inserts a new creative.

list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)

Retrieves a list of creatives, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing creative. This method supports patch semantics.

update(profileId, body)

Updates an existing creative.

Method Details

get(profileId, id) 
Gets one creative by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
          #
          # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
            "A String",
          ],
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
        "A String",
      ],
      "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
        "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
          { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
            "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
            "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
            "name": "A String", # A user-friendly name for this rule. This is a required field.
          },
        ],
        "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
      },
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
insert(profileId, body) 
Inserts a new creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
        # 
        # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "A String",
        ],
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
          "A String",
        ],
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
      "A String",
    ],
    "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
      "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
        { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
          "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
          "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
          "name": "A String", # A user-friendly name for this rule. This is a required field.
        },
      ],
      "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
    },
    "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
          #
          # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
            "A String",
          ],
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
        "A String",
      ],
      "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
        "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
          { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
            "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
            "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
            "name": "A String", # A user-friendly name for this rule. This is a required field.
          },
        ],
        "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
      },
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None) 
Retrieves a list of creatives, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only creatives with this campaign ID.
  advertiserId: string, Select only creatives with this advertiser ID.
  sizeIds: string, Select only creatives with these size IDs. (repeated)
  archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  renderingIds: string, Select only creatives with these rendering IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
  companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
  types: string, Select only creatives with these creative types. (repeated)
    Allowed values
      BRAND_SAFE_DEFAULT_INSTREAM_VIDEO - 
      CUSTOM_DISPLAY - 
      CUSTOM_DISPLAY_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_IMAGE_GALLERY - 
      DISPLAY_REDIRECT - 
      FLASH_INPAGE - 
      HTML5_BANNER - 
      IMAGE - 
      INSTREAM_VIDEO - 
      INSTREAM_VIDEO_REDIRECT - 
      INTERNAL_REDIRECT - 
      INTERSTITIAL_INTERNAL_REDIRECT - 
      RICH_MEDIA_DISPLAY_BANNER - 
      RICH_MEDIA_DISPLAY_EXPANDING - 
      RICH_MEDIA_DISPLAY_INTERSTITIAL - 
      RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL - 
      RICH_MEDIA_IM_EXPAND - 
      RICH_MEDIA_INPAGE_FLOATING - 
      RICH_MEDIA_MOBILE_IN_APP - 
      RICH_MEDIA_PEEL_DOWN - 
      TRACKING_TEXT - 
      VPAID_LINEAR_VIDEO - 
      VPAID_NON_LINEAR_VIDEO - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
  ids: string, Select only creatives with these IDs. (repeated)
  studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)

Returns:
  An object of the form:

    { # Creative List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
    "creatives": [ # Creative collection.
      { # Contains properties of a Creative.
          "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
            { # Third-party Tracking URL.
              "url": "A String", # URL for the specified third-party URL type.
              "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
            },
          ],
          "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
          "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
          "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
            "windowHeight": 42, # Height of the window.
            "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
            "windowWidth": 42, # Width of the window.
            "positionOption": "A String", # Position in the browser where the window will open.
            "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
          },
          "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
          "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
          "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
          "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
          "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
          "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
          "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
            { # Creative Custom Event.
              "targetType": "A String", # Target type used by the event.
              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                "showStatusBar": True or False, # Whether to display the browser status bar.
                "showScrollBar": True or False, # Whether to display the browser scroll bar.
                "showAddressBar": True or False, # Whether to display the browser address bar.
                "showMenuBar": True or False, # Whether to display the browser menu bar.
                "title": "A String", # Title of popup window.
                "showToolBar": True or False, # Whether to display the browser tool bar.
                "positionType": "A String", # Popup window position either centered or at specific coordinate.
                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                  "top": 42, # Offset distance from top side of an asset or a window.
                  "left": 42, # Offset distance from left side of an asset or a window.
                },
                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                  "width": 42, # Width of this size.
                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                  "height": 42, # Height of this size.
                },
              },
              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
              "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
              "advertiserCustomEventName": "A String", # User-entered name for the event.
            },
          ],
          "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
          "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
          "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
            { # Creative Field Assignment.
              "creativeFieldId": "A String", # ID of the creative field.
              "creativeFieldValueId": "A String", # ID of the creative field value.
            },
          ],
          "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
          "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
              #
              # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
          "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
          "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
            { # Creative Asset.
              "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
                "A String",
              ],
              "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
              "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
              "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
              "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
              "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
              "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
              "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
              "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
              "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
                  # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
                  # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
                  # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
                  # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
                  # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
                  # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
                  # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
                  # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
              "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
              "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
              "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
              "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
                "A String",
              ],
              "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
              "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
              "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
              "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
              "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
                "targetType": "A String", # Target type used by the event.
                "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
                "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
                "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
                  "showStatusBar": True or False, # Whether to display the browser status bar.
                  "showScrollBar": True or False, # Whether to display the browser scroll bar.
                  "showAddressBar": True or False, # Whether to display the browser address bar.
                  "showMenuBar": True or False, # Whether to display the browser menu bar.
                  "title": "A String", # Title of popup window.
                  "showToolBar": True or False, # Whether to display the browser tool bar.
                  "positionType": "A String", # Popup window position either centered or at specific coordinate.
                  "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                    "top": 42, # Offset distance from top side of an asset or a window.
                    "left": 42, # Offset distance from left side of an asset or a window.
                  },
                  "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                    "width": 42, # Width of this size.
                    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                    "height": 42, # Height of this size.
                  },
                },
                "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
                "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
                "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
                "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
                "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
                "advertiserCustomEventName": "A String", # User-entered name for the event.
              },
              "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
              "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
                "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
                "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
              },
              "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
              "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
              "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
            },
          ],
          "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
          "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
          "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
          "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            { # Creative Click Tag.
              "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
              "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
            },
          ],
          "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
          "active": True or False, # Whether the creative is active. Applicable to all creative types.
          "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
              #
              # Acceptable values are:
              # - "APP"
              # - "APP_INTERSTITIAL"
              # - "IN_STREAM_VIDEO"
              # - "DISPLAY"
              # - "DISPLAY_INTERSTITIAL"
            "A String",
          ],
          "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
          "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
            "A String",
          ],
          "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
          "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
          "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
          "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
          "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
          "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
          "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
          "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
            "A String",
          ],
          "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
            "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
              { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
                "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
                "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
                "name": "A String", # A user-friendly name for this rule. This is a required field.
              },
            ],
            "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
          },
          "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
          "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "customHtml": "A String", # User-entered value.
            "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
          },
          "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        },
    ],
  }
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, id, body) 
Updates an existing creative. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
        # 
        # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "A String",
        ],
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
          "A String",
        ],
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
      "A String",
    ],
    "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
      "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
        { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
          "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
          "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
          "name": "A String", # A user-friendly name for this rule. This is a required field.
        },
      ],
      "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
    },
    "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
          #
          # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
            "A String",
          ],
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
        "A String",
      ],
      "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
        "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
          { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
            "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
            "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
            "name": "A String", # A user-friendly name for this rule. This is a required field.
          },
        ],
        "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
      },
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
update(profileId, body) 
Updates an existing creative.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Creative.
    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      { # Third-party Tracking URL.
        "url": "A String", # URL for the specified third-party URL type.
        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
      },
    ],
    "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
    "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
    "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
      "windowHeight": 42, # Height of the window.
      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      "windowWidth": 42, # Width of the window.
      "positionOption": "A String", # Position in the browser where the window will open.
      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
    },
    "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
    "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
    "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
    "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
      { # Creative Custom Event.
        "targetType": "A String", # Target type used by the event.
        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
          "showStatusBar": True or False, # Whether to display the browser status bar.
          "showScrollBar": True or False, # Whether to display the browser scroll bar.
          "showAddressBar": True or False, # Whether to display the browser address bar.
          "showMenuBar": True or False, # Whether to display the browser menu bar.
          "title": "A String", # Title of popup window.
          "showToolBar": True or False, # Whether to display the browser tool bar.
          "positionType": "A String", # Popup window position either centered or at specific coordinate.
          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
        },
        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
        "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
        "advertiserCustomEventName": "A String", # User-entered name for the event.
      },
    ],
    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
    "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
      { # Creative Field Assignment.
        "creativeFieldId": "A String", # ID of the creative field.
        "creativeFieldValueId": "A String", # ID of the creative field value.
      },
    ],
    "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
    "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
        # 
        # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
    "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
      { # Creative Asset.
        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "A String",
        ],
        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
        "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
        "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "width": 42, # Width of this size.
          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
          "height": 42, # Height of this size.
        },
        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
        "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
        "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
            # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
            # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
            # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
            # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
        "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
          "A String",
        ],
        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
        "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
        "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
        "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
          "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
        },
        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
        "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "top": 42, # Offset distance from top side of an asset or a window.
          "left": 42, # Offset distance from left side of an asset or a window.
        },
        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
      },
    ],
    "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
    "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
    "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
    "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      { # Creative Click Tag.
        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
        "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
      },
    ],
    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    "active": True or False, # Whether the creative is active. Applicable to all creative types.
    "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
        # 
        # Acceptable values are:
        # - "APP"
        # - "APP_INTERSTITIAL"
        # - "IN_STREAM_VIDEO"
        # - "DISPLAY"
        # - "DISPLAY_INTERSTITIAL"
      "A String",
    ],
    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
    "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "A String",
    ],
    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
    "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
    "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
    "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
      "A String",
    ],
    "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
      "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
        { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
          "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
          "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
          "name": "A String", # A user-friendly name for this rule. This is a required field.
        },
      ],
      "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
    },
    "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
    "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "A String",
    ],
    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "customHtml": "A String", # User-entered value.
      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
    },
    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
  }


Returns:
  An object of the form:

    { # Contains properties of a Creative.
      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
        { # Third-party Tracking URL.
          "url": "A String", # URL for the specified third-party URL type.
          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
        },
      ],
      "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
      "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
      "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
        "windowHeight": 42, # Height of the window.
        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
        "windowWidth": 42, # Width of the window.
        "positionOption": "A String", # Position in the browser where the window will open.
        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
      },
      "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
      "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
      "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
      "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
        { # Creative Custom Event.
          "targetType": "A String", # Target type used by the event.
          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
            "showStatusBar": True or False, # Whether to display the browser status bar.
            "showScrollBar": True or False, # Whether to display the browser scroll bar.
            "showAddressBar": True or False, # Whether to display the browser address bar.
            "showMenuBar": True or False, # Whether to display the browser menu bar.
            "title": "A String", # Title of popup window.
            "showToolBar": True or False, # Whether to display the browser tool bar.
            "positionType": "A String", # Popup window position either centered or at specific coordinate.
            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
              "top": 42, # Offset distance from top side of an asset or a window.
              "left": 42, # Offset distance from left side of an asset or a window.
            },
            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
              "width": 42, # Width of this size.
              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
              "height": 42, # Height of this size.
            },
          },
          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
          "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
          "advertiserCustomEventName": "A String", # User-entered name for the event.
        },
      ],
      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
      "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
        { # Creative Field Assignment.
          "creativeFieldId": "A String", # ID of the creative field.
          "creativeFieldValueId": "A String", # ID of the creative field value.
        },
      ],
      "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
      "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types.
          #
          # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
      "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
        { # Creative Asset.
          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "A String",
          ],
          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO.
          "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
          "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
              # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
              # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.
              # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
              # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
          "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
            "A String",
          ],
          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
          "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
            "targetType": "A String", # Target type used by the event.
            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
              "showStatusBar": True or False, # Whether to display the browser status bar.
              "showScrollBar": True or False, # Whether to display the browser scroll bar.
              "showAddressBar": True or False, # Whether to display the browser address bar.
              "showMenuBar": True or False, # Whether to display the browser menu bar.
              "title": "A String", # Title of popup window.
              "showToolBar": True or False, # Whether to display the browser tool bar.
              "positionType": "A String", # Popup window position either centered or at specific coordinate.
              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
                "top": 42, # Offset distance from top side of an asset or a window.
                "left": 42, # Offset distance from left side of an asset or a window.
              },
              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
                "width": 42, # Width of this size.
                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
                "height": 42, # Height of this size.
              },
            },
            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
            "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
            "advertiserCustomEventName": "A String", # User-entered name for the event.
          },
          "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
          "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
            "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
            "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
          },
          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
          "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
            "top": 42, # Offset distance from top side of an asset or a window.
            "left": 42, # Offset distance from left side of an asset or a window.
          },
          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
        },
      ],
      "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
      "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
      "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
      "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        { # Creative Click Tag.
          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
          "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
        },
      ],
      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
      "active": True or False, # Whether the creative is active. Applicable to all creative types.
      "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
          #
          # Acceptable values are:
          # - "APP"
          # - "APP_INTERSTITIAL"
          # - "IN_STREAM_VIDEO"
          # - "DISPLAY"
          # - "DISPLAY_INTERSTITIAL"
        "A String",
      ],
      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
      "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
        "A String",
      ],
      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
      "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
      "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
      "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
      "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
        "A String",
      ],
      "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
        "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
          { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
            "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
            "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
            "name": "A String", # A user-friendly name for this rule. This is a required field.
          },
        ],
        "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
      },
      "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
      "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "A String",
      ],
      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
        "customHtml": "A String", # User-entered value.
        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
      },
      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.dimensionValues.html000066400000000000000000000115331300622755700274460ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dimensionValues

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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.directorySiteContacts.html000066400000000000000000000142361300622755700306340ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySiteContacts

Instance Methods

get(profileId, id)

Gets one directory site contact by ID.

list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of directory site contacts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site contact by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site contact ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Site Directory contact.
    "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
    "firstName": "A String", # First name of this directory site contact.
    "title": "A String", # Title or designation of this directory site contact.
    "lastName": "A String", # Last name of this directory site contact.
    "email": "A String", # Email address of this directory site contact.
    "phone": "A String", # Phone number of this directory site contact.
    "role": "A String", # Directory site contact role.
    "address": "A String", # Address of this directory site contact.
    "type": "A String", # Directory site contact type.
    "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
  }
list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of directory site contacts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
  directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory site contacts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Directory Site Contact List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "directorySiteContacts": [ # Directory site contact collection
      { # Contains properties of a Site Directory contact.
        "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
        "firstName": "A String", # First name of this directory site contact.
        "title": "A String", # Title or designation of this directory site contact.
        "lastName": "A String", # Last name of this directory site contact.
        "email": "A String", # Email address of this directory site contact.
        "phone": "A String", # Phone number of this directory site contact.
        "role": "A String", # Directory site contact role.
        "address": "A String", # Address of this directory site contact.
        "type": "A String", # Directory site contact type.
        "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
      },
    ],
    "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.directorySites.html000066400000000000000000000667611300622755700273320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . directorySites

Instance Methods

get(profileId, id)

Gets one directory site by ID.

insert(profileId, body)

Inserts a new directory site.

list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)

Retrieves a list of directory sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one directory site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Directory site ID. (required)

Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
insert(profileId, body) 
Inserts a new directory site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
    "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
    "countryId": "A String", # Country ID of this directory site.
    "description": "A String", # Description of this directory site.
    "settings": { # Directory Site Settings # Directory site settings.
      "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
      "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
      "dfp_settings": { # DFP Settings # Directory site DFP settings.
        "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
        "dfp_network_name": "A String", # DFP network name for this directory site.
        "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
        "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
        "dfp_network_code": "A String", # DFP network code for this directory site.
      },
      "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
      "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
      "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
      "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
    },
    "currencyId": "A String", # Currency ID of this directory site.
        # Possible values are:
        # - "1" for USD
        # - "2" for GBP
        # - "3" for ESP
        # - "4" for SEK
        # - "5" for CAD
        # - "6" for JPY
        # - "7" for DEM
        # - "8" for AUD
        # - "9" for FRF
        # - "10" for ITL
        # - "11" for DKK
        # - "12" for NOK
        # - "13" for FIM
        # - "14" for ZAR
        # - "15" for IEP
        # - "16" for NLG
        # - "17" for EUR
        # - "18" for KRW
        # - "19" for TWD
        # - "20" for SGD
        # - "21" for CNY
        # - "22" for HKD
        # - "23" for NZD
        # - "24" for MYR
        # - "25" for BRL
        # - "26" for PTE
        # - "27" for MXP
        # - "28" for CLP
        # - "29" for TRY
        # - "30" for ARS
        # - "31" for PEN
        # - "32" for ILS
        # - "33" for CHF
        # - "34" for VEF
        # - "35" for COP
        # - "36" for GTQ
        # - "37" for PLN
        # - "39" for INR
        # - "40" for THB
        # - "41" for IDR
        # - "42" for CZK
        # - "43" for RON
        # - "44" for HUF
        # - "45" for RUB
        # - "46" for AED
        # - "47" for BGN
        # - "48" for HRK
    "inpageTagFormats": [ # Tag types for regular placements.
        # 
        # Acceptable values are:
        # - "STANDARD"
        # - "IFRAME_JAVASCRIPT_INPAGE"
        # - "INTERNAL_REDIRECT_INPAGE"
        # - "JAVASCRIPT_INPAGE"
      "A String",
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "interstitialTagFormats": [ # Tag types for interstitial placements.
        # 
        # Acceptable values are:
        # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
        # - "INTERNAL_REDIRECT_INTERSTITIAL"
        # - "JAVASCRIPT_INTERSTITIAL"
      "A String",
    ],
    "contactAssignments": [ # Directory site contacts.
      { # Directory Site Contact Assignment
        "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
        "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
      },
    ],
    "url": "A String", # URL of this directory site.
    "parentId": "A String", # Parent directory site ID.
    "active": True or False, # Whether this directory site is active.
    "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
    "name": "A String", # Name of this directory site.
  }


Returns:
  An object of the form:

    { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
      "countryId": "A String", # Country ID of this directory site.
      "description": "A String", # Description of this directory site.
      "settings": { # Directory Site Settings # Directory site settings.
        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
        "dfp_settings": { # DFP Settings # Directory site DFP settings.
          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
          "dfp_network_name": "A String", # DFP network name for this directory site.
          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
          "dfp_network_code": "A String", # DFP network code for this directory site.
        },
        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
      },
      "currencyId": "A String", # Currency ID of this directory site.
          # Possible values are:
          # - "1" for USD
          # - "2" for GBP
          # - "3" for ESP
          # - "4" for SEK
          # - "5" for CAD
          # - "6" for JPY
          # - "7" for DEM
          # - "8" for AUD
          # - "9" for FRF
          # - "10" for ITL
          # - "11" for DKK
          # - "12" for NOK
          # - "13" for FIM
          # - "14" for ZAR
          # - "15" for IEP
          # - "16" for NLG
          # - "17" for EUR
          # - "18" for KRW
          # - "19" for TWD
          # - "20" for SGD
          # - "21" for CNY
          # - "22" for HKD
          # - "23" for NZD
          # - "24" for MYR
          # - "25" for BRL
          # - "26" for PTE
          # - "27" for MXP
          # - "28" for CLP
          # - "29" for TRY
          # - "30" for ARS
          # - "31" for PEN
          # - "32" for ILS
          # - "33" for CHF
          # - "34" for VEF
          # - "35" for COP
          # - "36" for GTQ
          # - "37" for PLN
          # - "39" for INR
          # - "40" for THB
          # - "41" for IDR
          # - "42" for CZK
          # - "43" for RON
          # - "44" for HUF
          # - "45" for RUB
          # - "46" for AED
          # - "47" for BGN
          # - "48" for HRK
      "inpageTagFormats": [ # Tag types for regular placements.
          #
          # Acceptable values are:
          # - "STANDARD"
          # - "IFRAME_JAVASCRIPT_INPAGE"
          # - "INTERNAL_REDIRECT_INPAGE"
          # - "JAVASCRIPT_INPAGE"
        "A String",
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "interstitialTagFormats": [ # Tag types for interstitial placements.
          #
          # Acceptable values are:
          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
          # - "INTERNAL_REDIRECT_INTERSTITIAL"
          # - "JAVASCRIPT_INTERSTITIAL"
        "A String",
      ],
      "contactAssignments": [ # Directory site contacts.
        { # Directory Site Contact Assignment
          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
          "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
        },
      ],
      "url": "A String", # URL of this directory site.
      "parentId": "A String", # Parent directory site ID.
      "active": True or False, # Whether this directory site is active.
      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
      "name": "A String", # Name of this directory site.
    }
list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None) 
Retrieves a list of directory sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  countryId: string, Select only directory sites with this country ID.
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  parentId: string, Select only directory sites with this parent ID.
  acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
  searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only directory sites with these IDs. (repeated)
  dfp_network_code: string, Select only directory sites with this DFP network code.

Returns:
  An object of the form:

    { # Directory Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
    "directorySites": [ # Directory site collection.
      { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
          "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
          "countryId": "A String", # Country ID of this directory site.
          "description": "A String", # Description of this directory site.
          "settings": { # Directory Site Settings # Directory site settings.
            "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
            "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
            "dfp_settings": { # DFP Settings # Directory site DFP settings.
              "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
              "dfp_network_name": "A String", # DFP network name for this directory site.
              "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
              "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
              "dfp_network_code": "A String", # DFP network code for this directory site.
            },
            "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
            "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
            "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
            "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
          },
          "currencyId": "A String", # Currency ID of this directory site.
              # Possible values are:
              # - "1" for USD
              # - "2" for GBP
              # - "3" for ESP
              # - "4" for SEK
              # - "5" for CAD
              # - "6" for JPY
              # - "7" for DEM
              # - "8" for AUD
              # - "9" for FRF
              # - "10" for ITL
              # - "11" for DKK
              # - "12" for NOK
              # - "13" for FIM
              # - "14" for ZAR
              # - "15" for IEP
              # - "16" for NLG
              # - "17" for EUR
              # - "18" for KRW
              # - "19" for TWD
              # - "20" for SGD
              # - "21" for CNY
              # - "22" for HKD
              # - "23" for NZD
              # - "24" for MYR
              # - "25" for BRL
              # - "26" for PTE
              # - "27" for MXP
              # - "28" for CLP
              # - "29" for TRY
              # - "30" for ARS
              # - "31" for PEN
              # - "32" for ILS
              # - "33" for CHF
              # - "34" for VEF
              # - "35" for COP
              # - "36" for GTQ
              # - "37" for PLN
              # - "39" for INR
              # - "40" for THB
              # - "41" for IDR
              # - "42" for CZK
              # - "43" for RON
              # - "44" for HUF
              # - "45" for RUB
              # - "46" for AED
              # - "47" for BGN
              # - "48" for HRK
          "inpageTagFormats": [ # Tag types for regular placements.
              #
              # Acceptable values are:
              # - "STANDARD"
              # - "IFRAME_JAVASCRIPT_INPAGE"
              # - "INTERNAL_REDIRECT_INPAGE"
              # - "JAVASCRIPT_INPAGE"
            "A String",
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "interstitialTagFormats": [ # Tag types for interstitial placements.
              #
              # Acceptable values are:
              # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
              # - "INTERNAL_REDIRECT_INTERSTITIAL"
              # - "JAVASCRIPT_INTERSTITIAL"
            "A String",
          ],
          "contactAssignments": [ # Directory site contacts.
            { # Directory Site Contact Assignment
              "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
              "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
            },
          ],
          "url": "A String", # URL of this directory site.
          "parentId": "A String", # Parent directory site ID.
          "active": True or False, # Whether this directory site is active.
          "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
          "name": "A String", # Name of this directory site.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.dynamicTargetingKeys.html000066400000000000000000000162631300622755700304330ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . dynamicTargetingKeys

Instance Methods

delete(profileId, objectId, name, objectType)

Deletes an existing dynamic targeting key.

insert(profileId, body)

Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)

Retrieves a list of dynamic targeting keys.

Method Details

delete(profileId, objectId, name, objectType) 
Deletes an existing dynamic targeting key.

Args:
  profileId: string, User profile ID associated with this request. (required)
  objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
  name: string, Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. (required)
  objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
    Allowed values
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_CREATIVE - 
      OBJECT_PLACEMENT -
insert(profileId, body) 
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
    "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
    "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
    "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
    "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
  }


Returns:
  An object of the form:

    { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
      "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
      "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
      "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
      "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
    }
list(profileId, advertiserId=None, objectId=None, names=None, objectType=None) 
Retrieves a list of dynamic targeting keys.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
  objectId: string, Select only dynamic targeting keys with this object ID.
  names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
  objectType: string, Select only dynamic targeting keys with this object type.
    Allowed values
      OBJECT_AD - 
      OBJECT_ADVERTISER - 
      OBJECT_CREATIVE - 
      OBJECT_PLACEMENT - 

Returns:
  An object of the form:

    { # Dynamic Targeting Key List Response
    "kind": "dfareporting#dynamicTargetingKeysListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
    "dynamicTargetingKeys": [ # Dynamic targeting key collection.
      { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
          "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
          "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
          "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
          "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.eventTags.html000066400000000000000000001223761300622755700262510ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . eventTags

Instance Methods

delete(profileId, id)

Deletes an existing event tag.

get(profileId, id)

Gets one event tag by ID.

insert(profileId, body)

Inserts a new event tag.

list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)

Retrieves a list of event tags, possibly filtered.

patch(profileId, id, body)

Updates an existing event tag. This method supports patch semantics.

update(profileId, body)

Updates an existing event tag.

Method Details

delete(profileId, id) 
Deletes an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
get(profileId, id) 
Gets one event tag by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)

Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None) 
Retrieves a list of event tags, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Select only event tags that belong to this campaign.
  advertiserId: string, Select only event tags that belong to this advertiser.
  adId: string, Select only event tags that belong to this ad.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  definitionsOnly: boolean, Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
  eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
    Allowed values
      CLICK_THROUGH_EVENT_TAG - 
      IMPRESSION_IMAGE_EVENT_TAG - 
      IMPRESSION_JAVASCRIPT_EVENT_TAG - 
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  enabled: boolean, Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
  ids: string, Select only event tags with these IDs. (repeated)

Returns:
  An object of the form:

    { # Event Tag List Response
    "eventTags": [ # Event tag collection.
      { # Contains properties of an event tag.
          "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
          "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
          "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
          "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
          "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
          "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
          "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
          "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
          "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
          "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
            "A String",
          ],
          "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
          "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
          "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
  }
patch(profileId, id, body) 
Updates an existing event tag. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of an event tag.
    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
    "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
    "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
      "A String",
    ],
    "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
    "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of an event tag.
      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
      "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
      "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
        "A String",
      ],
      "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
      "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.files.html000066400000000000000000000177121300622755700254100ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.floodlightActivities.html000066400000000000000000002332701300622755700304650ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivities

Instance Methods

delete(profileId, id)

Deletes an existing floodlight activity.

generatetag(profileId, floodlightActivityId=None)

Generates a tag for a floodlight activity.

get(profileId, id)

Gets one floodlight activity by ID.

insert(profileId, body)

Inserts a new floodlight activity.

list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)

Retrieves a list of floodlight activities, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity.

Method Details

delete(profileId, id) 
Deletes an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
generatetag(profileId, floodlightActivityId=None) 
Generates a tag for a floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.

Returns:
  An object of the form:

    { # Floodlight Activity GenerateTag Response
    "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
    "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
  }
get(profileId, id) 
Gets one floodlight activity by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
insert(profileId, body) 
Inserts a new floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None) 
Retrieves a list of floodlight activities, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
  advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  tagString: string, Select only floodlight activities with the specified tag string.
  floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
  floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxResults: integer, Maximum number of results to return.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
  floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
    "floodlightActivities": [ # Floodlight activity collection.
      { # Contains properties of a Floodlight activity.
          "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
          "secure": True or False, # Whether this tag should use SSL.
          "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
          "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
          "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
          "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
          "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
          "publisherTags": [ # Publisher dynamic floodlight tags.
            { # Publisher Dynamic Tag
              "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
              "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
              "siteId": "A String", # Site ID of this dynamic tag.
              "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
                "tag": "A String", # Tag code.
                "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
                "name": "A String", # Name of this tag.
              },
              "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
              "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            },
          ],
          "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "hidden": True or False, # Whether this activity is archived.
          "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
          "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
          "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
          "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
          "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
          "notes": "A String", # General notes or implementation instructions for the tag.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
          "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
              # Acceptable values are:
              # - "U1"
              # - "U2"
              # - "U3"
              # - "U4"
              # - "U5"
              # - "U6"
              # - "U7"
              # - "U8"
              # - "U9"
              # - "U10"
              # - "U11"
              # - "U12"
              # - "U13"
              # - "U14"
              # - "U15"
              # - "U16"
              # - "U17"
              # - "U18"
              # - "U19"
              # - "U20"
            "A String",
          ],
          "defaultTags": [ # Dynamic floodlight tags.
            { # Dynamic Tag
              "tag": "A String", # Tag code.
              "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
              "name": "A String", # Name of this tag.
            },
          ],
          "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
          "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
update(profileId, body) 
Updates an existing floodlight activity.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity.
    "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
    "secure": True or False, # Whether this tag should use SSL.
    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
    "publisherTags": [ # Publisher dynamic floodlight tags.
      { # Publisher Dynamic Tag
        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
        "siteId": "A String", # Site ID of this dynamic tag.
        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
        "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
    ],
    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "hidden": True or False, # Whether this activity is archived.
    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
    "notes": "A String", # General notes or implementation instructions for the tag.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
    "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
        # Acceptable values are:
        # - "U1"
        # - "U2"
        # - "U3"
        # - "U4"
        # - "U5"
        # - "U6"
        # - "U7"
        # - "U8"
        # - "U9"
        # - "U10"
        # - "U11"
        # - "U12"
        # - "U13"
        # - "U14"
        # - "U15"
        # - "U16"
        # - "U17"
        # - "U18"
        # - "U19"
        # - "U20"
      "A String",
    ],
    "defaultTags": [ # Dynamic floodlight tags.
      { # Dynamic Tag
        "tag": "A String", # Tag code.
        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
        "name": "A String", # Name of this tag.
      },
    ],
    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity.
      "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
      "secure": True or False, # Whether this tag should use SSL.
      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
      "publisherTags": [ # Publisher dynamic floodlight tags.
        { # Publisher Dynamic Tag
          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
          "siteId": "A String", # Site ID of this dynamic tag.
          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
            "tag": "A String", # Tag code.
            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
            "name": "A String", # Name of this tag.
          },
          "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        },
      ],
      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "hidden": True or False, # Whether this activity is archived.
      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
      "notes": "A String", # General notes or implementation instructions for the tag.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
      "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
          # Acceptable values are:
          # - "U1"
          # - "U2"
          # - "U3"
          # - "U4"
          # - "U5"
          # - "U6"
          # - "U7"
          # - "U8"
          # - "U9"
          # - "U10"
          # - "U11"
          # - "U12"
          # - "U13"
          # - "U14"
          # - "U15"
          # - "U16"
          # - "U17"
          # - "U18"
          # - "U19"
          # - "U20"
        "A String",
      ],
      "defaultTags": [ # Dynamic floodlight tags.
        { # Dynamic Tag
          "tag": "A String", # Tag code.
          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
          "name": "A String", # Name of this tag.
        },
      ],
      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.floodlightActivityGroups.html000066400000000000000000001251721300622755700313560ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightActivityGroups

Instance Methods

get(profileId, id)

Gets one floodlight activity group by ID.

insert(profileId, body)

Inserts a new floodlight activity group.

list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)

Retrieves a list of floodlight activity groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing floodlight activity group. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight activity group.

Method Details

get(profileId, id) 
Gets one floodlight activity group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None) 
Retrieves a list of floodlight activity groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
  ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only floodlight activity groups with the specified floodlight activity group type.
    Allowed values
      COUNTER - 
      SALE - 

Returns:
  An object of the form:

    { # Floodlight Activity Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
    "floodlightActivityGroups": [ # Floodlight activity group collection.
      { # Contains properties of a Floodlight activity group.
          "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
          "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
          "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
          "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing floodlight activity group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight activity Group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight activity group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight activity group.
    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
    "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
    "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight activity group.
      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
      "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
      "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.floodlightConfigurations.html000066400000000000000000001153651300622755700313570ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . floodlightConfigurations

Instance Methods

get(profileId, id)

Gets one floodlight configuration by ID.

list(profileId, ids=None)

Retrieves a list of floodlight configurations, possibly filtered.

patch(profileId, id, body)

Updates an existing floodlight configuration. This method supports patch semantics.

update(profileId, body)

Updates an existing floodlight configuration.

Method Details

get(profileId, id) 
Gets one floodlight configuration by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
list(profileId, ids=None) 
Retrieves a list of floodlight configurations, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)

Returns:
  An object of the form:

    { # Floodlight Configuration List Response
    "floodlightConfigurations": [ # Floodlight configuration collection.
      { # Contains properties of a Floodlight configuration.
          "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
          "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
          "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
            "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
            "imageTagEnabled": True or False, # Whether image tags are enabled.
          },
          "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
          "standardVariableTypes": [ # List of standard variables enabled for this configuration.
              #
              # Acceptable values are:
              # - "ORD"
              # - "NUM"
            "A String",
          ],
          "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
            "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
            "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
          },
          "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
          "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
          "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
          "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
          "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
            { # Third Party Authentication Token
              "name": "A String", # Name of the third-party authentication token.
              "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
            },
          ],
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
          "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
            { # User Defined Variable configuration.
              "dataType": "A String", # Data type for the variable. This is a required field.
              "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
              "variableType": "A String", # Variable name in the tag. This is a required field.
            },
          ],
          "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
        },
    ],
    "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
  }
patch(profileId, id, body) 
Updates an existing floodlight configuration. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Floodlight configuration ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing floodlight configuration.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a Floodlight configuration.
    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
    "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
      "imageTagEnabled": True or False, # Whether image tags are enabled.
    },
    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
        # 
        # Acceptable values are:
        # - "ORD"
        # - "NUM"
      "A String",
    ],
    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
    },
    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
      { # Third Party Authentication Token
        "name": "A String", # Name of the third-party authentication token.
        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
      },
    ],
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
      { # User Defined Variable configuration.
        "dataType": "A String", # Data type for the variable. This is a required field.
        "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
        "variableType": "A String", # Variable name in the tag. This is a required field.
      },
    ],
    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a Floodlight configuration.
      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
      "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
        "imageTagEnabled": True or False, # Whether image tags are enabled.
      },
      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
          #
          # Acceptable values are:
          # - "ORD"
          # - "NUM"
        "A String",
      ],
      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
      },
      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
        { # Third Party Authentication Token
          "name": "A String", # Name of the third-party authentication token.
          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
        },
      ],
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
        { # User Defined Variable configuration.
          "dataType": "A String", # Data type for the variable. This is a required field.
          "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
          "variableType": "A String", # Variable name in the tag. This is a required field.
        },
      ],
      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.html000066400000000000000000000301471300622755700243040ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API

Instance Methods

accountActiveAdSummaries()

Returns the accountActiveAdSummaries Resource.

accountPermissionGroups()

Returns the accountPermissionGroups Resource.

accountPermissions()

Returns the accountPermissions Resource.

accountUserProfiles()

Returns the accountUserProfiles Resource.

accounts()

Returns the accounts Resource.

ads()

Returns the ads Resource.

advertiserGroups()

Returns the advertiserGroups Resource.

advertisers()

Returns the advertisers Resource.

browsers()

Returns the browsers Resource.

campaignCreativeAssociations()

Returns the campaignCreativeAssociations Resource.

campaigns()

Returns the campaigns Resource.

changeLogs()

Returns the changeLogs Resource.

cities()

Returns the cities Resource.

connectionTypes()

Returns the connectionTypes Resource.

contentCategories()

Returns the contentCategories Resource.

conversions()

Returns the conversions Resource.

countries()

Returns the countries Resource.

creativeAssets()

Returns the creativeAssets Resource.

creativeFieldValues()

Returns the creativeFieldValues Resource.

creativeFields()

Returns the creativeFields Resource.

creativeGroups()

Returns the creativeGroups Resource.

creatives()

Returns the creatives Resource.

dimensionValues()

Returns the dimensionValues Resource.

directorySiteContacts()

Returns the directorySiteContacts Resource.

directorySites()

Returns the directorySites Resource.

dynamicTargetingKeys()

Returns the dynamicTargetingKeys Resource.

eventTags()

Returns the eventTags Resource.

files()

Returns the files Resource.

floodlightActivities()

Returns the floodlightActivities Resource.

floodlightActivityGroups()

Returns the floodlightActivityGroups Resource.

floodlightConfigurations()

Returns the floodlightConfigurations Resource.

inventoryItems()

Returns the inventoryItems Resource.

landingPages()

Returns the landingPages Resource.

languages()

Returns the languages Resource.

metros()

Returns the metros Resource.

mobileCarriers()

Returns the mobileCarriers Resource.

operatingSystemVersions()

Returns the operatingSystemVersions Resource.

operatingSystems()

Returns the operatingSystems Resource.

orderDocuments()

Returns the orderDocuments Resource.

orders()

Returns the orders Resource.

placementGroups()

Returns the placementGroups Resource.

placementStrategies()

Returns the placementStrategies Resource.

placements()

Returns the placements Resource.

platformTypes()

Returns the platformTypes Resource.

postalCodes()

Returns the postalCodes Resource.

projects()

Returns the projects Resource.

regions()

Returns the regions Resource.

remarketingListShares()

Returns the remarketingListShares Resource.

remarketingLists()

Returns the remarketingLists Resource.

reports()

Returns the reports Resource.

sites()

Returns the sites Resource.

sizes()

Returns the sizes Resource.

subaccounts()

Returns the subaccounts Resource.

targetableRemarketingLists()

Returns the targetableRemarketingLists Resource.

targetingTemplates()

Returns the targetingTemplates Resource.

userProfiles()

Returns the userProfiles Resource.

userRolePermissionGroups()

Returns the userRolePermissionGroups Resource.

userRolePermissions()

Returns the userRolePermissions Resource.

userRoles()

Returns the userRoles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.inventoryItems.html000066400000000000000000000316271300622755700273460ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . inventoryItems

Instance Methods

get(profileId, projectId, id)

Gets one inventory item by ID.

list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)

Retrieves a list of inventory items, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one inventory item by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Inventory item ID. (required)

Returns:
  An object of the form:

    { # Represents a buy from the DoubleClick Planning inventory store.
    "orderId": "A String", # Order ID of this inventory item.
    "pricing": { # Pricing Information # Pricing of this inventory item.
      "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
      "startDate": "A String", # Start date of this inventory item.
      "endDate": "A String", # End date of this inventory item.
      "pricingType": "A String", # Pricing type of this inventory item.
      "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
        { # Flight
          "rateOrCost": "A String", # Rate or cost of this flight.
          "startDate": "A String", # Inventory item flight start date.
          "units": "A String", # Units of this flight.
          "endDate": "A String", # Inventory item flight end date.
        },
      ],
      "capCostType": "A String", # Cap cost type of this inventory item.
    },
    "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
    "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
    "subaccountId": "A String", # Subaccount ID of this inventory item.
    "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
    "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
    "inPlan": True or False, # Whether this inventory item is in plan.
    "id": "A String", # ID of this inventory item.
    "advertiserId": "A String", # Advertiser ID of this inventory item.
    "siteId": "A String", # ID of the site this inventory item is associated with.
    "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
      { # Ad Slot
        "comment": "A String", # Comment for this ad slot.
        "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
        "name": "A String", # Name of this ad slot.
        "primary": True or False, # Primary ad slot of a roadblock inventory item.
        "height": "A String", # Height of this ad slot.
        "width": "A String", # Width of this ad slot.
        "paymentSourceType": "A String", # Payment source type of this ad slot.
        "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
      },
    ],
    "projectId": "A String", # Project ID of this inventory item.
    "rfpId": "A String", # RFP ID of this inventory item.
    "type": "A String", # Type of inventory item.
    "contentCategoryId": "A String", # Content category ID of this inventory item.
    "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
    "accountId": "A String", # Account ID of this inventory item.
  }
list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None) 
Retrieves a list of inventory items, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  inPlan: boolean, Select only inventory items that are in plan.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  type: string, Select only inventory items with this type.
    Allowed values
      PLANNING_PLACEMENT_TYPE_CREDIT - 
      PLANNING_PLACEMENT_TYPE_REGULAR - 
  orderId: string, Select only inventory items that belong to specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only inventory items that are associated with these sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only inventory items with these IDs. (repeated)

Returns:
  An object of the form:

    { # Inventory item List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#inventoryItemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
    "inventoryItems": [ # Inventory item collection
      { # Represents a buy from the DoubleClick Planning inventory store.
        "orderId": "A String", # Order ID of this inventory item.
        "pricing": { # Pricing Information # Pricing of this inventory item.
          "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
          "startDate": "A String", # Start date of this inventory item.
          "endDate": "A String", # End date of this inventory item.
          "pricingType": "A String", # Pricing type of this inventory item.
          "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
            { # Flight
              "rateOrCost": "A String", # Rate or cost of this flight.
              "startDate": "A String", # Inventory item flight start date.
              "units": "A String", # Units of this flight.
              "endDate": "A String", # Inventory item flight end date.
            },
          ],
          "capCostType": "A String", # Cap cost type of this inventory item.
        },
        "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
        "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
        "subaccountId": "A String", # Subaccount ID of this inventory item.
        "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
        "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
        "inPlan": True or False, # Whether this inventory item is in plan.
        "id": "A String", # ID of this inventory item.
        "advertiserId": "A String", # Advertiser ID of this inventory item.
        "siteId": "A String", # ID of the site this inventory item is associated with.
        "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
          { # Ad Slot
            "comment": "A String", # Comment for this ad slot.
            "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
            "name": "A String", # Name of this ad slot.
            "primary": True or False, # Primary ad slot of a roadblock inventory item.
            "height": "A String", # Height of this ad slot.
            "width": "A String", # Width of this ad slot.
            "paymentSourceType": "A String", # Payment source type of this ad slot.
            "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
          },
        ],
        "projectId": "A String", # Project ID of this inventory item.
        "rfpId": "A String", # RFP ID of this inventory item.
        "type": "A String", # Type of inventory item.
        "contentCategoryId": "A String", # Content category ID of this inventory item.
        "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
        "accountId": "A String", # Account ID of this inventory item.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.landingPages.html000066400000000000000000000262211300622755700266750ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . landingPages

Instance Methods

delete(profileId, campaignId, id)

Deletes an existing campaign landing page.

get(profileId, campaignId, id)

Gets one campaign landing page by ID.

insert(profileId, campaignId, body)

Inserts a new landing page for the specified campaign.

list(profileId, campaignId)

Retrieves the list of landing pages for the specified campaign.

patch(profileId, campaignId, id, body)

Updates an existing campaign landing page. This method supports patch semantics.

update(profileId, campaignId, body)

Updates an existing campaign landing page.

Method Details

delete(profileId, campaignId, id) 
Deletes an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
get(profileId, campaignId, id) 
Gets one campaign landing page by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)

Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
insert(profileId, campaignId, body) 
Inserts a new landing page for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
list(profileId, campaignId) 
Retrieves the list of landing pages for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)

Returns:
  An object of the form:

    { # Landing Page List Response
    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
    "landingPages": [ # Landing page collection
      { # Contains information about where a user's browser is taken after the user clicks an ad.
          "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
          "url": "A String", # URL of this landing page. This is a required field.
          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
        },
    ],
  }
patch(profileId, campaignId, id, body) 
Updates an existing campaign landing page. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
update(profileId, campaignId, body) 
Updates an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.languages.html000066400000000000000000000045321300622755700262500ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . languages

Instance Methods

list(profileId)

Retrieves a list of languages.

Method Details

list(profileId) 
Retrieves a list of languages.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Language List Response
    "languages": [ # Language collection.
      { # Contains information about a language that can be targeted by ads.
        "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
        "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
        "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
        "name": "A String", # Name of this language.
      },
    ],
    "kind": "dfareporting#languagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.metros.html000066400000000000000000000047421300622755700256160ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . metros

Instance Methods

list(profileId)

Retrieves a list of metros.

Method Details

list(profileId) 
Retrieves a list of metros.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Metro List Response
    "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
    "metros": [ # Metro collection.
      { # Contains information about a metro region that can be targeted by ads.
        "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
        "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
        "name": "A String", # Name of this metro region.
        "countryCode": "A String", # Country code of the country to which this metro region belongs.
        "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
        "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
        "dartId": "A String", # DART ID of this metro region.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.mobileCarriers.html000066400000000000000000000064101300622755700272410ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . mobileCarriers

Instance Methods

get(profileId, id)

Gets one mobile carrier by ID.

list(profileId)

Retrieves a list of mobile carriers.

Method Details

get(profileId, id) 
Gets one mobile carrier by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Mobile carrier ID. (required)

Returns:
  An object of the form:

    { # Contains information about a mobile carrier that can be targeted by ads.
    "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
    "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
    "id": "A String", # ID of this mobile carrier.
    "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
    "name": "A String", # Name of this mobile carrier.
  }
list(profileId) 
Retrieves a list of mobile carriers.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Mobile Carrier List Response
    "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
    "mobileCarriers": [ # Mobile carrier collection.
      { # Contains information about a mobile carrier that can be targeted by ads.
        "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
        "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
        "id": "A String", # ID of this mobile carrier.
        "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
        "name": "A String", # Name of this mobile carrier.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.operatingSystemVersions.html000066400000000000000000000114331300622755700312260ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystemVersions

Instance Methods

get(profileId, id)

Gets one operating system version by ID.

list(profileId)

Retrieves a list of operating system versions.

Method Details

get(profileId, id) 
Gets one operating system version by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Operating system version ID. (required)

Returns:
  An object of the form:

    { # Contains information about a particular version of an operating system that can be targeted by ads.
    "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
    "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
    "name": "A String", # Name of this operating system version.
    "id": "A String", # ID of this operating system version.
    "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
      "mobile": True or False, # Whether this operating system is for mobile.
      "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
      "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
      "name": "A String", # Name of this operating system.
      "desktop": True or False, # Whether this operating system is for desktop.
    },
    "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
  }
list(profileId) 
Retrieves a list of operating system versions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System Version List Response
    "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
    "operatingSystemVersions": [ # Operating system version collection.
      { # Contains information about a particular version of an operating system that can be targeted by ads.
        "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
        "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
        "name": "A String", # Name of this operating system version.
        "id": "A String", # ID of this operating system version.
        "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
        "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.operatingSystems.html000066400000000000000000000065271300622755700276700ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . operatingSystems

Instance Methods

get(profileId, dartId)

Gets one operating system by DART ID.

list(profileId)

Retrieves a list of operating systems.

Method Details

get(profileId, dartId) 
Gets one operating system by DART ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  dartId: string, Operating system DART ID. (required)

Returns:
  An object of the form:

    { # Contains information about an operating system that can be targeted by ads.
    "mobile": True or False, # Whether this operating system is for mobile.
    "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
    "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
    "name": "A String", # Name of this operating system.
    "desktop": True or False, # Whether this operating system is for desktop.
  }
list(profileId) 
Retrieves a list of operating systems.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Operating System List Response
    "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
    "operatingSystems": [ # Operating system collection.
      { # Contains information about an operating system that can be targeted by ads.
        "mobile": True or False, # Whether this operating system is for mobile.
        "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
        "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
        "name": "A String", # Name of this operating system.
        "desktop": True or False, # Whether this operating system is for desktop.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.orderDocuments.html000066400000000000000000000200461300622755700272750ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orderDocuments

Instance Methods

get(profileId, projectId, id)

Gets one order document by ID.

list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)

Retrieves a list of order documents, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order document by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  id: string, Order document ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning order document.
    "orderId": "A String", # ID of the order from which this order document is created.
    "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
      "A String",
    ],
    "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
    "subaccountId": "A String", # Subaccount ID of this order document.
    "effectiveDate": "A String", # Effective date of this order document.
    "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
    "lastSentRecipients": [ # List of email addresses that received the last sent document.
      "A String",
    ],
    "title": "A String", # Title of this order document.
    "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
    "signed": True or False, # Whether this order document has been signed.
    "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "advertiserId": "A String", # Advertiser ID of this order document.
    "projectId": "A String", # Project ID of this order document.
    "cancelled": True or False, # Whether this order document is cancelled.
    "type": "A String", # Type of this order document
    "id": "A String", # ID of this order document.
    "accountId": "A String", # Account ID of this order document.
  }
list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None) 
Retrieves a list of order documents, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for order documents. (required)
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  orderId: string, Select only order documents for specified orders. (repeated)
  maxResults: integer, Maximum number of results to return.
  siteId: string, Select only order documents that are associated with these sites. (repeated)
  approved: boolean, Select only order documents that have been approved by at least one user.
  searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only order documents with these IDs. (repeated)

Returns:
  An object of the form:

    { # Order document List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#orderDocumentsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
    "orderDocuments": [ # Order document collection
      { # Contains properties of a DoubleClick Planning order document.
        "orderId": "A String", # ID of the order from which this order document is created.
        "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
          "A String",
        ],
        "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
        "subaccountId": "A String", # Subaccount ID of this order document.
        "effectiveDate": "A String", # Effective date of this order document.
        "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
        "lastSentRecipients": [ # List of email addresses that received the last sent document.
          "A String",
        ],
        "title": "A String", # Title of this order document.
        "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
        "signed": True or False, # Whether this order document has been signed.
        "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "advertiserId": "A String", # Advertiser ID of this order document.
        "projectId": "A String", # Project ID of this order document.
        "cancelled": True or False, # Whether this order document is cancelled.
        "type": "A String", # Type of this order document
        "id": "A String", # ID of this order document.
        "accountId": "A String", # Account ID of this order document.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.orders.html000066400000000000000000000213671300622755700256050ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . orders

Instance Methods

get(profileId, projectId, id)

Gets one order by ID.

list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)

Retrieves a list of orders, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, projectId, id) 
Gets one order by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  id: string, Order ID. (required)

Returns:
  An object of the form:

    { # Describes properties of a DoubleClick Planning order.
    "termsAndConditions": "A String", # Terms and conditions of this order.
    "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
    "sellerOrganizationName": "A String", # Name of the seller organization.
    "subaccountId": "A String", # Subaccount ID of this order.
    "name": "A String", # Name of this order.
    "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "notes": "A String", # Notes of this order.
    "contacts": [ # Contacts for this order.
      { # Contact of an order.
        "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
        "contactTitle": "A String", # Title of this contact.
        "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
        "contactName": "A String", # Name of this contact.
        "contactType": "A String", # Type of this contact.
      },
    ],
    "buyerOrganizationName": "A String", # Name of the buyer organization.
    "comments": "A String", # Comments in this order.
    "advertiserId": "A String", # Advertiser ID of this order.
    "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
      "A String",
    ],
    "siteId": [ # Site IDs this order is associated with.
      "A String",
    ],
    "sellerOrderId": "A String", # Seller order ID associated with this order.
    "projectId": "A String", # Project ID of this order.
    "siteNames": [ # Free-form site names this order is associated with.
      "A String",
    ],
    "planningTermId": "A String", # ID of the terms and conditions template used in this order.
    "id": "A String", # ID of this order. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this order.
  }
list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None) 
Retrieves a list of orders, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only orders with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  siteId: string, Select only orders that are associated with these site IDs. (repeated)

Returns:
  An object of the form:

    { # Order List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
    "orders": [ # Order collection.
      { # Describes properties of a DoubleClick Planning order.
        "termsAndConditions": "A String", # Terms and conditions of this order.
        "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
        "sellerOrganizationName": "A String", # Name of the seller organization.
        "subaccountId": "A String", # Subaccount ID of this order.
        "name": "A String", # Name of this order.
        "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "notes": "A String", # Notes of this order.
        "contacts": [ # Contacts for this order.
          { # Contact of an order.
            "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
            "contactTitle": "A String", # Title of this contact.
            "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
            "contactName": "A String", # Name of this contact.
            "contactType": "A String", # Type of this contact.
          },
        ],
        "buyerOrganizationName": "A String", # Name of the buyer organization.
        "comments": "A String", # Comments in this order.
        "advertiserId": "A String", # Advertiser ID of this order.
        "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
          "A String",
        ],
        "siteId": [ # Site IDs this order is associated with.
          "A String",
        ],
        "sellerOrderId": "A String", # Seller order ID associated with this order.
        "projectId": "A String", # Project ID of this order.
        "siteNames": [ # Free-form site names this order is associated with.
          "A String",
        ],
        "planningTermId": "A String", # ID of the terms and conditions template used in this order.
        "id": "A String", # ID of this order. This is a read-only, auto-generated field.
        "accountId": "A String", # Account ID of this order.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.placementGroups.html000066400000000000000000003050101300622755700274450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementGroups

Instance Methods

get(profileId, id)

Gets one placement group by ID.

insert(profileId, body)

Inserts a new placement group.

list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)

Retrieves a list of placement groups, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement group. This method supports patch semantics.

update(profileId, body)

Updates an existing placement group.

Method Details

get(profileId, id) 
Gets one placement group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None) 
Retrieves a list of placement groups, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placement groups that are associated with these sites. (repeated)
  placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
    Allowed values
      PLACEMENT_PACKAGE - 
      PLACEMENT_ROADBLOCK - 
  pricingTypes: string, Select only placement groups with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
  ids: string, Select only placement groups with these IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # Placement Group List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
    "placementGroups": [ # Placement group collection.
      { # Contains properties of a package or roadblock.
          "comment": "A String", # Comments for this placement group.
          "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
          "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
          "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
          "archived": True or False, # Whether this placement group is archived.
          "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
            "A String",
          ],
          "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
          "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
          "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
          "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a package or roadblock.
    "comment": "A String", # Comments for this placement group.
    "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
    "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
    "archived": True or False, # Whether this placement group is archived.
    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
      "A String",
    ],
    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
      "comment": "A String", # Comments for this placement group.
      "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
      "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
      "archived": True or False, # Whether this placement group is archived.
      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        "A String",
      ],
      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.placementStrategies.html000066400000000000000000000257571300622755700303210ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placementStrategies

Instance Methods

delete(profileId, id)

Deletes an existing placement strategy.

get(profileId, id)

Gets one placement strategy by ID.

insert(profileId, body)

Inserts a new placement strategy.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of placement strategies, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement strategy. This method supports patch semantics.

update(profileId, body)

Updates an existing placement strategy.

Method Details

delete(profileId, id) 
Deletes an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
get(profileId, id) 
Gets one placement strategy by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of placement strategies, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placement strategies with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Placement Strategy List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
    "placementStrategies": [ # Placement strategy collection.
      { # Contains properties of a placement strategy.
          "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
          "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
          "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
          "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing placement strategy. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.placements.html000066400000000000000000004054451300622755700264450ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . placements

Instance Methods

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)

Generates tags for a placement.

get(profileId, id)

Gets one placement by ID.

insert(profileId, body)

Inserts a new placement.

list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)

Retrieves a list of placements, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing placement. This method supports patch semantics.

update(profileId, body)

Updates an existing placement.

Method Details

generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None) 
Generates tags for a placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Generate placements belonging to this campaign. This is a required field.
  tagFormats: string, Tag formats to generate for these placements. (repeated)
    Allowed values
      PLACEMENT_TAG_CLICK_COMMANDS - 
      PLACEMENT_TAG_IFRAME_ILAYER - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH - 
      PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 - 
      PLACEMENT_TAG_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT - 
      PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_JAVASCRIPT - 
      PLACEMENT_TAG_JAVASCRIPT_LEGACY - 
      PLACEMENT_TAG_STANDARD - 
      PLACEMENT_TAG_TRACKING - 
      PLACEMENT_TAG_TRACKING_IFRAME - 
      PLACEMENT_TAG_TRACKING_JAVASCRIPT - 
  placementIds: string, Generate tags for these placements. (repeated)

Returns:
  An object of the form:

    { # Placement GenerateTags Response
    "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
    "placementTags": [ # Set of generated tags for the specified placements.
      { # Placement Tag
        "tagDatas": [ # Tags generated for this placement.
          { # Placement Tag Data
            "clickTag": "A String", # Tag string to record a click.
            "impressionTag": "A String", # Tag string for serving an ad.
            "creativeId": "A String", # Creative associated with this placement tag.
            "adId": "A String", # Ad associated with this placement tag.
            "format": "A String", # TagData tag format of this tag.
          },
        ],
        "placementId": "A String", # Placement ID
      },
    ],
  }
get(profileId, id) 
Gets one placement by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
insert(profileId, body) 
Inserts a new placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None) 
Retrieves a list of placements, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  siteIds: string, Select only placements that are associated with these sites. (repeated)
  paymentSource: string, Select only placements with this payment source.
    Allowed values
      PLACEMENT_AGENCY_PAID - 
      PLACEMENT_PUBLISHER_PAID - 
  pricingTypes: string, Select only placements with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPA - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
  campaignIds: string, Select only placements that belong to these campaigns. (repeated)
  advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
  sizeIds: string, Select only placements that are associated with these sizes. (repeated)
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
  placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
  contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
  maxResults: integer, Maximum number of results to return.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
  compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
    Allowed values
      APP - 
      APP_INTERSTITIAL - 
      DISPLAY - 
      DISPLAY_INTERSTITIAL - 
      IN_STREAM_VIDEO - 
  searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
  directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placements with these IDs. (repeated)
  groupIds: string, Select only placements that belong to these placement groups. (repeated)

Returns:
  An object of the form:

    { # Placement List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
    "placements": [ # Placement collection.
      { # Contains properties of a placement.
          "comment": "A String", # Comments for this placement.
          "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
          "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
          "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this placement. This field can be left blank.
          "archived": True or False, # Whether this placement is archived.
          "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
              # Acceptable values are:
              # - "PLACEMENT_TAG_STANDARD"
              # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_IFRAME_ILAYER"
              # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
              # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
              # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
              # - "PLACEMENT_TAG_CLICK_COMMANDS"
              # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
              # - "PLACEMENT_TAG_TRACKING"
              # - "PLACEMENT_TAG_TRACKING_IFRAME"
              # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
            "A String",
          ],
          "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
          "tagSetting": { # Tag Settings # Tag settings for this placement.
            "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
            "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
            "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
            "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
          },
          "contentCategoryId": "A String", # ID of the content category assigned to this placement.
          "externalId": "A String", # External ID for this placement.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
            "width": 42, # Width of this size.
            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
            "height": 42, # Height of this size.
          },
          "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
          "status": "A String", # Third-party placement status.
          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
          "placementGroupId": "A String", # ID of this placement's group, if applicable.
          "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
          "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
          "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
          "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
            "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          },
          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
          },
          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
            "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
            "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
            "capCostOption": "A String", # Placement cap cost option.
            "pricingPeriods": [ # Pricing periods for this placement.
              { # Pricing Period
                "units": "A String", # Units of this pricing period.
                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
                "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
                "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
                "pricingComment": "A String", # Comments for this pricing period.
              },
            ],
            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
            "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
          },
        },
    ],
  }
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, id, body) 
Updates an existing placement. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
update(profileId, body) 
Updates an existing placement.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a placement.
    "comment": "A String", # Comments for this placement.
    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this placement. This field can be left blank.
    "archived": True or False, # Whether this placement is archived.
    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
        # Acceptable values are:
        # - "PLACEMENT_TAG_STANDARD"
        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_IFRAME_ILAYER"
        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
        # - "PLACEMENT_TAG_CLICK_COMMANDS"
        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
        # - "PLACEMENT_TAG_TRACKING"
        # - "PLACEMENT_TAG_TRACKING_IFRAME"
        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
      "A String",
    ],
    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
    "tagSetting": { # Tag Settings # Tag settings for this placement.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
      "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
    },
    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
    "externalId": "A String", # External ID for this placement.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
      "width": 42, # Width of this size.
      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
      "height": 42, # Height of this size.
    },
    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
    "status": "A String", # Third-party placement status.
    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
    "placementGroupId": "A String", # ID of this placement's group, if applicable.
    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
      "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
    },
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
      "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
      "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
      "capCostOption": "A String", # Placement cap cost option.
      "pricingPeriods": [ # Pricing periods for this placement.
        { # Pricing Period
          "units": "A String", # Units of this pricing period.
          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
          "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
          "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
          "pricingComment": "A String", # Comments for this pricing period.
        },
      ],
      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
      "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    },
  }


Returns:
  An object of the form:

    { # Contains properties of a placement.
      "comment": "A String", # Comments for this placement.
      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this placement. This field can be left blank.
      "archived": True or False, # Whether this placement is archived.
      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
          # Acceptable values are:
          # - "PLACEMENT_TAG_STANDARD"
          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_IFRAME_ILAYER"
          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
          # - "PLACEMENT_TAG_CLICK_COMMANDS"
          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
          # - "PLACEMENT_TAG_TRACKING"
          # - "PLACEMENT_TAG_TRACKING_IFRAME"
          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
        "A String",
      ],
      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
      "tagSetting": { # Tag Settings # Tag settings for this placement.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
      "externalId": "A String", # External ID for this placement.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
      "status": "A String", # Third-party placement status.
      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
      "placementGroupId": "A String", # ID of this placement's group, if applicable.
      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
      },
      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
        "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
        "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
        "capCostOption": "A String", # Placement cap cost option.
        "pricingPeriods": [ # Pricing periods for this placement.
          { # Pricing Period
            "units": "A String", # Units of this pricing period.
            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
            "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
            "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
            "pricingComment": "A String", # Comments for this pricing period.
          },
        ],
        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
        "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
      },
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.platformTypes.html000066400000000000000000000055441300622755700271570ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . platformTypes

Instance Methods

get(profileId, id)

Gets one platform type by ID.

list(profileId)

Retrieves a list of platform types.

Method Details

get(profileId, id) 
Gets one platform type by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Platform type ID. (required)

Returns:
  An object of the form:

    { # Contains information about a platform type that can be targeted by ads.
    "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
    "id": "A String", # ID of this platform type.
    "name": "A String", # Name of this platform type.
  }
list(profileId) 
Retrieves a list of platform types.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Platform Type List Response
    "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
    "platformTypes": [ # Platform type collection.
      { # Contains information about a platform type that can be targeted by ads.
        "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
        "id": "A String", # ID of this platform type.
        "name": "A String", # Name of this platform type.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.postalCodes.html000066400000000000000000000063561300622755700265700ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . postalCodes

Instance Methods

get(profileId, code)

Gets one postal code by ID.

list(profileId)

Retrieves a list of postal codes.

Method Details

get(profileId, code) 
Gets one postal code by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  code: string, Postal code ID. (required)

Returns:
  An object of the form:

    { # Contains information about a postal code that can be targeted by ads.
    "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
    "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
    "code": "A String", # Postal code. This is equivalent to the id field.
    "id": "A String", # ID of this postal code.
    "countryCode": "A String", # Country code of the country to which this postal code belongs.
  }
list(profileId) 
Retrieves a list of postal codes.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Postal Code List Response
    "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
    "postalCodes": [ # Postal code collection.
      { # Contains information about a postal code that can be targeted by ads.
        "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
        "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
        "code": "A String", # Postal code. This is equivalent to the id field.
        "id": "A String", # ID of this postal code.
        "countryCode": "A String", # Country code of the country to which this postal code belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.projects.html000066400000000000000000000202421300622755700261270ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . projects

Instance Methods

get(profileId, id)

Gets one project by ID.

list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of projects, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one project by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Project ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DoubleClick Planning project.
    "startDate": "A String", # Start date of the project.
    "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
    "endDate": "A String", # End date of the project.
    "clientBillingCode": "A String", # Client billing code of this project.
    "overview": "A String", # Overview of this project.
    "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
    "advertiserId": "A String", # Advertiser ID of this project.
    "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
    "id": "A String", # ID of this project. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this project.
    "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
    "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
    "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
    "audienceGender": "A String", # Audience gender of this project.
    "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
    "subaccountId": "A String", # Subaccount ID of this project.
    "name": "A String", # Name of this project.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
    "audienceAgeGroup": "A String", # Audience age group of this project.
    "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
    "clientName": "A String", # Name of the project client.
  }
list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of projects, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
  ids: string, Select only projects with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Project List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
    "projects": [ # Project collection.
      { # Contains properties of a DoubleClick Planning project.
        "startDate": "A String", # Start date of the project.
        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
        "endDate": "A String", # End date of the project.
        "clientBillingCode": "A String", # Client billing code of this project.
        "overview": "A String", # Overview of this project.
        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
        "advertiserId": "A String", # Advertiser ID of this project.
        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
        "accountId": "A String", # Account ID of this project.
        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
        "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
        "audienceGender": "A String", # Audience gender of this project.
        "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
        "subaccountId": "A String", # Subaccount ID of this project.
        "name": "A String", # Name of this project.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
        "audienceAgeGroup": "A String", # Audience age group of this project.
        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
        "clientName": "A String", # Name of the project client.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.regions.html000066400000000000000000000044071300622755700257510ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . regions

Instance Methods

list(profileId)

Retrieves a list of regions.

Method Details

list(profileId) 
Retrieves a list of regions.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # Region List Response
    "regions": [ # Region collection.
      { # Contains information about a region that can be targeted by ads.
        "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
        "countryDartId": "A String", # DART ID of the country to which this region belongs.
        "name": "A String", # Name of this region.
        "countryCode": "A String", # Country code of the country to which this region belongs.
        "regionCode": "A String", # Region code.
        "dartId": "A String", # DART ID of this region.
      },
    ],
    "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.remarketingListShares.html000066400000000000000000000146621300622755700306210ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingListShares

Instance Methods

get(profileId, remarketingListId)

Gets one remarketing list share by remarketing list ID.

patch(profileId, remarketingListId, body)

Updates an existing remarketing list share. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list share.

Method Details

get(profileId, remarketingListId) 
Gets one remarketing list share by remarketing list ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
patch(profileId, remarketingListId, body) 
Updates an existing remarketing list share. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  remarketingListId: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
update(profileId, body) 
Updates an existing remarketing list share.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
      "A String",
    ],
    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
        "A String",
      ],
      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.remarketingLists.html000066400000000000000000001407631300622755700276400ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . remarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

insert(profileId, body)

Inserts a new remarketing list.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing remarketing list. This method supports patch semantics.

update(profileId, body)

Updates an existing remarketing list.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
insert(profileId, body) 
Inserts a new remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "remarketingLists": [ # Remarketing list collection.
      { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
          "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
            "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
            "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
            "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
              { # A group clause made up of list population terms representing constraints joined by ORs.
                "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
                  { # Remarketing List Population Rule Term.
                    "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                    "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                    "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                    "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                    "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                    "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                  },
                ],
              },
            ],
          },
          "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
          "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
          "description": "A String", # Remarketing list description.
          "listSize": "A String", # Number of users currently in the list. This is a read-only field.
          "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
          "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
          "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
          "listSource": "A String", # Product from which this remarketing list was originated.
          "active": True or False, # Whether this remarketing list is active.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        },
    ],
    "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
  }
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, id, body) 
Updates an existing remarketing list. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
update(profileId, body) 
Updates an existing remarketing list.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
      "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
        { # A group clause made up of list population terms representing constraints joined by ORs.
          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
            { # Remarketing List Population Rule Term.
              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
              "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
              "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
              "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
            },
          ],
        },
      ],
    },
    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
    "listSource": "A String", # Product from which this remarketing list was originated.
    "active": True or False, # Whether this remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }


Returns:
  An object of the form:

    { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
        "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
          { # A group clause made up of list population terms representing constraints joined by ORs.
            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
              { # Remarketing List Population Rule Term.
                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
                "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
                "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
                "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
                "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
              },
            ],
          },
        ],
      },
      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      "description": "A String", # Remarketing list description.
      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
      "listSource": "A String", # Product from which this remarketing list was originated.
      "active": True or False, # Whether this remarketing list is active.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.reports.compatibleFields.html000066400000000000000000001142221300622755700312430ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . compatibleFields

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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.reports.files.html000066400000000000000000000176051300622755700271060ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports . files

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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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 metadata 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.
        "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.
        },
        "fileName": "A String", # The filename 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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.reports.html000066400000000000000000007120561300622755700260070ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . reports

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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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.
              },
            ],
            "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.
            },
            "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.
              },
            ],
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
          },
          "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
          "subAccountId": "A String", # The subaccount 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.
                # 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. Note:
                # - "DAILY" also requires field "every" to be set.
                # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
                # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
            "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
              "A String",
            ],
          },
          "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
                },
              ],
            },
            "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
          },
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          },
          "fileName": "A String", # The filename used when generating report files for this report.
          "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.
            "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.
                "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          "type": "A String", # The type of the report.
          "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.
              },
            ],
            "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.
            },
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "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 metadata 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.
    "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.
    },
    "fileName": "A String", # The filename 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.
        },
      ],
      "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.
      },
      "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.
        },
      ],
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
    },
    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
    "subAccountId": "A String", # The subaccount 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.
          # 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. Note:
          # - "DAILY" also requires field "every" to be set.
          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
        "A String",
      ],
    },
    "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
    },
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
    },
    "fileName": "A String", # The filename used when generating report files for this report.
    "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.
      "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.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    "type": "A String", # The type of the report.
    "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.
        },
      ],
      "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.
      },
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "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.
          },
        ],
        "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.
        },
        "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.
          },
        ],
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
      },
      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
      "subAccountId": "A String", # The subaccount 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.
            # 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. Note:
            # - "DAILY" also requires field "every" to be set.
            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
          "A String",
        ],
      },
      "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
            },
          ],
        },
        "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
      },
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
        },
      },
      "fileName": "A String", # The filename used when generating report files for this report.
      "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.
        "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.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      "type": "A String", # The type of the report.
      "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.
          },
        ],
        "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.
        },
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "accountId": "A String", # The account ID to which this report belongs.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.sites.html000066400000000000000000001641231300622755700254340ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sites

Instance Methods

get(profileId, id)

Gets one site by ID.

insert(profileId, body)

Inserts a new site.

list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)

Retrieves a list of sites, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing site. This method supports patch semantics.

update(profileId, body)

Updates an existing site.

Method Details

get(profileId, id) 
Gets one site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None) 
Retrieves a list of sites, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
  campaignIds: string, Select only sites with these campaign IDs. (repeated)
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  pageToken: string, Value of the nextPageToken from the previous result page.
  acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  maxResults: integer, Maximum number of results to return.
  adWordsSite: boolean, Select only AdWords sites.
  approved: boolean, Select only approved sites.
  searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
  subaccountId: string, Select only sites with this subaccount ID.
  directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only sites with these IDs. (repeated)

Returns:
  An object of the form:

    { # Site List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
    "sites": [ # Site collection.
      { # Contains properties of a site.
          "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
          "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
          "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteSettings": { # Site Settings # Site-wide settings.
            "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
            "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
            "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
              "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
              "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
            },
            "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
            "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
              "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
              "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
              "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
              "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
            },
            "creativeSettings": { # Creative Settings # Site-wide creative settings.
              "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
              "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
            },
            "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
          },
          "approved": True or False, # Whether this site is approved.
          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
          },
          "siteContacts": [ # Site contacts.
            { # Site Contact
              "firstName": "A String", # First name of this site contact.
              "title": "A String", # Title or designation of this site contact.
              "lastName": "A String", # Last name of this site contact.
              "address": "A String", # Address of this site contact.
              "email": "A String", # Email address of this site contact. This is a required field.
              "phone": "A String", # Primary phone number of this site contact.
              "contactType": "A String", # Site contact type.
              "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
            },
          ],
          "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
          "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
          "id": "A String", # ID of this site. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing site. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a site.
    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
    "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteSettings": { # Site Settings # Site-wide settings.
      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
        "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
      },
      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
        "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
        "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
      },
      "creativeSettings": { # Creative Settings # Site-wide creative settings.
        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
      },
      "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
    },
    "approved": True or False, # Whether this site is approved.
    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
    },
    "siteContacts": [ # Site contacts.
      { # Site Contact
        "firstName": "A String", # First name of this site contact.
        "title": "A String", # Title or designation of this site contact.
        "lastName": "A String", # Last name of this site contact.
        "address": "A String", # Address of this site contact.
        "email": "A String", # Email address of this site contact. This is a required field.
        "phone": "A String", # Primary phone number of this site contact.
        "contactType": "A String", # Site contact type.
        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      },
    ],
    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a site.
      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteSettings": { # Site Settings # Site-wide settings.
        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
          "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
          "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
        },
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
          "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
        },
        "creativeSettings": { # Creative Settings # Site-wide creative settings.
          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
        },
        "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
      },
      "approved": True or False, # Whether this site is approved.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
      },
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "firstName": "A String", # First name of this site contact.
          "title": "A String", # Title or designation of this site contact.
          "lastName": "A String", # Last name of this site contact.
          "address": "A String", # Address of this site contact.
          "email": "A String", # Email address of this site contact. This is a required field.
          "phone": "A String", # Primary phone number of this site contact.
          "contactType": "A String", # Site contact type.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
        },
      ],
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.sizes.html000066400000000000000000000113601300622755700254340ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . sizes

Instance Methods

get(profileId, id)

Gets one size by ID.

insert(profileId, body)

Inserts a new size.

list(profileId, iabStandard=None, width=None, ids=None, height=None)

Retrieves a list of sizes, possibly filtered.

Method Details

get(profileId, id) 
Gets one size by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Size ID. (required)

Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
insert(profileId, body) 
Inserts a new size.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents the dimensions of ads, placements, creatives, or creative assets.
  "width": 42, # Width of this size.
  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
  "height": 42, # Height of this size.
}


Returns:
  An object of the form:

    { # Represents the dimensions of ads, placements, creatives, or creative assets.
    "width": 42, # Width of this size.
    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
    "height": 42, # Height of this size.
  }
list(profileId, iabStandard=None, width=None, ids=None, height=None) 
Retrieves a list of sizes, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  iabStandard: boolean, Select only IAB standard sizes.
  width: integer, Select only sizes with this width.
  ids: string, Select only sizes with these IDs. (repeated)
  height: integer, Select only sizes with this height.

Returns:
  An object of the form:

    { # Size List Response
    "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
    "sizes": [ # Size collection.
      { # Represents the dimensions of ads, placements, creatives, or creative assets.
        "width": 42, # Width of this size.
        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
        "height": 42, # Height of this size.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.subaccounts.html000066400000000000000000000261311300622755700266320ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . subaccounts

Instance Methods

get(profileId, id)

Gets one subaccount by ID.

insert(profileId, body)

Inserts a new subaccount.

list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Gets a list of subaccounts, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing subaccount. This method supports patch semantics.

update(profileId, body)

Updates an existing subaccount.

Method Details

get(profileId, id) 
Gets one subaccount by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Gets a list of subaccounts, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only subaccounts with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Subaccount List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
    "subaccounts": [ # Subaccount collection.
      { # Contains properties of a DCM subaccount.
          "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
          "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
            "A String",
          ],
          "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
          "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
          "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing subaccount. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing subaccount.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a DCM subaccount.
    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
      "A String",
    ],
    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
    "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a DCM subaccount.
      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.targetableRemarketingLists.html000066400000000000000000000232141300622755700316220ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . targetableRemarketingLists

Instance Methods

get(profileId, id)

Gets one remarketing list by ID.

list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)

Retrieves a list of targetable remarketing lists, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(profileId, id) 
Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
    "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
    "description": "A String", # Targetable remarketing list description.
    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
    "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
    "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
    "listSource": "A String", # Product from which this targetable remarketing list was originated.
    "active": True or False, # Whether this targetable remarketing list is active.
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  }
list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None) 
Retrieves a list of targetable remarketing lists, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
  name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  maxResults: integer, Maximum number of results to return.
  active: boolean, Select only active or only inactive targetable remarketing lists.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Targetable remarketing list response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
    "targetableRemarketingLists": [ # Targetable remarketing list collection.
      { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
        "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
        "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
        "description": "A String", # Targetable remarketing list description.
        "listSize": "A String", # Number of users currently in the list. This is a read-only field.
        "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
        "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
        "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
        "listSource": "A String", # Product from which this targetable remarketing list was originated.
        "active": True or False, # Whether this targetable remarketing list is active.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
          "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
        "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.targetingTemplates.html000066400000000000000000004171311300622755700301500ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . targetingTemplates

Instance Methods

get(profileId, id)

Gets one targeting template by ID.

insert(profileId, body)

Inserts a new targeting template.

list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

Retrieves a list of targeting templates, optionally filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing targeting template. This method supports patch semantics.

update(profileId, body)

Updates an existing targeting template.

Method Details

get(profileId, id) 
Gets one targeting template by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Targeting template ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
      "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
      "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
      "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "languageTargeting": { # Language Targeting. # Language targeting criteria.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    }
insert(profileId, body) 
Inserts a new targeting template.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
    "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
    "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "languageTargeting": { # Language Targeting. # Language targeting criteria.
      "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a language that can be targeted by ads.
          "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
          "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
          "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
          "name": "A String", # Name of this language.
        },
      ],
    },
    "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
      "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
      "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
      "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "languageTargeting": { # Language Targeting. # Language targeting criteria.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    }
list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) 
Retrieves a list of targeting templates, optionally filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserId: string, Select only targeting templates with this advertiser ID.
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only targeting templates with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Targeting Template List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#targetingTemplatesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse".
    "targetingTemplates": [ # Targeting template collection.
      { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
          "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
          "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
          "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
          "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
            "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
            "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
              42,
            ],
            "daysOfWeek": [ # Days of the week when the ad will serve.
                #
                # Acceptable values are:
                # - "SUNDAY"
                # - "MONDAY"
                # - "TUESDAY"
                # - "WEDNESDAY"
                # - "THURSDAY"
                # - "FRIDAY"
                # - "SATURDAY"
              "A String",
            ],
          },
          "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
            "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a platform type that can be targeted by ads.
                "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
                "id": "A String", # ID of this platform type.
                "name": "A String", # Name of this platform type.
              },
            ],
            "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
              { # Contains information about a particular version of an operating system that can be targeted by ads.
                "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
                "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
                "name": "A String", # Name of this operating system version.
                "id": "A String", # ID of this operating system version.
                "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
                  "mobile": True or False, # Whether this operating system is for mobile.
                  "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                  "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                  "name": "A String", # Name of this operating system.
                  "desktop": True or False, # Whether this operating system is for desktop.
                },
                "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
              },
            ],
            "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a browser that can be targeted by ads.
                "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
                "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
                "name": "A String", # Name of this browser.
                "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
                "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
                "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
              },
            ],
            "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
              { # Contains information about an operating system that can be targeted by ads.
                "mobile": True or False, # Whether this operating system is for mobile.
                "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
                "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
                "name": "A String", # Name of this operating system.
                "desktop": True or False, # Whether this operating system is for desktop.
              },
            ],
            "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
              { # Contains information about a mobile carrier that can be targeted by ads.
                "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
                "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
                "id": "A String", # ID of this mobile carrier.
                "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
                "name": "A String", # Name of this mobile carrier.
              },
            ],
            "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
                "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
                "id": "A String", # ID of this connection type.
                "name": "A String", # Name of this connection type.
              },
            ],
          },
          "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
            "expression": "A String", # Expression describing which lists are being targeted by the ad.
          },
          "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
            "expression": "A String", # Keyword expression being targeted by the ad.
          },
          "languageTargeting": { # Language Targeting. # Language targeting criteria.
            "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
              { # Contains information about a language that can be targeted by ads.
                "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
                "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
                "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
                "name": "A String", # Name of this language.
              },
            ],
          },
          "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
          "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
            "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
              { # Contains information about a country that can be targeted by ads.
                "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
                "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
                "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
                "countryCode": "A String", # Country code.
                "name": "A String", # Name of this country.
              },
            ],
            "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
            "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
              { # Contains information about a postal code that can be targeted by ads.
                "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
                "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
                "code": "A String", # Postal code. This is equivalent to the id field.
                "id": "A String", # ID of this postal code.
                "countryCode": "A String", # Country code of the country to which this postal code belongs.
              },
            ],
            "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
              { # Contains information about a region that can be targeted by ads.
                "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
                "countryDartId": "A String", # DART ID of the country to which this region belongs.
                "name": "A String", # Name of this region.
                "countryCode": "A String", # Country code of the country to which this region belongs.
                "regionCode": "A String", # Region code.
                "dartId": "A String", # DART ID of this region.
              },
            ],
            "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
              { # Contains information about a city that can be targeted by ads.
                "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
                "countryDartId": "A String", # DART ID of the country to which this city belongs.
                "name": "A String", # Name of this city.
                "countryCode": "A String", # Country code of the country to which this city belongs.
                "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
                "regionCode": "A String", # Region code of the region to which this city belongs.
                "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
                "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
                "regionDartId": "A String", # DART ID of the region to which this city belongs.
              },
            ],
            "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
              { # Contains information about a metro region that can be targeted by ads.
                "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
                "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
                "name": "A String", # Name of this metro region.
                "countryCode": "A String", # Country code of the country to which this metro region belongs.
                "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
                "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
                "dartId": "A String", # DART ID of this metro region.
              },
            ],
          },
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
        },
    ],
  }
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, id, body) 
Updates an existing targeting template. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Targeting template ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
    "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
    "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "languageTargeting": { # Language Targeting. # Language targeting criteria.
      "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a language that can be targeted by ads.
          "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
          "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
          "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
          "name": "A String", # Name of this language.
        },
      ],
    },
    "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
      "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
      "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
      "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "languageTargeting": { # Language Targeting. # Language targeting criteria.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    }
update(profileId, body) 
Updates an existing targeting template.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
    "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
    "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
      "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
        42,
      ],
      "daysOfWeek": [ # Days of the week when the ad will serve.
          #
          # Acceptable values are:
          # - "SUNDAY"
          # - "MONDAY"
          # - "TUESDAY"
          # - "WEDNESDAY"
          # - "THURSDAY"
          # - "FRIDAY"
          # - "SATURDAY"
        "A String",
      ],
    },
    "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
      "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a platform type that can be targeted by ads.
          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
          "id": "A String", # ID of this platform type.
          "name": "A String", # Name of this platform type.
        },
      ],
      "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
        { # Contains information about a particular version of an operating system that can be targeted by ads.
          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
          "name": "A String", # Name of this operating system version.
          "id": "A String", # ID of this operating system version.
          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
        },
      ],
      "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a browser that can be targeted by ads.
          "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
          "name": "A String", # Name of this browser.
          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
          "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
        },
      ],
      "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
        { # Contains information about an operating system that can be targeted by ads.
          "mobile": True or False, # Whether this operating system is for mobile.
          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
          "name": "A String", # Name of this operating system.
          "desktop": True or False, # Whether this operating system is for desktop.
        },
      ],
      "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
        { # Contains information about a mobile carrier that can be targeted by ads.
          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
          "id": "A String", # ID of this mobile carrier.
          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
          "name": "A String", # Name of this mobile carrier.
        },
      ],
      "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
          "id": "A String", # ID of this connection type.
          "name": "A String", # Name of this connection type.
        },
      ],
    },
    "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
      "expression": "A String", # Expression describing which lists are being targeted by the ad.
    },
    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
      "expression": "A String", # Keyword expression being targeted by the ad.
    },
    "languageTargeting": { # Language Targeting. # Language targeting criteria.
      "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
        { # Contains information about a language that can be targeted by ads.
          "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
          "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
          "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
          "name": "A String", # Name of this language.
        },
      ],
    },
    "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
    "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
      "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
        { # Contains information about a country that can be targeted by ads.
          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
          "countryCode": "A String", # Country code.
          "name": "A String", # Name of this country.
        },
      ],
      "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
      "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
        { # Contains information about a postal code that can be targeted by ads.
          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
          "code": "A String", # Postal code. This is equivalent to the id field.
          "id": "A String", # ID of this postal code.
          "countryCode": "A String", # Country code of the country to which this postal code belongs.
        },
      ],
      "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
        { # Contains information about a region that can be targeted by ads.
          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
          "countryDartId": "A String", # DART ID of the country to which this region belongs.
          "name": "A String", # Name of this region.
          "countryCode": "A String", # Country code of the country to which this region belongs.
          "regionCode": "A String", # Region code.
          "dartId": "A String", # DART ID of this region.
        },
      ],
      "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
        { # Contains information about a city that can be targeted by ads.
          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
          "countryDartId": "A String", # DART ID of the country to which this city belongs.
          "name": "A String", # Name of this city.
          "countryCode": "A String", # Country code of the country to which this city belongs.
          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
          "regionCode": "A String", # Region code of the region to which this city belongs.
          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
          "regionDartId": "A String", # DART ID of the region to which this city belongs.
        },
      ],
      "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
        { # Contains information about a metro region that can be targeted by ads.
          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
          "name": "A String", # Name of this metro region.
          "countryCode": "A String", # Country code of the country to which this metro region belongs.
          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
          "dartId": "A String", # DART ID of this metro region.
        },
      ],
    },
    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
      "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
  }


Returns:
  An object of the form:

    { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
      "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
      "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
      "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
        "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
          42,
        ],
        "daysOfWeek": [ # Days of the week when the ad will serve.
            #
            # Acceptable values are:
            # - "SUNDAY"
            # - "MONDAY"
            # - "TUESDAY"
            # - "WEDNESDAY"
            # - "THURSDAY"
            # - "FRIDAY"
            # - "SATURDAY"
          "A String",
        ],
      },
      "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
        "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a platform type that can be targeted by ads.
            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
            "id": "A String", # ID of this platform type.
            "name": "A String", # Name of this platform type.
          },
        ],
        "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
          { # Contains information about a particular version of an operating system that can be targeted by ads.
            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
            "name": "A String", # Name of this operating system version.
            "id": "A String", # ID of this operating system version.
            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
              "mobile": True or False, # Whether this operating system is for mobile.
              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
              "name": "A String", # Name of this operating system.
              "desktop": True or False, # Whether this operating system is for desktop.
            },
            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
          },
        ],
        "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a browser that can be targeted by ads.
            "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
            "name": "A String", # Name of this browser.
            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
            "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
          },
        ],
        "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
          { # Contains information about an operating system that can be targeted by ads.
            "mobile": True or False, # Whether this operating system is for mobile.
            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
            "name": "A String", # Name of this operating system.
            "desktop": True or False, # Whether this operating system is for desktop.
          },
        ],
        "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
          { # Contains information about a mobile carrier that can be targeted by ads.
            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
            "id": "A String", # ID of this mobile carrier.
            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
            "name": "A String", # Name of this mobile carrier.
          },
        ],
        "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
            "id": "A String", # ID of this connection type.
            "name": "A String", # Name of this connection type.
          },
        ],
      },
      "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
        "expression": "A String", # Expression describing which lists are being targeted by the ad.
      },
      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
        "expression": "A String", # Keyword expression being targeted by the ad.
      },
      "languageTargeting": { # Language Targeting. # Language targeting criteria.
        "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
          { # Contains information about a language that can be targeted by ads.
            "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
            "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
            "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
            "name": "A String", # Name of this language.
          },
        ],
      },
      "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
      "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
        "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
          { # Contains information about a country that can be targeted by ads.
            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
            "countryCode": "A String", # Country code.
            "name": "A String", # Name of this country.
          },
        ],
        "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
        "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
          { # Contains information about a postal code that can be targeted by ads.
            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
            "code": "A String", # Postal code. This is equivalent to the id field.
            "id": "A String", # ID of this postal code.
            "countryCode": "A String", # Country code of the country to which this postal code belongs.
          },
        ],
        "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
          { # Contains information about a region that can be targeted by ads.
            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
            "countryDartId": "A String", # DART ID of the country to which this region belongs.
            "name": "A String", # Name of this region.
            "countryCode": "A String", # Country code of the country to which this region belongs.
            "regionCode": "A String", # Region code.
            "dartId": "A String", # DART ID of this region.
          },
        ],
        "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
          { # Contains information about a city that can be targeted by ads.
            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
            "countryDartId": "A String", # DART ID of the country to which this city belongs.
            "name": "A String", # Name of this city.
            "countryCode": "A String", # Country code of the country to which this city belongs.
            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
            "regionCode": "A String", # Region code of the region to which this city belongs.
            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
            "regionDartId": "A String", # DART ID of the region to which this city belongs.
          },
        ],
        "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
          { # Contains information about a metro region that can be targeted by ads.
            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
            "name": "A String", # Name of this metro region.
            "countryCode": "A String", # Country code of the country to which this metro region belongs.
            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
            "dartId": "A String", # DART ID of this metro region.
          },
        ],
      },
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this targeting template. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
    }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.userProfiles.html000066400000000000000000000067201300622755700267650ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userProfiles

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.
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.userRolePermissionGroups.html000066400000000000000000000060741300622755700313560ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissionGroups

Instance Methods

get(profileId, id)

Gets one user role permission group by ID.

list(profileId)

Gets a list of all supported user role permission groups.

Method Details

get(profileId, id) 
Gets one user role permission group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission group ID. (required)

Returns:
  An object of the form:

    { # Represents a grouping of related user role permissions.
    "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
    "id": "A String", # ID of this user role permission.
    "name": "A String", # Name of this user role permission group.
  }
list(profileId) 
Gets a list of all supported user role permission groups.

Args:
  profileId: string, User profile ID associated with this request. (required)

Returns:
  An object of the form:

    { # User Role Permission Group List Response
    "userRolePermissionGroups": [ # User role permission group collection.
      { # Represents a grouping of related user role permissions.
        "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
        "id": "A String", # ID of this user role permission.
        "name": "A String", # Name of this user role permission group.
      },
    ],
    "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.userRolePermissions.html000066400000000000000000000066751300622755700303500ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRolePermissions

Instance Methods

get(profileId, id)

Gets one user role permission by ID.

list(profileId, ids=None)

Gets a list of user role permissions, possibly filtered.

Method Details

get(profileId, id) 
Gets one user role permission by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role permission ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a user role permission.
    "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
    "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
    "availability": "A String", # Levels of availability for a user role permission.
    "name": "A String", # Name of this user role permission.
    "id": "A String", # ID of this user role permission.
  }
list(profileId, ids=None) 
Gets a list of user role permissions, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Select only user role permissions with these IDs. (repeated)

Returns:
  An object of the form:

    { # User Role Permission List Response
    "userRolePermissions": [ # User role permission collection.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
  }
google-api-python-client-1.5.5/docs/dyn/dfareporting_v2_6.userRoles.html000066400000000000000000000523331300622755700262670ustar00rootroot00000000000000

DCM/DFA Reporting And Trafficking API . userRoles

Instance Methods

delete(profileId, id)

Deletes an existing user role.

get(profileId, id)

Gets one user role by ID.

insert(profileId, body)

Inserts a new user role.

list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)

Retrieves a list of user roles, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(profileId, id, body)

Updates an existing user role. This method supports patch semantics.

update(profileId, body)

Updates an existing user role.

Method Details

delete(profileId, id) 
Deletes an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
get(profileId, id) 
Gets one user role by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)

Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
insert(profileId, body) 
Inserts a new user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None) 
Retrieves a list of user roles, possibly filtered.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
  subaccountId: string, Select only user roles that belong to this subaccount.
  pageToken: string, Value of the nextPageToken from the previous result page.
  ids: string, Select only user roles with the specified IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
  sortOrder: string, Order of sorted results, default is ASCENDING.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 

Returns:
  An object of the form:

    { # User Role List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
    "userRoles": [ # User role collection.
      { # Contains properties of auser role, which is used to manage user access.
          "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
          "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
          "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
          "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
          "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
          "permissions": [ # List of permissions associated with this user role.
            { # Contains properties of a user role permission.
              "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
              "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
              "availability": "A String", # Levels of availability for a user role permission.
              "name": "A String", # Name of this user role permission.
              "id": "A String", # ID of this user role permission.
            },
          ],
          "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
          "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
        },
    ],
  }
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, id, body) 
Updates an existing user role. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, User role ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
update(profileId, body) 
Updates an existing user role.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains properties of auser role, which is used to manage user access.
    "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
    "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
    "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
    "permissions": [ # List of permissions associated with this user role.
      { # Contains properties of a user role permission.
        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
        "availability": "A String", # Levels of availability for a user role permission.
        "name": "A String", # Name of this user role permission.
        "id": "A String", # ID of this user role permission.
      },
    ],
    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of auser role, which is used to manage user access.
      "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
      "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
      "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
      "permissions": [ # List of permissions associated with this user role.
        { # Contains properties of a user role permission.
          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
          "availability": "A String", # Levels of availability for a user role permission.
          "name": "A String", # Name of this user role permission.
          "id": "A String", # ID of this user role permission.
        },
      ],
      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
    }
google-api-python-client-1.5.5/docs/dyn/discovery_v1.apis.html000066400000000000000000000616771300622755700243500ustar00rootroot00000000000000

APIs Discovery Service . apis

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",
            ],
            "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
              "map": [ # The map of discriminant value to schema to use for parsing..
                {
                  "type_value": "A String",
                  "$ref": "A String",
                },
              ],
              "discriminant": "A String", # The name of the type discriminant property.
            },
            "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.
        "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
        "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",
        ],
        "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
          "map": [ # The map of discriminant value to schema to use for parsing..
            {
              "type_value": "A String",
              "$ref": "A String",
            },
          ],
          "discriminant": "A String", # The name of the type discriminant property.
        },
        "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",
        ],
        "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
          "map": [ # The map of discriminant value to schema to use for parsing..
            {
              "type_value": "A String",
              "$ref": "A String",
            },
          ],
          "discriminant": "A String", # The name of the type discriminant property.
        },
        "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",
                ],
                "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
                  "map": [ # The map of discriminant value to schema to use for parsing..
                    {
                      "type_value": "A String",
                      "$ref": "A String",
                    },
                  ],
                  "discriminant": "A String", # The name of the type discriminant property.
                },
                "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.
            "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
            "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.
    "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients.
    "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
    "version_module": True or False,
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/discovery_v1.html000066400000000000000000000041151300622755700233750ustar00rootroot00000000000000

APIs Discovery Service

Instance Methods

apis()

Returns the apis Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dns_v1.changes.html000066400000000000000000000307701300622755700235670ustar00rootroot00000000000000

Google Cloud DNS API . changes

Instance Methods

create(project, managedZone, body)

Atomically update the ResourceRecordSet collection.

get(project, managedZone, changeId)

Fetch the representation of an existing Change.

list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)

Enumerate Changes to a ResourceRecordSet collection.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(project, managedZone, body) 
Atomically update the ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An atomic update to a collection of ResourceRecordSets.
    "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
      { # A unit of data that will be returned by the DNS servers.
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
          "A String",
        ],
        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
        "name": "A String", # For example, www.example.com.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
      },
    ],
    "status": "A String", # Status of the operation (output only).
    "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
    "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
    "additions": [ # Which ResourceRecordSets to add?
      { # A unit of data that will be returned by the DNS servers.
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
          "A String",
        ],
        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
        "name": "A String", # For example, www.example.com.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
      },
    ],
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
  }


Returns:
  An object of the form:

    { # An atomic update to a collection of ResourceRecordSets.
      "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        },
      ],
      "status": "A String", # Status of the operation (output only).
      "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
      "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
      "additions": [ # Which ResourceRecordSets to add?
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        },
      ],
      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    }
get(project, managedZone, changeId) 
Fetch the representation of an existing Change.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)

Returns:
  An object of the form:

    { # An atomic update to a collection of ResourceRecordSets.
      "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        },
      ],
      "status": "A String", # Status of the operation (output only).
      "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
      "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
      "additions": [ # Which ResourceRecordSets to add?
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        },
      ],
      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    }
list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None) 
Enumerate Changes to a ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  sortBy: string, Sorting criterion. The only supported value is change sequence.
    Allowed values
      changeSequence - 
  sortOrder: string, Sorting order direction: 'ascending' or 'descending'.

Returns:
  An object of the form:

    { # The response to a request to enumerate Changes to a ResourceRecordSets collection.
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
    "kind": "dns#changesListResponse", # Type of resource.
    "changes": [ # The requested changes.
      { # An atomic update to a collection of ResourceRecordSets.
          "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
            { # A unit of data that will be returned by the DNS servers.
              "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
                "A String",
              ],
              "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
              "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
              "name": "A String", # For example, www.example.com.
              "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
            },
          ],
          "status": "A String", # Status of the operation (output only).
          "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
          "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
          "additions": [ # Which ResourceRecordSets to add?
            { # A unit of data that will be returned by the DNS servers.
              "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
                "A String",
              ],
              "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
              "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
              "name": "A String", # For example, www.example.com.
              "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
            },
          ],
          "id": "A String", # Unique identifier for the resource; defined by the server (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.
google-api-python-client-1.5.5/docs/dyn/dns_v1.html000066400000000000000000000050531300622755700221540ustar00rootroot00000000000000

Google Cloud DNS API

Instance Methods

changes()

Returns the changes Resource.

managedZones()

Returns the managedZones Resource.

projects()

Returns the projects Resource.

resourceRecordSets()

Returns the resourceRecordSets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dns_v1.managedZones.html000066400000000000000000000250651300622755700245730ustar00rootroot00000000000000

Google Cloud DNS API . managedZones

Instance Methods

create(project, body)

Create a new ManagedZone.

delete(project, managedZone)

Delete a previously created ManagedZone.

get(project, managedZone)

Fetch the representation of an existing ManagedZone.

list(project, pageToken=None, maxResults=None, dnsName=None)

Enumerate ManagedZones that have been created but not yet deleted.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(project, body) 
Create a new ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
    "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
    "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
      "A String",
    ],
    "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
    "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
  }


Returns:
  An object of the form:

    { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
      "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
      "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
      "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
        "A String",
      ],
      "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
      "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
      "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
      "id": "A String", # Unique identifier for the resource; defined by the server (output only)
      "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
    }
delete(project, managedZone) 
Delete a previously created ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
get(project, managedZone) 
Fetch the representation of an existing ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)

Returns:
  An object of the form:

    { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
      "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
      "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
      "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
        "A String",
      ],
      "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
      "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
      "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
      "id": "A String", # Unique identifier for the resource; defined by the server (output only)
      "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
    }
list(project, pageToken=None, maxResults=None, dnsName=None) 
Enumerate ManagedZones that have been created but not yet deleted.

Args:
  project: string, Identifies the project addressed by this request. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  dnsName: string, Restricts the list to return only zones with this domain name.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
    "kind": "dns#managedZonesListResponse", # Type of resource.
    "managedZones": [ # The managed zone resources.
      { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
          "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
          "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
          "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
            "A String",
          ],
          "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
          "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
          "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
          "id": "A String", # Unique identifier for the resource; defined by the server (output only)
          "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/dns_v1.projects.html000066400000000000000000000054511300622755700240060ustar00rootroot00000000000000

Google Cloud DNS API . projects

Instance Methods

get(project)

Fetch the representation of an existing Project.

Method Details

get(project) 
Fetch the representation of an existing Project.

Args:
  project: string, Identifies the project addressed by this request. (required)

Returns:
  An object of the form:

    { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
    "quota": { # Limits associated with a Project. # Quotas assigned to this project (output only).
      "kind": "dns#quota", # Identifies what kind of resource this is. Value: the fixed string "dns#quota".
      "rrsetAdditionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
      "totalRrdataSizePerChange": 42, # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
      "resourceRecordsPerRrset": 42, # Maximum allowed number of ResourceRecords per ResourceRecordSet.
      "rrsetsPerManagedZone": 42, # Maximum allowed number of ResourceRecordSets per zone in the project.
      "rrsetDeletionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
      "managedZones": 42, # Maximum allowed number of managed zones in the project.
    },
    "kind": "dns#project", # Identifies what kind of resource this is. Value: the fixed string "dns#project".
    "id": "A String", # User assigned unique identifier for the resource (output only).
    "number": "A String", # Unique numeric identifier for the resource; defined by the server (output only).
  }
google-api-python-client-1.5.5/docs/dyn/dns_v1.resourceRecordSets.html000066400000000000000000000105031300622755700257740ustar00rootroot00000000000000

Google Cloud DNS API . resourceRecordSets

Instance Methods

list(project, managedZone, name=None, pageToken=None, maxResults=None, type=None)

Enumerate ResourceRecordSets that have been created but not yet deleted.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(project, managedZone, name=None, pageToken=None, maxResults=None, type=None) 
Enumerate ResourceRecordSets that have been created but not yet deleted.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  name: string, Restricts the list to return only records with this fully qualified domain name.
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
    "rrsets": [ # The resource record set resources.
      { # A unit of data that will be returned by the DNS servers.
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
          "A String",
        ],
        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
        "name": "A String", # For example, www.example.com.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
      },
    ],
    "kind": "dns#resourceRecordSetsListResponse", # Type of 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.
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.changes.html000066400000000000000000000346501300622755700245060ustar00rootroot00000000000000

Google Cloud DNS API . changes

Instance Methods

create(project, managedZone, body, clientOperationId=None)

Atomically update the ResourceRecordSet collection.

get(project, managedZone, changeId, clientOperationId=None)

Fetch the representation of an existing Change.

list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)

Enumerate Changes to a ResourceRecordSet collection.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(project, managedZone, body, clientOperationId=None) 
Atomically update the ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An atomic update to a collection of ResourceRecordSets.
    "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
      { # A unit of data that will be returned by the DNS servers.
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
          "A String",
        ],
        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
        "name": "A String", # For example, www.example.com.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "A String",
        ],
      },
    ],
    "status": "A String", # Status of the operation (output only).
    "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
    "isServing": True or False, # If the DNS queries for the zone will be served.
    "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
    "additions": [ # Which ResourceRecordSets to add?
      { # A unit of data that will be returned by the DNS servers.
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
          "A String",
        ],
        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
        "name": "A String", # For example, www.example.com.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "A String",
        ],
      },
    ],
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
  }

  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # An atomic update to a collection of ResourceRecordSets.
      "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
            "A String",
          ],
        },
      ],
      "status": "A String", # Status of the operation (output only).
      "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
      "isServing": True or False, # If the DNS queries for the zone will be served.
      "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
      "additions": [ # Which ResourceRecordSets to add?
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
            "A String",
          ],
        },
      ],
      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    }
get(project, managedZone, changeId, clientOperationId=None) 
Fetch the representation of an existing Change.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)
  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # An atomic update to a collection of ResourceRecordSets.
      "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
            "A String",
          ],
        },
      ],
      "status": "A String", # Status of the operation (output only).
      "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
      "isServing": True or False, # If the DNS queries for the zone will be served.
      "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
      "additions": [ # Which ResourceRecordSets to add?
        { # A unit of data that will be returned by the DNS servers.
          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
            "A String",
          ],
          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
          "name": "A String", # For example, www.example.com.
          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
          "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
            "A String",
          ],
        },
      ],
      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    }
list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None) 
Enumerate Changes to a ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  sortBy: string, Sorting criterion. The only supported value is change sequence.
    Allowed values
      CHANGE_SEQUENCE - 
  sortOrder: string, Sorting order direction: 'ascending' or 'descending'.

Returns:
  An object of the form:

    { # The response to a request to enumerate Changes to a ResourceRecordSets collection.
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
    },
    "kind": "dns#changesListResponse", # Type of resource.
    "changes": [ # The requested changes.
      { # An atomic update to a collection of ResourceRecordSets.
          "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
            { # A unit of data that will be returned by the DNS servers.
              "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
                "A String",
              ],
              "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
              "name": "A String", # For example, www.example.com.
              "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
              "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
              "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
                "A String",
              ],
            },
          ],
          "status": "A String", # Status of the operation (output only).
          "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
          "isServing": True or False, # If the DNS queries for the zone will be served.
          "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
          "additions": [ # Which ResourceRecordSets to add?
            { # A unit of data that will be returned by the DNS servers.
              "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
                "A String",
              ],
              "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
              "name": "A String", # For example, www.example.com.
              "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
              "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
              "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
                "A String",
              ],
            },
          ],
          "id": "A String", # Unique identifier for the resource; defined by the server (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.
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.dnskeys.html000066400000000000000000000232111300622755700245450ustar00rootroot00000000000000

Google Cloud DNS API . dnskeys

Instance Methods

get(project, managedZone, dnsKeyId, digestType=None, clientOperationId=None)

Fetch the representation of an existing DnsKey.

list(project, managedZone, pageToken=None, digestType=None, maxResults=None)

Enumerate DnsKeys to a ResourceRecordSet collection.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, managedZone, dnsKeyId, digestType=None, clientOperationId=None) 
Fetch the representation of an existing DnsKey.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  dnsKeyId: string, The identifier of the requested DnsKey. (required)
  digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # A DNSSEC key pair.
    "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
    "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
    "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
    "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
    "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
    "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
    "publicKey": "A String", # Base64 encoded public half of this key. Output only.
    "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
    "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
      {
        "type": "A String", # Specifies the algorithm used to calculate this digest.
        "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
      },
    ],
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
  }
list(project, managedZone, pageToken=None, digestType=None, maxResults=None) 
Enumerate DnsKeys to a ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

Returns:
  An object of the form:

    { # The response to a request to enumerate DnsKeys in a ManagedZone.
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
    },
    "dnsKeys": [ # The requested resources.
      { # A DNSSEC key pair.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
    ],
    "kind": "dns#dnsKeysListResponse", # Type of 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.
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.html000066400000000000000000000056301300622755700230730ustar00rootroot00000000000000

Google Cloud DNS API

Instance Methods

changes()

Returns the changes Resource.

dnskeys()

Returns the dnskeys Resource.

managedZoneOperations()

Returns the managedZoneOperations Resource.

managedZones()

Returns the managedZones Resource.

projects()

Returns the projects Resource.

resourceRecordSets()

Returns the resourceRecordSets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.managedZoneOperations.html000066400000000000000000000717311300622755700273730ustar00rootroot00000000000000

Google Cloud DNS API . managedZoneOperations

Instance Methods

get(project, managedZone, operation, clientOperationId=None)

Fetch the representation of an existing Operation.

list(project, managedZone, pageToken=None, maxResults=None, sortBy=None)

Enumerate Operations for the given ManagedZone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, managedZone, operation, clientOperationId=None) 
Fetch the representation of an existing Operation.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. (required)
  operation: string, Identifies the operation addressed by this request. (required)
  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
    "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
    "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
    "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
      "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
      "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
    },
    "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
      "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
      "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
    },
    "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
    "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
    "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
    "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
  }
list(project, managedZone, pageToken=None, maxResults=None, sortBy=None) 
Enumerate Operations for the given ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  sortBy: string, Sorting criterion. The only supported values are START_TIME and ID.
    Allowed values
      ID - 
      START_TIME - 

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
    },
    "kind": "dns#managedZoneOperationsListResponse", # Type of resource.
    "operations": [ # The operation resources.
      { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
        "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
        "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
        "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
          "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
            "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
            "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
            "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
            "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
            "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
            "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
            "publicKey": "A String", # Base64 encoded public half of this key. Output only.
            "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
            "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
              {
                "type": "A String", # Specifies the algorithm used to calculate this digest.
                "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
              },
            ],
            "id": "A String", # Unique identifier for the resource; defined by the server (output only).
            "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
          },
          "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
            "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
            "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
            "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
            "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
            "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
            "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
            "publicKey": "A String", # Base64 encoded public half of this key. Output only.
            "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
            "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
              {
                "type": "A String", # Specifies the algorithm used to calculate this digest.
                "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
              },
            ],
            "id": "A String", # Unique identifier for the resource; defined by the server (output only).
            "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
          },
        },
        "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
          "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
            "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
            "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
            "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
              "A String",
            ],
            "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
            "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
            "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
            "dnssecConfig": { # DNSSEC configuration.
              "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
              "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
                { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
                  "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
                  "keyLength": 42, # Length of the keys in bits.
                  "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
                  "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
                },
              ],
              "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
              "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
            },
            "id": "A String", # Unique identifier for the resource; defined by the server (output only)
            "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
          },
          "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
            "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
            "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
            "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
              "A String",
            ],
            "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
            "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
            "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
            "dnssecConfig": { # DNSSEC configuration.
              "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
              "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
                { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
                  "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
                  "keyLength": 42, # Length of the keys in bits.
                  "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
                  "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
                },
              ],
              "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
              "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
            },
            "id": "A String", # Unique identifier for the resource; defined by the server (output only)
            "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
          },
        },
        "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
        "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
        "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
        "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (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.
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.managedZones.html000066400000000000000000001404041300622755700255040ustar00rootroot00000000000000

Google Cloud DNS API . managedZones

Instance Methods

create(project, body, clientOperationId=None)

Create a new ManagedZone.

delete(project, managedZone, clientOperationId=None)

Delete a previously created ManagedZone.

get(project, managedZone, clientOperationId=None)

Fetch the representation of an existing ManagedZone.

list(project, pageToken=None, maxResults=None, dnsName=None)

Enumerate ManagedZones that have been created but not yet deleted.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, managedZone, body, clientOperationId=None)

Update an existing ManagedZone. This method supports patch semantics.

update(project, managedZone, body, clientOperationId=None)

Update an existing ManagedZone.

Method Details

create(project, body, clientOperationId=None) 
Create a new ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
  "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
  "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
  "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    "A String",
  ],
  "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
  "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
  "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
  "dnssecConfig": { # DNSSEC configuration.
    "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
    "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
      { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
        "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
        "keyLength": 42, # Length of the keys in bits.
        "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
      },
    ],
    "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
    "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
  },
  "id": "A String", # Unique identifier for the resource; defined by the server (output only)
  "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
}

  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
    "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
    "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
      "A String",
    ],
    "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
    "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    "dnssecConfig": { # DNSSEC configuration.
      "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
      "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
        { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
          "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
          "keyLength": 42, # Length of the keys in bits.
          "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
          "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
        },
      ],
      "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
      "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
    },
    "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
  }
delete(project, managedZone, clientOperationId=None) 
Delete a previously created ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    {
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
    },
  }
get(project, managedZone, clientOperationId=None) 
Fetch the representation of an existing ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
    "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
    "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
      "A String",
    ],
    "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
    "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    "dnssecConfig": { # DNSSEC configuration.
      "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
      "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
        { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
          "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
          "keyLength": 42, # Length of the keys in bits.
          "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
          "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
        },
      ],
      "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
      "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
    },
    "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
  }
list(project, pageToken=None, maxResults=None, dnsName=None) 
Enumerate ManagedZones that have been created but not yet deleted.

Args:
  project: string, Identifies the project addressed by this request. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  dnsName: string, Restricts the list to return only zones with this domain name.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
    },
    "kind": "dns#managedZonesListResponse", # Type of resource.
    "managedZones": [ # The managed zone resources.
      { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
    ],
  }
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, managedZone, body, clientOperationId=None) 
Update an existing ManagedZone. This method supports patch semantics.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
  "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
  "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
  "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    "A String",
  ],
  "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
  "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
  "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
  "dnssecConfig": { # DNSSEC configuration.
    "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
    "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
      { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
        "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
        "keyLength": 42, # Length of the keys in bits.
        "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
      },
    ],
    "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
    "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
  },
  "id": "A String", # Unique identifier for the resource; defined by the server (output only)
  "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
}

  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
    "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
    "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
    "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
      "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
      "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
    },
    "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
      "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
      "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
    },
    "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
    "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
    "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
    "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
  }
update(project, managedZone, body, clientOperationId=None) 
Update an existing ManagedZone.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
  "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
  "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
  "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    "A String",
  ],
  "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
  "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
  "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
  "dnssecConfig": { # DNSSEC configuration.
    "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
    "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
      { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
        "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
        "keyLength": 42, # Length of the keys in bits.
        "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
      },
    ],
    "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
    "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
  },
  "id": "A String", # Unique identifier for the resource; defined by the server (output only)
  "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
}

  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
    "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
    "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
    "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
      "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
      "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
        "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
        "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
        "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
        "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
        "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
        "publicKey": "A String", # Base64 encoded public half of this key. Output only.
        "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
        "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
          {
            "type": "A String", # Specifies the algorithm used to calculate this digest.
            "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
          },
        ],
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
      },
    },
    "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
      "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
      "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
        "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
        "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
          "A String",
        ],
        "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
        "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
        "dnssecConfig": { # DNSSEC configuration.
          "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
          "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
            { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
              "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
              "keyLength": 42, # Length of the keys in bits.
              "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
              "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
            },
          ],
          "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
          "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
        },
        "id": "A String", # Unique identifier for the resource; defined by the server (output only)
        "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
      },
    },
    "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
    "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
    "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
    "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
  }
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.projects.html000066400000000000000000000077601300622755700247310ustar00rootroot00000000000000

Google Cloud DNS API . projects

Instance Methods

get(project, clientOperationId=None)

Fetch the representation of an existing Project.

Method Details

get(project, clientOperationId=None) 
Fetch the representation of an existing Project.

Args:
  project: string, Identifies the project addressed by this request. (required)
  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

Returns:
  An object of the form:

    { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
    "quota": { # Limits associated with a Project. # Quotas assigned to this project (output only).
      "kind": "dns#quota", # Identifies what kind of resource this is. Value: the fixed string "dns#quota".
      "rrsetAdditionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
      "totalRrdataSizePerChange": 42, # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
      "resourceRecordsPerRrset": 42, # Maximum allowed number of ResourceRecords per ResourceRecordSet.
      "dnsKeysPerManagedZone": 42, # Maximum allowed number of DnsKeys per ManagedZone.
      "rrsetsPerManagedZone": 42, # Maximum allowed number of ResourceRecordSets per zone in the project.
      "whitelistedKeySpecs": [ # DNSSEC algorithm and key length types that can be used for DnsKeys.
        { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
          "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
          "keyLength": 42, # Length of the keys in bits.
          "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
          "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
        },
      ],
      "rrsetDeletionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
      "managedZones": 42, # Maximum allowed number of managed zones in the project.
    },
    "kind": "dns#project", # Identifies what kind of resource this is. Value: the fixed string "dns#project".
    "id": "A String", # User assigned unique identifier for the resource (output only).
    "number": "A String", # Unique numeric identifier for the resource; defined by the server (output only).
  }
google-api-python-client-1.5.5/docs/dyn/dns_v2beta1.resourceRecordSets.html000066400000000000000000000113031300622755700267110ustar00rootroot00000000000000

Google Cloud DNS API . resourceRecordSets

Instance Methods

list(project, managedZone, name=None, pageToken=None, maxResults=None, type=None)

Enumerate ResourceRecordSets that have been created but not yet deleted.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(project, managedZone, name=None, pageToken=None, maxResults=None, type=None) 
Enumerate ResourceRecordSets that have been created but not yet deleted.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
  name: string, Restricts the list to return only records with this fully qualified domain name.
  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
  type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
        #
        # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
    },
    "kind": "dns#resourceRecordSetsListResponse", # Type of resource.
    "rrsets": [ # The resource record set resources.
      { # A unit of data that will be returned by the DNS servers.
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
          "A String",
        ],
        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
        "name": "A String", # For example, www.example.com.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "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.
google-api-python-client-1.5.5/docs/dyn/doubleclickbidmanager_v1.html000066400000000000000000000051231300622755700256600ustar00rootroot00000000000000

DoubleClick Bid Manager API

Instance Methods

lineitems()

Returns the lineitems Resource.

queries()

Returns the queries Resource.

reports()

Returns the reports Resource.

sdf()

Returns the sdf Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/doubleclickbidmanager_v1.lineitems.html000066400000000000000000000074261300622755700276600ustar00rootroot00000000000000

DoubleClick Bid Manager API . lineitems

Instance Methods

downloadlineitems(body)

Retrieves line items in CSV format.

uploadlineitems(body)

Uploads line items in CSV format.

Method Details

downloadlineitems(body) 
Retrieves line items in CSV format.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to fetch stored line items.
    "fileSpec": "A String", # File specification (column names, types, order) in which the line items will be returned. Default to EWF.
    "filterType": "A String", # Filter type used to filter line items to fetch.
    "filterIds": [ # Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.
      "A String",
    ],
    "format": "A String", # Format in which the line items will be returned. Default to CSV.
  }


Returns:
  An object of the form:

    { # Download line items response.
    "lineItems": "A String", # Retrieved line items in CSV format. Refer to  Entity Write File Format or  Structured Data File Format for more information on file formats.
  }
uploadlineitems(body) 
Uploads line items in CSV format.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to upload line items.
    "lineItems": "A String", # Line items in CSV to upload. Refer to  Entity Write File Format for more information on file format.
    "dryRun": True or False, # Set to true to get upload status without actually persisting the line items.
    "format": "A String", # Format the line items are in. Default to CSV.
  }


Returns:
  An object of the form:

    { # Upload line items response.
    "uploadStatus": { # Represents the status of upload. # Status of upload.
      "errors": [ # Reasons why upload can't be completed.
        "A String",
      ],
      "rowStatus": [ # Per-row upload status.
        { # Represents the upload status of a row in the request.
          "errors": [ # Reasons why the entity can't be uploaded.
            "A String",
          ],
          "entityName": "A String", # Entity name.
          "changed": True or False, # Whether the stored entity is changed as a result of upload.
          "rowNumber": 42, # Row number.
          "persisted": True or False, # Whether the entity is persisted.
          "entityId": "A String", # Entity Id.
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/doubleclickbidmanager_v1.queries.html000066400000000000000000000424541300622755700273440ustar00rootroot00000000000000

DoubleClick Bid Manager API . queries

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", # Identifies what kind of resource this is. Value: the fixed string "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", # Datetime to periodically run the query until.
    "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
    "frequency": "A String", # How often the query is run.
    "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
  },
  "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.
    "locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE
        #
        # An locale string not in the list above will generate reports in English.
    "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", # Identifies what kind of resource this is. Value: the fixed string "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", # Datetime to periodically run the query until.
      "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
      "frequency": "A String", # How often the query is run.
      "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
    },
    "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.
      "locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE
          #
          # An locale string not in the list above will generate reports in English.
      "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", # Identifies what kind of resource this is. Value: the fixed string "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", # Datetime to periodically run the query until.
      "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
      "frequency": "A String", # How often the query is run.
      "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
    },
    "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.
      "locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE
          #
          # An locale string not in the list above will generate reports in English.
      "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", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
    "queries": [ # Retrieved queries.
      { # Represents a query.
        "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "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", # Datetime to periodically run the query until.
          "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
          "frequency": "A String", # How often the query is run.
          "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.
        },
        "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.
          "locale": "A String", # Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE
              #
              # An locale string not in the list above will generate reports in English.
          "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.
  }
google-api-python-client-1.5.5/docs/dyn/doubleclickbidmanager_v1.reports.html000066400000000000000000000071331300622755700273600ustar00rootroot00000000000000

DoubleClick Bid Manager API . reports

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", # Identifies what kind of resource this is. Value: the fixed string "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.
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/doubleclickbidmanager_v1.sdf.html000066400000000000000000000047321300622755700264400ustar00rootroot00000000000000

DoubleClick Bid Manager API . sdf

Instance Methods

download(body)

Retrieves entities in SDF format.

Method Details

download(body) 
Retrieves entities in SDF format.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to fetch stored insertion orders, line items, TrueView ad groups and ads.
    "filterType": "A String", # Filter type used to filter line items to fetch.
    "version": "A String", # SDF Version (column names, types, order) in which the entities will be returned. Default to 3.
    "fileTypes": [ # File types that will be returned.
      "A String",
    ],
    "filterIds": [ # The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. Only one ID is allowed for the ADVERTISER_ID filter type. For INSERTION_ORDER_ID or LINE_ITEM_ID filter types all IDs must be from the same Advertiser.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Download response.
    "lineItems": "A String", # Retrieved line items in SDF format.
    "insertionOrders": "A String", # Retrieved insertion orders in SDF format.
    "ads": "A String", # Retrieved ads in SDF format.
    "adGroups": "A String", # Retrieved ad groups in SDF format.
  }
google-api-python-client-1.5.5/docs/dyn/doubleclicksearch_v2.conversion.html000066400000000000000000001162271300622755700272310ustar00rootroot00000000000000

DoubleClick Search API . conversion

Instance Methods

get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)

Retrieves a list of conversions from a DoubleClick Search engine account.

insert(body)

Inserts a batch of new conversions into DoubleClick Search.

patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body)

Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.

update(body)

Updates a batch of conversions in DoubleClick Search.

updateAvailability(body)

Updates the availabilities of a batch of floodlight activities in DoubleClick Search.

Method Details

get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None) 
Retrieves a list of conversions from a DoubleClick Search engine account.

Args:
  agencyId: string, Numeric ID of the agency. (required)
  advertiserId: string, Numeric ID of the advertiser. (required)
  engineAccountId: string, Numeric ID of the engine account. (required)
  endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
  rowCount: integer, The number of conversions to return per call. (required)
  startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
  startRow: integer, The 0-based starting index for retrieving conversions results. (required)
  adGroupId: string, Numeric ID of the ad group.
  campaignId: string, Numeric ID of the campaign.
  adId: string, Numeric ID of the ad.
  criterionId: string, Numeric ID of the criterion.

Returns:
  An object of the form:

    { # A list of conversions.
      "conversion": [ # The conversions being requested.
        { # A conversion containing data relevant to DoubleClick Search.
          "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
            { # A message containing the custome dimension.
              "name": "A String", # Custom dimension name.
              "value": "A String", # Custom dimension value.
            },
          ],
          "adGroupId": "A String", # DS ad group ID.
          "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
          "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "campaignId": "A String", # DS campaign ID.
          "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
          "advertiserId": "A String", # DS advertiser ID.
          "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
          "clickId": "A String", # DS click ID for the conversion.
          "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
          "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
          "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
          "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
          "deviceType": "A String", # The type of device on which the conversion occurred.
          "adId": "A String", # DS ad ID.
          "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
          "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
          "channel": "A String", # Sales channel for the product. Acceptable values are:
              # - "local": a physical store
              # - "online": an online store
          "productId": "A String", # The product ID (SKU).
          "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
          "agencyId": "A String", # DS agency ID.
          "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
          "quantityMillis": "A String", # The quantity of this conversion, in millis.
          "criterionId": "A String", # DS criterion (keyword) ID.
          "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
          "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
          "customMetric": [ # Custom metrics for the conversion.
            { # A message containing the custome metric.
              "name": "A String", # Custom metric name.
              "value": 3.14, # Custom metric numeric value.
            },
          ],
          "engineAccountId": "A String", # DS engine account ID.
          "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
          "productGroupId": "A String", # DS product group ID.
          "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
          "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
        },
      ],
      "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
    }
insert(body) 
Inserts a batch of new conversions into DoubleClick Search.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A list of conversions.
    "conversion": [ # The conversions being requested.
      { # A conversion containing data relevant to DoubleClick Search.
        "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
          { # A message containing the custome dimension.
            "name": "A String", # Custom dimension name.
            "value": "A String", # Custom dimension value.
          },
        ],
        "adGroupId": "A String", # DS ad group ID.
        "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
        "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
        "campaignId": "A String", # DS campaign ID.
        "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
        "advertiserId": "A String", # DS advertiser ID.
        "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
        "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
        "clickId": "A String", # DS click ID for the conversion.
        "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
        "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
        "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
        "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
        "deviceType": "A String", # The type of device on which the conversion occurred.
        "adId": "A String", # DS ad ID.
        "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
        "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
        "channel": "A String", # Sales channel for the product. Acceptable values are:
            # - "local": a physical store
            # - "online": an online store
        "productId": "A String", # The product ID (SKU).
        "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
        "agencyId": "A String", # DS agency ID.
        "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
        "quantityMillis": "A String", # The quantity of this conversion, in millis.
        "criterionId": "A String", # DS criterion (keyword) ID.
        "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
        "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
        "customMetric": [ # Custom metrics for the conversion.
          { # A message containing the custome metric.
            "name": "A String", # Custom metric name.
            "value": 3.14, # Custom metric numeric value.
          },
        ],
        "engineAccountId": "A String", # DS engine account ID.
        "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
        "productGroupId": "A String", # DS product group ID.
        "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
        "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
      },
    ],
    "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
  }


Returns:
  An object of the form:

    { # A list of conversions.
      "conversion": [ # The conversions being requested.
        { # A conversion containing data relevant to DoubleClick Search.
          "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
            { # A message containing the custome dimension.
              "name": "A String", # Custom dimension name.
              "value": "A String", # Custom dimension value.
            },
          ],
          "adGroupId": "A String", # DS ad group ID.
          "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
          "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "campaignId": "A String", # DS campaign ID.
          "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
          "advertiserId": "A String", # DS advertiser ID.
          "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
          "clickId": "A String", # DS click ID for the conversion.
          "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
          "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
          "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
          "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
          "deviceType": "A String", # The type of device on which the conversion occurred.
          "adId": "A String", # DS ad ID.
          "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
          "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
          "channel": "A String", # Sales channel for the product. Acceptable values are:
              # - "local": a physical store
              # - "online": an online store
          "productId": "A String", # The product ID (SKU).
          "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
          "agencyId": "A String", # DS agency ID.
          "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
          "quantityMillis": "A String", # The quantity of this conversion, in millis.
          "criterionId": "A String", # DS criterion (keyword) ID.
          "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
          "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
          "customMetric": [ # Custom metrics for the conversion.
            { # A message containing the custome metric.
              "name": "A String", # Custom metric name.
              "value": 3.14, # Custom metric numeric value.
            },
          ],
          "engineAccountId": "A String", # DS engine account ID.
          "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
          "productGroupId": "A String", # DS product group ID.
          "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
          "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
        },
      ],
      "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
    }
patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body) 
Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.

Args:
  advertiserId: string, Numeric ID of the advertiser. (required)
  agencyId: string, Numeric ID of the agency. (required)
  endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
  engineAccountId: string, Numeric ID of the engine account. (required)
  rowCount: integer, The number of conversions to return per call. (required)
  startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
  startRow: integer, The 0-based starting index for retrieving conversions results. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A list of conversions.
    "conversion": [ # The conversions being requested.
      { # A conversion containing data relevant to DoubleClick Search.
        "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
          { # A message containing the custome dimension.
            "name": "A String", # Custom dimension name.
            "value": "A String", # Custom dimension value.
          },
        ],
        "adGroupId": "A String", # DS ad group ID.
        "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
        "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
        "campaignId": "A String", # DS campaign ID.
        "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
        "advertiserId": "A String", # DS advertiser ID.
        "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
        "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
        "clickId": "A String", # DS click ID for the conversion.
        "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
        "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
        "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
        "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
        "deviceType": "A String", # The type of device on which the conversion occurred.
        "adId": "A String", # DS ad ID.
        "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
        "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
        "channel": "A String", # Sales channel for the product. Acceptable values are:
            # - "local": a physical store
            # - "online": an online store
        "productId": "A String", # The product ID (SKU).
        "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
        "agencyId": "A String", # DS agency ID.
        "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
        "quantityMillis": "A String", # The quantity of this conversion, in millis.
        "criterionId": "A String", # DS criterion (keyword) ID.
        "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
        "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
        "customMetric": [ # Custom metrics for the conversion.
          { # A message containing the custome metric.
            "name": "A String", # Custom metric name.
            "value": 3.14, # Custom metric numeric value.
          },
        ],
        "engineAccountId": "A String", # DS engine account ID.
        "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
        "productGroupId": "A String", # DS product group ID.
        "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
        "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
      },
    ],
    "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
  }


Returns:
  An object of the form:

    { # A list of conversions.
      "conversion": [ # The conversions being requested.
        { # A conversion containing data relevant to DoubleClick Search.
          "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
            { # A message containing the custome dimension.
              "name": "A String", # Custom dimension name.
              "value": "A String", # Custom dimension value.
            },
          ],
          "adGroupId": "A String", # DS ad group ID.
          "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
          "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "campaignId": "A String", # DS campaign ID.
          "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
          "advertiserId": "A String", # DS advertiser ID.
          "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
          "clickId": "A String", # DS click ID for the conversion.
          "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
          "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
          "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
          "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
          "deviceType": "A String", # The type of device on which the conversion occurred.
          "adId": "A String", # DS ad ID.
          "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
          "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
          "channel": "A String", # Sales channel for the product. Acceptable values are:
              # - "local": a physical store
              # - "online": an online store
          "productId": "A String", # The product ID (SKU).
          "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
          "agencyId": "A String", # DS agency ID.
          "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
          "quantityMillis": "A String", # The quantity of this conversion, in millis.
          "criterionId": "A String", # DS criterion (keyword) ID.
          "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
          "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
          "customMetric": [ # Custom metrics for the conversion.
            { # A message containing the custome metric.
              "name": "A String", # Custom metric name.
              "value": 3.14, # Custom metric numeric value.
            },
          ],
          "engineAccountId": "A String", # DS engine account ID.
          "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
          "productGroupId": "A String", # DS product group ID.
          "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
          "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
        },
      ],
      "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
    }
update(body) 
Updates a batch of conversions in DoubleClick Search.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A list of conversions.
    "conversion": [ # The conversions being requested.
      { # A conversion containing data relevant to DoubleClick Search.
        "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
          { # A message containing the custome dimension.
            "name": "A String", # Custom dimension name.
            "value": "A String", # Custom dimension value.
          },
        ],
        "adGroupId": "A String", # DS ad group ID.
        "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
        "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
        "campaignId": "A String", # DS campaign ID.
        "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
        "advertiserId": "A String", # DS advertiser ID.
        "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
        "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
        "clickId": "A String", # DS click ID for the conversion.
        "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
        "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
        "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
        "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
        "deviceType": "A String", # The type of device on which the conversion occurred.
        "adId": "A String", # DS ad ID.
        "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
        "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
        "channel": "A String", # Sales channel for the product. Acceptable values are:
            # - "local": a physical store
            # - "online": an online store
        "productId": "A String", # The product ID (SKU).
        "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
        "agencyId": "A String", # DS agency ID.
        "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
        "quantityMillis": "A String", # The quantity of this conversion, in millis.
        "criterionId": "A String", # DS criterion (keyword) ID.
        "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
        "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
        "customMetric": [ # Custom metrics for the conversion.
          { # A message containing the custome metric.
            "name": "A String", # Custom metric name.
            "value": 3.14, # Custom metric numeric value.
          },
        ],
        "engineAccountId": "A String", # DS engine account ID.
        "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
        "productGroupId": "A String", # DS product group ID.
        "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
        "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
      },
    ],
    "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
  }


Returns:
  An object of the form:

    { # A list of conversions.
      "conversion": [ # The conversions being requested.
        { # A conversion containing data relevant to DoubleClick Search.
          "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
            { # A message containing the custome dimension.
              "name": "A String", # Custom dimension name.
              "value": "A String", # Custom dimension value.
            },
          ],
          "adGroupId": "A String", # DS ad group ID.
          "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
          "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "campaignId": "A String", # DS campaign ID.
          "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
          "advertiserId": "A String", # DS advertiser ID.
          "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
          "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
          "clickId": "A String", # DS click ID for the conversion.
          "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
          "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
          "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
          "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
          "deviceType": "A String", # The type of device on which the conversion occurred.
          "adId": "A String", # DS ad ID.
          "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
          "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
          "channel": "A String", # Sales channel for the product. Acceptable values are:
              # - "local": a physical store
              # - "online": an online store
          "productId": "A String", # The product ID (SKU).
          "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
          "agencyId": "A String", # DS agency ID.
          "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
          "quantityMillis": "A String", # The quantity of this conversion, in millis.
          "criterionId": "A String", # DS criterion (keyword) ID.
          "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
          "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
          "customMetric": [ # Custom metrics for the conversion.
            { # A message containing the custome metric.
              "name": "A String", # Custom metric name.
              "value": 3.14, # Custom metric numeric value.
            },
          ],
          "engineAccountId": "A String", # DS engine account ID.
          "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).
          "productGroupId": "A String", # DS product group ID.
          "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
          "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
        },
      ],
      "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
    }
updateAvailability(body) 
Updates the availabilities of a batch of floodlight activities in DoubleClick Search.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to update availability.
    "availabilities": [ # The availabilities being requested.
      { # A message containing availability data relevant to DoubleClick Search.
        "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
        "agencyId": "A String", # DS agency ID.
        "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
        "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
        "advertiserId": "A String", # DS advertiser ID.
        "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).
      },
    ],
  }


Returns:
  An object of the form:

    { # The response to a update availability request.
    "availabilities": [ # The availabilities being returned.
      { # A message containing availability data relevant to DoubleClick Search.
        "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
        "agencyId": "A String", # DS agency ID.
        "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
        "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
        "advertiserId": "A String", # DS advertiser ID.
        "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/doubleclicksearch_v2.html000066400000000000000000000046721300622755700250450ustar00rootroot00000000000000

DoubleClick Search API

Instance Methods

conversion()

Returns the conversion Resource.

reports()

Returns the reports Resource.

savedColumns()

Returns the savedColumns Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/doubleclicksearch_v2.reports.html000066400000000000000000002042161300622755700265360ustar00rootroot00000000000000

DoubleClick Search API . reports

Instance Methods

generate(body)

Generates and returns a report immediately.

get(reportId)

Polls for the status of a report request.

getFile(reportId, reportFragment)

Downloads a report file encoded in UTF-8.

getFile_media(reportId, reportFragment)

Downloads a report file encoded in UTF-8.

request(body)

Inserts a report request into the reporting system.

Method Details

generate(body) 
Generates and returns a report immediately.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A request object used to create a DoubleClick Search report.
    "orderBy": [ # Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
      {
        "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
          "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
          "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
              # - "sold": returns metrics only for products that were sold
              # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
          "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
          "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
          "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
              # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
          "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
          "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
          "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
          "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
        },
        "sortOrder": "A String", # The sort direction, which is either ascending or descending.
      },
    ],
    "reportScope": { # The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
      "adGroupId": "A String", # DS ad group ID.
      "agencyId": "A String", # DS agency ID.
      "engineAccountId": "A String", # DS engine account ID.
      "campaignId": "A String", # DS campaign ID.
      "advertiserId": "A String", # DS advertiser ID.
      "keywordId": "A String", # DS keyword ID.
      "adId": "A String", # DS ad ID.
    },
    "maxRowsPerFile": 42, # Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.
    "statisticsCurrency": "A String", # Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
    "timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
      "changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.
      "endDate": "A String", # Inclusive date in YYYY-MM-DD format.
      "changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.
      "startDate": "A String", # Inclusive date in YYYY-MM-DD format.
    },
    "startRow": 0, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
    "rowCount": 10000, # Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
    "reportType": "A String", # Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.
    "verifySingleTimeZone": false, # If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
    "filters": [ # A list of filters to be applied to the report.
      {
        "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
          "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
          "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
              # - "sold": returns metrics only for products that were sold
              # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
          "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
          "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
          "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
              # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
          "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
          "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
          "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
          "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
        },
        "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
        "values": [ # A list of values to filter the column value against.
          "",
        ],
      },
    ],
    "downloadFormat": "A String", # Format that the report should be returned in. Currently csv or tsv is supported.
    "includeDeletedEntities": false, # Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
    "columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.
      { # A request object used to create a DoubleClick Search report.
        "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
        "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
            # - "sold": returns metrics only for products that were sold
            # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
        "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
        "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
        "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
            # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
        "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
        "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
        "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
        "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
        "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
      },
    ],
    "includeRemovedEntities": false, # Determines if removed entities should be included in the report. Defaults to false.
  }


Returns:
  An object of the form:

    { # A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.
    "files": [ # Asynchronous report only. Contains a list of generated report files once the report has succesfully completed.
      {
        "url": "A String", # Use this url to download the report file.
        "byteCount": "A String", # The size of this report file in bytes.
      },
    ],
    "kind": "doubleclicksearch#report", # Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report.
    "rows": [ # Synchronous report only. Generated report rows.
      { # A row in a DoubleClick Search report.
        "a_key": "", # Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
      },
    ],
    "request": { # A request object used to create a DoubleClick Search report. # The request that created the report. Optional fields not specified in the original request are filled with default values.
        "orderBy": [ # Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
          {
            "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
              "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
              "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                  # - "sold": returns metrics only for products that were sold
                  # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
              "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
              "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
              "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                  # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
              "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
              "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
              "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
              "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
              "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
            },
            "sortOrder": "A String", # The sort direction, which is either ascending or descending.
          },
        ],
        "reportScope": { # The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
          "adGroupId": "A String", # DS ad group ID.
          "agencyId": "A String", # DS agency ID.
          "engineAccountId": "A String", # DS engine account ID.
          "campaignId": "A String", # DS campaign ID.
          "advertiserId": "A String", # DS advertiser ID.
          "keywordId": "A String", # DS keyword ID.
          "adId": "A String", # DS ad ID.
        },
        "maxRowsPerFile": 42, # Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.
        "statisticsCurrency": "A String", # Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
        "timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
          "changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.
          "endDate": "A String", # Inclusive date in YYYY-MM-DD format.
          "changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format.
        },
        "startRow": 0, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
        "rowCount": 10000, # Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
        "reportType": "A String", # Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.
        "verifySingleTimeZone": false, # If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
        "filters": [ # A list of filters to be applied to the report.
          {
            "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
              "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
              "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                  # - "sold": returns metrics only for products that were sold
                  # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
              "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
              "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
              "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                  # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
              "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
              "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
              "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
              "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
              "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
            },
            "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
            "values": [ # A list of values to filter the column value against.
              "",
            ],
          },
        ],
        "downloadFormat": "A String", # Format that the report should be returned in. Currently csv or tsv is supported.
        "includeDeletedEntities": false, # Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
        "columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.
          { # A request object used to create a DoubleClick Search report.
            "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
            "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                # - "sold": returns metrics only for products that were sold
                # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
            "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
            "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
            "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
            "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
            "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
            "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
            "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
            "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
          },
        ],
        "includeRemovedEntities": false, # Determines if removed entities should be included in the report. Defaults to false.
      },
    "isReportReady": True or False, # Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
    "rowCount": 42, # The number of report rows generated by the report, not including headers.
    "statisticsTimeZone": "A String", # If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
    "statisticsCurrencyCode": "A String", # The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request.
    "id": "A String", # Asynchronous report only. Id of the report.
  }
get(reportId) 
Polls for the status of a report request.

Args:
  reportId: string, ID of the report request being polled. (required)

Returns:
  An object of the form:

    { # A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.
    "files": [ # Asynchronous report only. Contains a list of generated report files once the report has succesfully completed.
      {
        "url": "A String", # Use this url to download the report file.
        "byteCount": "A String", # The size of this report file in bytes.
      },
    ],
    "kind": "doubleclicksearch#report", # Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report.
    "rows": [ # Synchronous report only. Generated report rows.
      { # A row in a DoubleClick Search report.
        "a_key": "", # Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
      },
    ],
    "request": { # A request object used to create a DoubleClick Search report. # The request that created the report. Optional fields not specified in the original request are filled with default values.
        "orderBy": [ # Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
          {
            "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
              "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
              "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                  # - "sold": returns metrics only for products that were sold
                  # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
              "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
              "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
              "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                  # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
              "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
              "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
              "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
              "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
              "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
            },
            "sortOrder": "A String", # The sort direction, which is either ascending or descending.
          },
        ],
        "reportScope": { # The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
          "adGroupId": "A String", # DS ad group ID.
          "agencyId": "A String", # DS agency ID.
          "engineAccountId": "A String", # DS engine account ID.
          "campaignId": "A String", # DS campaign ID.
          "advertiserId": "A String", # DS advertiser ID.
          "keywordId": "A String", # DS keyword ID.
          "adId": "A String", # DS ad ID.
        },
        "maxRowsPerFile": 42, # Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.
        "statisticsCurrency": "A String", # Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
        "timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
          "changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.
          "endDate": "A String", # Inclusive date in YYYY-MM-DD format.
          "changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format.
        },
        "startRow": 0, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
        "rowCount": 10000, # Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
        "reportType": "A String", # Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.
        "verifySingleTimeZone": false, # If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
        "filters": [ # A list of filters to be applied to the report.
          {
            "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
              "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
              "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                  # - "sold": returns metrics only for products that were sold
                  # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
              "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
              "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
              "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                  # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
              "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
              "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
              "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
              "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
              "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
            },
            "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
            "values": [ # A list of values to filter the column value against.
              "",
            ],
          },
        ],
        "downloadFormat": "A String", # Format that the report should be returned in. Currently csv or tsv is supported.
        "includeDeletedEntities": false, # Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
        "columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.
          { # A request object used to create a DoubleClick Search report.
            "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
            "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                # - "sold": returns metrics only for products that were sold
                # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
            "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
            "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
            "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
            "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
            "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
            "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
            "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
            "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
          },
        ],
        "includeRemovedEntities": false, # Determines if removed entities should be included in the report. Defaults to false.
      },
    "isReportReady": True or False, # Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
    "rowCount": 42, # The number of report rows generated by the report, not including headers.
    "statisticsTimeZone": "A String", # If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
    "statisticsCurrencyCode": "A String", # The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request.
    "id": "A String", # Asynchronous report only. Id of the report.
  }
getFile(reportId, reportFragment) 
Downloads a report file encoded in UTF-8.

Args:
  reportId: string, ID of the report. (required)
  reportFragment: integer, The index of the report fragment to download. (required)
getFile_media(reportId, reportFragment) 
Downloads a report file encoded in UTF-8.

Args:
  reportId: string, ID of the report. (required)
  reportFragment: integer, The index of the report fragment to download. (required)
request(body) 
Inserts a report request into the reporting system.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A request object used to create a DoubleClick Search report.
    "orderBy": [ # Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
      {
        "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
          "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
          "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
              # - "sold": returns metrics only for products that were sold
              # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
          "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
          "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
          "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
              # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
          "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
          "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
          "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
          "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
        },
        "sortOrder": "A String", # The sort direction, which is either ascending or descending.
      },
    ],
    "reportScope": { # The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
      "adGroupId": "A String", # DS ad group ID.
      "agencyId": "A String", # DS agency ID.
      "engineAccountId": "A String", # DS engine account ID.
      "campaignId": "A String", # DS campaign ID.
      "advertiserId": "A String", # DS advertiser ID.
      "keywordId": "A String", # DS keyword ID.
      "adId": "A String", # DS ad ID.
    },
    "maxRowsPerFile": 42, # Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.
    "statisticsCurrency": "A String", # Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
    "timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
      "changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.
      "endDate": "A String", # Inclusive date in YYYY-MM-DD format.
      "changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.
      "startDate": "A String", # Inclusive date in YYYY-MM-DD format.
    },
    "startRow": 0, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
    "rowCount": 10000, # Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
    "reportType": "A String", # Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.
    "verifySingleTimeZone": false, # If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
    "filters": [ # A list of filters to be applied to the report.
      {
        "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
          "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
          "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
              # - "sold": returns metrics only for products that were sold
              # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
          "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
          "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
          "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
              # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
          "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
          "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
          "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
          "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
        },
        "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
        "values": [ # A list of values to filter the column value against.
          "",
        ],
      },
    ],
    "downloadFormat": "A String", # Format that the report should be returned in. Currently csv or tsv is supported.
    "includeDeletedEntities": false, # Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
    "columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.
      { # A request object used to create a DoubleClick Search report.
        "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
        "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
            # - "sold": returns metrics only for products that were sold
            # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
        "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
        "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
        "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
            # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
        "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
        "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
        "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
        "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
        "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
      },
    ],
    "includeRemovedEntities": false, # Determines if removed entities should be included in the report. Defaults to false.
  }


Returns:
  An object of the form:

    { # A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files.
    "files": [ # Asynchronous report only. Contains a list of generated report files once the report has succesfully completed.
      {
        "url": "A String", # Use this url to download the report file.
        "byteCount": "A String", # The size of this report file in bytes.
      },
    ],
    "kind": "doubleclicksearch#report", # Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report.
    "rows": [ # Synchronous report only. Generated report rows.
      { # A row in a DoubleClick Search report.
        "a_key": "", # Indicates the columns that are represented in this row. That is, each key corresponds to a column with a non-empty cell in this row.
      },
    ],
    "request": { # A request object used to create a DoubleClick Search report. # The request that created the report. Optional fields not specified in the original request are filled with default values.
        "orderBy": [ # Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
          {
            "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.
              "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
              "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                  # - "sold": returns metrics only for products that were sold
                  # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
              "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
              "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
              "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                  # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
              "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
              "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
              "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
              "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
              "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
            },
            "sortOrder": "A String", # The sort direction, which is either ascending or descending.
          },
        ],
        "reportScope": { # The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
          "adGroupId": "A String", # DS ad group ID.
          "agencyId": "A String", # DS agency ID.
          "engineAccountId": "A String", # DS engine account ID.
          "campaignId": "A String", # DS campaign ID.
          "advertiserId": "A String", # DS advertiser ID.
          "keywordId": "A String", # DS keyword ID.
          "adId": "A String", # DS ad ID.
        },
        "maxRowsPerFile": 42, # Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.
        "statisticsCurrency": "A String", # Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
        "timeRange": { # If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
          "changedMetricsSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.
          "endDate": "A String", # Inclusive date in YYYY-MM-DD format.
          "changedAttributesSinceTimestamp": "A String", # Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.
          "startDate": "A String", # Inclusive date in YYYY-MM-DD format.
        },
        "startRow": 0, # Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
        "rowCount": 10000, # Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.
        "reportType": "A String", # Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.
        "verifySingleTimeZone": false, # If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
        "filters": [ # A list of filters to be applied to the report.
          {
            "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column.
              "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
              "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                  # - "sold": returns metrics only for products that were sold
                  # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
              "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
              "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
              "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                  # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
              "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
              "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
              "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
              "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
              "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
            },
            "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators.
            "values": [ # A list of values to filter the column value against.
              "",
            ],
          },
        ],
        "downloadFormat": "A String", # Format that the report should be returned in. Currently csv or tsv is supported.
        "includeDeletedEntities": false, # Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
        "columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.
          { # A request object used to create a DoubleClick Search report.
            "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false.
            "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are:
                # - "sold": returns metrics only for products that were sold
                # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
            "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.
            "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.
            "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
                # If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.
            "startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.
            "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.
            "columnName": "A String", # Name of a DoubleClick Search column to include in the report.
            "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".
            "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
          },
        ],
        "includeRemovedEntities": false, # Determines if removed entities should be included in the report. Defaults to false.
      },
    "isReportReady": True or False, # Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded.
    "rowCount": 42, # The number of report rows generated by the report, not including headers.
    "statisticsTimeZone": "A String", # If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset.
    "statisticsCurrencyCode": "A String", # The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request.
    "id": "A String", # Asynchronous report only. Id of the report.
  }
google-api-python-client-1.5.5/docs/dyn/doubleclicksearch_v2.savedColumns.html000066400000000000000000000046311300622755700275020ustar00rootroot00000000000000

DoubleClick Search API . savedColumns

Instance Methods

list(agencyId, advertiserId)

Retrieve the list of saved columns for a specified advertiser.

Method Details

list(agencyId, advertiserId) 
Retrieve the list of saved columns for a specified advertiser.

Args:
  agencyId: string, DS ID of the agency. (required)
  advertiserId: string, DS ID of the advertiser. (required)

Returns:
  An object of the form:

    { # A list of saved columns. Advertisers create saved columns to report on Floodlight activities, Google Analytics goals, or custom KPIs. To request reports with saved columns, you'll need the saved column names that are available from this list.
    "items": [ # The saved columns being requested.
      { # A saved column
        "savedColumnName": "A String", # The name of the saved column.
        "kind": "doubleclicksearch#savedColumn", # Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn.
        "type": "A String", # The type of data this saved column will produce.
      },
    ],
    "kind": "doubleclicksearch#savedColumnList", # Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.about.html000066400000000000000000000142371300622755700236170ustar00rootroot00000000000000

Drive API . about

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 public files the user has opened and shared files. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explicitly added to a folder they own.
  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.
    "languageCode": "A String", # The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
    "quotaBytesByService": [ # The amount of storage quota used by different Google services.
      {
        "serviceName": "A String", # The service's name, e.g. DRIVE, GMAIL, or PHOTOS.
        "bytesUsed": "A String", # The storage quota bytes used by the service.
      },
    ],
    "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.
      },
    ],
    "folderColorPalette": [ # The palette of allowable folder colors as RGB hex strings.
      "A String",
    ],
    "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.).
    "permissionId": "A String", # The current user's ID as visible in the permissions collection.
    "etag": "A String", # The ETag of the item.
    "largestChangeId": "A String", # The largest change id.
    "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items.
    "domainSharingPolicy": "A String", # The domain sharing policy for the current user. Possible values are:
        # - allowed
        # - allowedWithWarning
        # - incomingOnly
        # - disallowed
    "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user.
    "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.
      },
    ],
    "user": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "quotaType": "A String", # The type of the user's storage quota. Possible values are:
        # - LIMITED
        # - UNLIMITED
    "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.
      },
    ],
    "kind": "drive#about", # This is always drive#about.
    "name": "A String", # The name of the current user.
    "quotaBytesTotal": "A String", # The total number of quota bytes.
    "remainingChangeIds": "A String", # The number of remaining change ids, limited to no more than 2500.
    "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",
        ],
      },
    ],
    "rootFolderId": "A String", # The id of the root folder.
    "quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive.
    "exportFormats": [ # The allowable export formats.
      {
        "source": "A String", # The content type to convert from.
        "targets": [ # The possible content types to convert to.
          "A String",
        ],
      },
    ],
    "selfLink": "A String", # A link back to this item.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.apps.html000066400000000000000000000216401300622755700234440ustar00rootroot00000000000000

Drive API . apps

Instance Methods

get(appId)

Gets a specific app.

list(languageCode=None, appFilterMimeTypes=None, appFilterExtensions=None)

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.
    "secondaryMimeTypes": [ # The list of secondary mime types.
      "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.
    "productUrl": "A String", # A link to the product listing for this app.
    "shortDescription": "A String", # A short description of the app.
    "id": "A String", # The ID of the app.
    "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
    "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
    "primaryFileExtensions": [ # The list of primary file extensions.
      "A String",
    ],
    "primaryMimeTypes": [ # The list of primary mime types.
      "A String",
    ],
    "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.
      },
    ],
    "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
    "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. See  Open Files  for the full documentation.
    "productId": "A String", # The ID of the product listing for this app.
    "longDescription": "A String", # A long description of the app.
    "supportsCreate": True or False, # Whether this app supports creating new objects.
    "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
    "kind": "drive#app", # This is always drive#app.
    "name": "A String", # The name of the app.
    "createUrl": "A String", # The url to create a new file with this app.
    "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
    "secondaryFileExtensions": [ # The list of secondary file extensions.
      "A String",
    ],
    "supportsImport": True or False, # Whether this app supports importing Google Docs.
    "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
  }
list(languageCode=None, appFilterMimeTypes=None, appFilterExtensions=None) 
Lists a user's installed apps.

Args:
  languageCode: string, A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
  appFilterMimeTypes: string, A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
  appFilterExtensions: string, A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.

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.
        "secondaryMimeTypes": [ # The list of secondary mime types.
          "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.
        "productUrl": "A String", # A link to the product listing for this app.
        "shortDescription": "A String", # A short description of the app.
        "id": "A String", # The ID of the app.
        "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
        "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
        "primaryFileExtensions": [ # The list of primary file extensions.
          "A String",
        ],
        "primaryMimeTypes": [ # The list of primary mime types.
          "A String",
        ],
        "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.
          },
        ],
        "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
        "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. See  Open Files  for the full documentation.
        "productId": "A String", # The ID of the product listing for this app.
        "longDescription": "A String", # A long description of the app.
        "supportsCreate": True or False, # Whether this app supports creating new objects.
        "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
        "kind": "drive#app", # This is always drive#app.
        "name": "A String", # The name of the app.
        "createUrl": "A String", # The url to create a new file with this app.
        "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
        "secondaryFileExtensions": [ # The list of secondary file extensions.
          "A String",
        ],
        "supportsImport": True or False, # Whether this app supports importing Google Docs.
        "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
      },
    ],
    "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.
    "defaultAppIds": [ # List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.changes.html000066400000000000000000001275511300622755700241210ustar00rootroot00000000000000

Drive API . changes

Instance Methods

get(changeId)

Gets a specific change.

list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=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, spaces=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).
      "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
      "appDataContents": True or False, # Whether this file is in the Application Data folder.
      "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
      "labels": { # A group of labels for the file.
        "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
        "hidden": True or False, # Deprecated.
        "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
      },
      "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.
      "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
      "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.
        { # Information about a Drive 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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
      ],
      "ownedByMe": True or False, # Whether the file is owned by the current user.
      "id": "A String", # The ID of the file.
      "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
        "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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
        "width": 42, # The width of the video in pixels.
        "durationMillis": "A String", # The duration of the video in milliseconds.
        "height": 42, # The height of the video in pixels.
      },
      "lastModifyingUser": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "copyable": True or False, # Whether the file can be copied by the current user.
      "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
      "markedViewedByMeDate": "A String", # Deprecated.
      "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.
      "permissions": [ # The list of permissions for users with access to this file.
        { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
          "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
          "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
          "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
          "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.
          "photoLink": "A String", # A link to the profile photo, if available.
        },
      ],
      "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
      "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",
      },
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
      "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.
      "canComment": True or False, # Whether the current user can comment on the file.
      "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
      "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
      "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
      "properties": [ # The list of properties.
        { # A key-value pair attached to a file that is either public or private to an application.
            # The following limits apply to file properties:
            # - Maximum of 100 properties total per file
            # - Maximum of 30 private properties per app
            # - Maximum of 30 public properties
            # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
          "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
      "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 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.
      "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. It should conform to RFC 4648 section 5.
      },
      "downloadUrl": "A String",
      "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
      "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
        "A String",
      ],
      "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
      "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
      "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
      "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
      "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, spaces=None) 
Lists the changes for a user.

Args:
  includeSubscribed: boolean, Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.
  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.
  spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.

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).
          "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
          "appDataContents": True or False, # Whether this file is in the Application Data folder.
          "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
          "labels": { # A group of labels for the file.
            "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
            "hidden": True or False, # Deprecated.
            "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
          },
          "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.
          "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
          "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.
            { # Information about a Drive 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.
              "displayName": "A String", # A plain text displayable name for this user.
              "permissionId": "A String", # The user's ID as visible in the permissions collection.
              "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
              "emailAddress": "A String", # The email address of the user.
            },
          ],
          "ownedByMe": True or False, # Whether the file is owned by the current user.
          "id": "A String", # The ID of the file.
          "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
            "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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
            "width": 42, # The width of the video in pixels.
            "durationMillis": "A String", # The duration of the video in milliseconds.
            "height": 42, # The height of the video in pixels.
          },
          "lastModifyingUser": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "copyable": True or False, # Whether the file can be copied by the current user.
          "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
          "markedViewedByMeDate": "A String", # Deprecated.
          "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.
          "permissions": [ # The list of permissions for users with access to this file.
            { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
              "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
              "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
              "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
              "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.
              "photoLink": "A String", # A link to the profile photo, if available.
            },
          ],
          "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
          "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",
          },
          "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
          "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.
          "canComment": True or False, # Whether the current user can comment on the file.
          "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
          "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
          "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
          "properties": [ # The list of properties.
            { # A key-value pair attached to a file that is either public or private to an application.
                # The following limits apply to file properties:
                # - Maximum of 100 properties total per file
                # - Maximum of 30 private properties per app
                # - Maximum of 30 public properties
                # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
              "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
          "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 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.
          "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. It should conform to RFC 4648 section 5.
          },
          "downloadUrl": "A String",
          "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
            "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
            "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
            "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
            "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.
            "photoLink": "A String", # A link to the profile photo, if available.
          },
          "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
            "A String",
          ],
          "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
          "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
          "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
          "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
          "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, spaces=None) 
Subscribe to changes for a user.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  includeSubscribed: boolean, Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.
  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.
  spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/drive_v2.channels.html000066400000000000000000000052351300622755700242760ustar00rootroot00000000000000

Drive API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.children.html000066400000000000000000000131651300622755700242740ustar00rootroot00000000000000

Drive API . children

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, orderBy=None, 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, orderBy=None, q=None, pageToken=None, maxResults=None) 
Lists a folder's children.

Args:
  folderId: string, The ID of the folder. (required)
  orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
  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.
google-api-python-client-1.5.5/docs/dyn/drive_v2.comments.html000066400000000000000000001205521300622755700243300ustar00rootroot00000000000000

Drive API . comments

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 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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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 comment on a file in Google Drive.
          "kind": "drive#commentReply", # This is always drive#commentReply.
          "author": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "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 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": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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 comment on a file in Google Drive.
        "kind": "drive#commentReply", # This is always drive#commentReply.
        "author": { # Information about a Drive 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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
        "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 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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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 comment on a file in Google Drive.
          "kind": "drive#commentReply", # This is always drive#commentReply.
          "author": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "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 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 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": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "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 comment on a file in Google Drive.
              "kind": "drive#commentReply", # This is always drive#commentReply.
              "author": { # Information about a Drive 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.
                "displayName": "A String", # A plain text displayable name for this user.
                "permissionId": "A String", # The user's ID as visible in the permissions collection.
                "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
                "emailAddress": "A String", # The email address of the user.
              },
              "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 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": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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 comment on a file in Google Drive.
        "kind": "drive#commentReply", # This is always drive#commentReply.
        "author": { # Information about a Drive 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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
        "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 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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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 comment on a file in Google Drive.
          "kind": "drive#commentReply", # This is always drive#commentReply.
          "author": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "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 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": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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 comment on a file in Google Drive.
        "kind": "drive#commentReply", # This is always drive#commentReply.
        "author": { # Information about a Drive 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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
        "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 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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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 comment on a file in Google Drive.
          "kind": "drive#commentReply", # This is always drive#commentReply.
          "author": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "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.
    }
google-api-python-client-1.5.5/docs/dyn/drive_v2.files.html000066400000000000000000007515521300622755700236170ustar00rootroot00000000000000

Drive API . files

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. The currently authenticated user must own the file.

emptyTrash()

Permanently deletes all of the user's trashed files.

export(fileId, mimeType)

Exports a Google Doc to the requested MIME type and returns the exported content.

export_media(fileId, mimeType)

Exports a Google Doc to the requested MIME type and returns the exported content.

generateIds(space=None, maxResults=None)

Generates a set of file IDs which can be provided in insert requests.

get(fileId, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)

Gets a file's metadata by ID.

get_media(fileId, projection=None, revisionId=None, acknowledgeAbuse=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(orderBy=None, q=None, projection=None, pageToken=None, maxResults=None, spaces=None, corpus=None)

Lists the user's files.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(fileId, body, newRevision=None, modifiedDateBehavior=None, pinned=None, ocrLanguage=None, ocr=None, addParents=None, removeParents=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. The currently authenticated user must own the file.

untrash(fileId)

Restores a file from the trash.

update(fileId, body=None, newRevision=None, modifiedDateBehavior=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)

Updates file metadata and/or content.

watch(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=None, updateViewedDate=None)

Subscribe to changes on a file

watch_media(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=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).
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
  "appDataContents": True or False, # Whether this file is in the Application Data folder.
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
  "labels": { # A group of labels for the file.
    "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
    "hidden": True or False, # Deprecated.
    "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
  },
  "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.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "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.
    { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
  ],
  "ownedByMe": True or False, # Whether the file is owned by the current user.
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
    "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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "copyable": True or False, # Whether the file can be copied by the current user.
  "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
  "markedViewedByMeDate": "A String", # Deprecated.
  "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.
  "permissions": [ # The list of permissions for users with access to this file.
    { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
  ],
  "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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",
  },
  "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
  "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.
  "canComment": True or False, # Whether the current user can comment on the file.
  "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
  "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
  "properties": [ # The list of properties.
    { # A key-value pair attached to a file that is either public or private to an application.
        # The following limits apply to file properties:
        # - Maximum of 100 properties total per file
        # - Maximum of 30 private properties per app
        # - Maximum of 30 public properties
        # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
      "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 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.
  "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. It should conform to RFC 4648 section 5.
  },
  "downloadUrl": "A String",
  "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  },
  "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
  "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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. A file can have a maximum of 200 pinned revisions.
  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 BCP 47 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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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. The currently authenticated user must own the file.

Args:
  fileId: string, The ID of the file to delete. (required)
emptyTrash() 
Permanently deletes all of the user's trashed files.

Args:
export(fileId, mimeType) 
Exports a Google Doc to the requested MIME type and returns the exported content.

Args:
  fileId: string, The ID of the file. (required)
  mimeType: string, The MIME type of the format requested for this export. (required)
export_media(fileId, mimeType) 
Exports a Google Doc to the requested MIME type and returns the exported content.

Args:
  fileId: string, The ID of the file. (required)
  mimeType: string, The MIME type of the format requested for this export. (required)
generateIds(space=None, maxResults=None) 
Generates a set of file IDs which can be provided in insert requests.

Args:
  space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
  maxResults: integer, Maximum number of IDs to return.

Returns:
  An object of the form:

    { # A list of generated IDs which can be provided in insert requests
    "kind": "drive#generatedIds", # This is always drive#generatedIds
    "ids": [ # The IDs generated for the requesting user in the specified space.
      "A String",
    ],
    "space": "A String", # The type of file that can be created with these IDs.
  }
get(fileId, projection=None, revisionId=None, acknowledgeAbuse=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
  revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
  updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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.
  }
get_media(fileId, projection=None, revisionId=None, acknowledgeAbuse=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
  revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
  updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Returns:
  The media object as a string.
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).
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
  "appDataContents": True or False, # Whether this file is in the Application Data folder.
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
  "labels": { # A group of labels for the file.
    "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
    "hidden": True or False, # Deprecated.
    "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
  },
  "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.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "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.
    { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
  ],
  "ownedByMe": True or False, # Whether the file is owned by the current user.
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
    "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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "copyable": True or False, # Whether the file can be copied by the current user.
  "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
  "markedViewedByMeDate": "A String", # Deprecated.
  "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.
  "permissions": [ # The list of permissions for users with access to this file.
    { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
  ],
  "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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",
  },
  "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
  "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.
  "canComment": True or False, # Whether the current user can comment on the file.
  "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
  "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
  "properties": [ # The list of properties.
    { # A key-value pair attached to a file that is either public or private to an application.
        # The following limits apply to file properties:
        # - Maximum of 100 properties total per file
        # - Maximum of 30 private properties per app
        # - Maximum of 30 public properties
        # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
      "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 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.
  "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. It should conform to RFC 4648 section 5.
  },
  "downloadUrl": "A String",
  "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  },
  "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
  "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 BCP 47 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. A file can have a maximum of 200 pinned revisions.

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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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(orderBy=None, q=None, projection=None, pageToken=None, maxResults=None, spaces=None, corpus=None) 
Lists the user's files.

Args:
  orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
  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.
  spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
  corpus: string, The body of items (files/documents) to which the query applies.
    Allowed values
      DEFAULT - The items that the user has accessed.
      DOMAIN - Items shared to the user's domain.

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).
        "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
        "appDataContents": True or False, # Whether this file is in the Application Data folder.
        "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
        "labels": { # A group of labels for the file.
          "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
          "hidden": True or False, # Deprecated.
          "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
        },
        "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.
        "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
        "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.
          { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
        ],
        "ownedByMe": True or False, # Whether the file is owned by the current user.
        "id": "A String", # The ID of the file.
        "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
          "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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
        "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
          "width": 42, # The width of the video in pixels.
          "durationMillis": "A String", # The duration of the video in milliseconds.
          "height": 42, # The height of the video in pixels.
        },
        "lastModifyingUser": { # Information about a Drive 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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
        "copyable": True or False, # Whether the file can be copied by the current user.
        "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
        "markedViewedByMeDate": "A String", # Deprecated.
        "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.
        "permissions": [ # The list of permissions for users with access to this file.
          { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
            "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
            "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
            "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
            "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.
            "photoLink": "A String", # A link to the profile photo, if available.
          },
        ],
        "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
        "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",
        },
        "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
        "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.
        "canComment": True or False, # Whether the current user can comment on the file.
        "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
        "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
        "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
        "properties": [ # The list of properties.
          { # A key-value pair attached to a file that is either public or private to an application.
              # The following limits apply to file properties:
              # - Maximum of 100 properties total per file
              # - Maximum of 30 private properties per app
              # - Maximum of 30 public properties
              # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
            "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
        "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 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.
        "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. It should conform to RFC 4648 section 5.
        },
        "downloadUrl": "A String",
        "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
          "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
          "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
          "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
          "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.
          "photoLink": "A String", # A link to the profile photo, if available.
        },
        "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
          "A String",
        ],
        "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
        "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
        "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
        "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
        "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, modifiedDateBehavior=None, pinned=None, ocrLanguage=None, ocr=None, addParents=None, removeParents=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).
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
  "appDataContents": True or False, # Whether this file is in the Application Data folder.
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
  "labels": { # A group of labels for the file.
    "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
    "hidden": True or False, # Deprecated.
    "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
  },
  "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.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "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.
    { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
  ],
  "ownedByMe": True or False, # Whether the file is owned by the current user.
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
    "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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "copyable": True or False, # Whether the file can be copied by the current user.
  "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
  "markedViewedByMeDate": "A String", # Deprecated.
  "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.
  "permissions": [ # The list of permissions for users with access to this file.
    { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
  ],
  "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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",
  },
  "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
  "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.
  "canComment": True or False, # Whether the current user can comment on the file.
  "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
  "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
  "properties": [ # The list of properties.
    { # A key-value pair attached to a file that is either public or private to an application.
        # The following limits apply to file properties:
        # - Maximum of 100 properties total per file
        # - Maximum of 30 private properties per app
        # - Maximum of 30 public properties
        # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
      "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 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.
  "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. It should conform to RFC 4648 section 5.
  },
  "downloadUrl": "A String",
  "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  },
  "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
  "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
  modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
    Allowed values
      fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
      fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
      fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
      noChange - Maintain the previous value of modifiedDate.
      now - Set modifiedDate to the current time.
      nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
  pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
  ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
  ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
  addParents: string, Comma-separated list of parent IDs to add.
  removeParents: string, Comma-separated list of parent IDs to remove.
  updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
  timedTextTrackName: string, The timed text track name.
  convert: boolean, This parameter is deprecated and has no function.
  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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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. The currently authenticated user must own the file.

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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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, modifiedDateBehavior=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, addParents=None, removeParents=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).
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
  "appDataContents": True or False, # Whether this file is in the Application Data folder.
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
  "labels": { # A group of labels for the file.
    "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
    "hidden": True or False, # Deprecated.
    "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
  },
  "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.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "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.
    { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
  ],
  "ownedByMe": True or False, # Whether the file is owned by the current user.
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
    "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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "copyable": True or False, # Whether the file can be copied by the current user.
  "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
  "markedViewedByMeDate": "A String", # Deprecated.
  "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.
  "permissions": [ # The list of permissions for users with access to this file.
    { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
  ],
  "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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",
  },
  "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
  "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.
  "canComment": True or False, # Whether the current user can comment on the file.
  "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
  "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
  "properties": [ # The list of properties.
    { # A key-value pair attached to a file that is either public or private to an application.
        # The following limits apply to file properties:
        # - Maximum of 100 properties total per file
        # - Maximum of 30 private properties per app
        # - Maximum of 30 public properties
        # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
      "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 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.
  "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. It should conform to RFC 4648 section 5.
  },
  "downloadUrl": "A String",
  "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  },
  "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
  "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
  "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 false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
  modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
    Allowed values
      fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
      fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
      fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
      noChange - Maintain the previous value of modifiedDate.
      now - Set modifiedDate to the current time.
      nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
  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 BCP 47 codes.
  ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
  pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
  addParents: string, Comma-separated list of parent IDs to add.
  removeParents: string, Comma-separated list of parent IDs to remove.
  updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
  timedTextTrackName: string, The timed text track name.
  convert: boolean, This parameter is deprecated and has no function.
  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).
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
    "appDataContents": True or False, # Whether this file is in the Application Data folder.
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
    "labels": { # A group of labels for the file.
      "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
      "hidden": True or False, # Deprecated.
      "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. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
    },
    "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.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "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.
      { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
    ],
    "ownedByMe": True or False, # Whether the file is owned by the current user.
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
      "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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "copyable": True or False, # Whether the file can be copied by the current user.
    "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
    "markedViewedByMeDate": "A String", # Deprecated.
    "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.
    "permissions": [ # The list of permissions for users with access to this file.
      { # 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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",
    },
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "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.
    "canComment": True or False, # Whether the current user can comment on the file.
    "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
    "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
    "properties": [ # The list of properties.
      { # A key-value pair attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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 field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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 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.
    "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. It should conform to RFC 4648 section 5.
    },
    "downloadUrl": "A String",
    "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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
      "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
      "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "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.
      "photoLink": "A String", # A link to the profile photo, if available.
    },
    "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
    "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
    "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, revisionId=None, acknowledgeAbuse=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:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  projection: string, This parameter is deprecated and has no function.
    Allowed values
      BASIC - Deprecated
      FULL - Deprecated
  revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
  updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
watch_media(fileId, body, projection=None, revisionId=None, acknowledgeAbuse=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:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  projection: string, This parameter is deprecated and has no function.
    Allowed values
      BASIC - Deprecated
      FULL - Deprecated
  revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
  updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Returns:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/drive_v2.html000066400000000000000000000074531300622755700225100ustar00rootroot00000000000000

Drive API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/drive_v2.parents.html000066400000000000000000000105121300622755700241510ustar00rootroot00000000000000

Drive API . parents

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.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.permissions.html000066400000000000000000000526341300622755700250630ustar00rootroot00000000000000

Drive API . permissions

Instance Methods

delete(fileId, permissionId)

Deletes a permission from a file.

get(fileId, permissionId)

Gets a permission by ID.

getIdForEmail(email)

Returns the permission ID for an email address.

insert(fileId, body, sendNotificationEmails=None, emailMessage=None)

Inserts a permission for a file.

list(fileId)

Lists a file's permissions.

patch(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)

Updates a permission using patch semantics.

update(fileId, permissionId, body, removeExpiration=None, 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  }
getIdForEmail(email) 
Returns the permission ID for an email address.

Args:
  email: string, The email address for which to return a permission ID (required)

Returns:
  An object of the form:

    { # An ID for a user or group as seen in Permission items.
    "kind": "drive#permissionId", # This is always drive#permissionId.
    "id": "A String", # The permission ID.
  }
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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
  "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
  "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
  "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
  "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.
  "photoLink": "A String", # A link to the profile photo, if available.
}

  sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
  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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  }
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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
        "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
        "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "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.
        "photoLink": "A String", # A link to the profile photo, if available.
      },
    ],
    "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, removeExpiration=None, transferOwnership=None) 
Updates a permission using 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
  "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
  "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
  "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
  "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.
  "photoLink": "A String", # A link to the profile photo, if available.
}

  removeExpiration: boolean, Whether to remove the expiration date.
  transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  }
update(fileId, permissionId, body, removeExpiration=None, 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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
  "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
  "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
  "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
  "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.
  "photoLink": "A String", # A link to the profile photo, if available.
}

  removeExpiration: boolean, Whether to remove the expiration date.
  transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

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 present 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. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
    "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 or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "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.
    "photoLink": "A String", # A link to the profile photo, if available.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.properties.html000066400000000000000000000246531300622755700247040ustar00rootroot00000000000000

Drive API . properties

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, or updates it if it already exists.

list(fileId)

Lists a file's properties.

patch(fileId, propertyKey, body, visibility=None)

Updates a property, or adds it if it doesn't exist. This method supports patch semantics.

update(fileId, propertyKey, body, visibility=None)

Updates a property, or adds it if it doesn't exist.

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 attached to a file that is either public or private to an application.
      # The following limits apply to file properties:
      # - Maximum of 100 properties total per file
      # - Maximum of 30 private properties per app
      # - Maximum of 30 public properties
      # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
    "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, or updates it if it already exists.

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 attached to a file that is either public or private to an application.
    # The following limits apply to file properties:
    # - Maximum of 100 properties total per file
    # - Maximum of 30 private properties per app
    # - Maximum of 30 public properties
    # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
  "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 attached to a file that is either public or private to an application.
      # The following limits apply to file properties:
      # - Maximum of 100 properties total per file
      # - Maximum of 30 private properties per app
      # - Maximum of 30 public properties
      # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
    "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 attached to a file that is either public or private to an application.
          # The following limits apply to file properties:
          # - Maximum of 100 properties total per file
          # - Maximum of 30 private properties per app
          # - Maximum of 30 public properties
          # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
        "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, or adds it if it doesn't exist. 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 attached to a file that is either public or private to an application.
    # The following limits apply to file properties:
    # - Maximum of 100 properties total per file
    # - Maximum of 30 private properties per app
    # - Maximum of 30 public properties
    # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
  "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 attached to a file that is either public or private to an application.
      # The following limits apply to file properties:
      # - Maximum of 100 properties total per file
      # - Maximum of 30 private properties per app
      # - Maximum of 30 public properties
      # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
    "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, or adds it if it doesn't exist.

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 attached to a file that is either public or private to an application.
    # The following limits apply to file properties:
    # - Maximum of 100 properties total per file
    # - Maximum of 30 private properties per app
    # - Maximum of 30 public properties
    # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
  "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 attached to a file that is either public or private to an application.
      # The following limits apply to file properties:
      # - Maximum of 100 properties total per file
      # - Maximum of 30 private properties per app
      # - Maximum of 30 public properties
      # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.realtime.html000066400000000000000000000070611300622755700243040ustar00rootroot00000000000000

Drive API . realtime

Instance Methods

get(fileId, revision=None)

Exports the contents of the Realtime API data model associated with this file as JSON.

get_media(fileId, revision=None)

Exports the contents of the Realtime API data model associated with this file as JSON.

update(fileId, media_body=None, baseRevision=None)

Overwrites the Realtime API data model associated with this file with the provided JSON data model.

Method Details

get(fileId, revision=None) 
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)
  revision: integer, The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned.
get_media(fileId, revision=None) 
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)
  revision: integer, The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned.
update(fileId, media_body=None, baseRevision=None) 
Overwrites the Realtime API data model associated with this file with the provided JSON data model.

Args:
  fileId: string, The ID of the file that the Realtime API data model is associated with. (required)
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  baseRevision: string, The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server.
google-api-python-client-1.5.5/docs/dyn/drive_v2.replies.html000066400000000000000000000472761300622755700241610ustar00rootroot00000000000000

Drive API . replies

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 comment on a file in Google Drive.
    "kind": "drive#commentReply", # This is always drive#commentReply.
    "author": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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 comment on a file in Google Drive.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "author": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "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 comment on a file in Google Drive.
    "kind": "drive#commentReply", # This is always drive#commentReply.
    "author": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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 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 comment on a file in Google Drive.
        "kind": "drive#commentReply", # This is always drive#commentReply.
        "author": { # Information about a Drive 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.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in the permissions collection.
          "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
          "emailAddress": "A String", # The email address of the user.
        },
        "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 comment on a file in Google Drive.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "author": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "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 comment on a file in Google Drive.
    "kind": "drive#commentReply", # This is always drive#commentReply.
    "author": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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 comment on a file in Google Drive.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "author": { # Information about a Drive 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.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "emailAddress": "A String", # The email address of the user.
  },
  "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 comment on a file in Google Drive.
    "kind": "drive#commentReply", # This is always drive#commentReply.
    "author": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v2.revisions.html000066400000000000000000000527311300622755700245270ustar00rootroot00000000000000

Drive API . revisions

Instance Methods

delete(fileId, revisionId)

Removes a revision.

get(fileId, revisionId)

Gets a specific revision.

list(fileId, pageToken=None, maxResults=None)

Lists a file's revisions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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, pageToken=None, maxResults=None) 
Lists a file's revisions.

Args:
  fileId: string, The ID of the file. (required)
  pageToken: string, Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
  maxResults: integer, Maximum number of revisions to return.

Returns:
  An object of the form:

    { # A list of revisions of a file.
    "nextPageToken": "A String", # The page token for the next page of revisions. This field will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded and pagination should be restarted from the first page of results.
    "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": { # Information about a Drive 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.
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in the permissions collection.
            "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
            "emailAddress": "A String", # The email address of the user.
          },
          "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.
  }
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, 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": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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": { # Information about a Drive 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.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in the permissions collection.
      "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
      "emailAddress": "A String", # The email address of the user.
    },
    "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": { # Information about a Drive 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.
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "emailAddress": "A String", # The email address of the user.
      },
      "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).
    }
google-api-python-client-1.5.5/docs/dyn/drive_v3.about.html000066400000000000000000000066501300622755700236200ustar00rootroot00000000000000

Drive API . about

Instance Methods

get()

Gets information about the user, the user's Drive, and system capabilities.

Method Details

get() 
Gets information about the user, the user's Drive, and system capabilities.

Args:

Returns:
  An object of the form:

    { # Information about the user, the user's Drive, and system capabilities.
    "kind": "drive#about", # Identifies what kind of resource this is. Value: the fixed string "drive#about".
    "maxUploadSize": "A String", # The maximum upload size in bytes.
    "maxImportSizes": { # A map of maximum import sizes by MIME type, in bytes.
      "a_key": "A String",
    },
    "storageQuota": { # The user's storage quota limits and usage. All fields are measured in bytes.
      "usage": "A String", # The total usage across all services.
      "usageInDrive": "A String", # The usage by all files in Google Drive.
      "usageInDriveTrash": "A String", # The usage by trashed files in Google Drive.
      "limit": "A String", # The usage limit, if applicable. This will not be present if the user has unlimited storage.
    },
    "importFormats": { # A map of source MIME type to possible targets for all supported imports.
      "a_key": [
        "A String",
      ],
    },
    "appInstalled": True or False, # Whether the user has installed the requesting app.
    "folderColorPalette": [ # The currently supported folder colors as RGB hex strings.
      "A String",
    ],
    "exportFormats": { # A map of source MIME type to possible targets for all supported exports.
      "a_key": [
        "A String",
      ],
    },
    "user": { # Information about a Drive user. # The authenticated user.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
  }
google-api-python-client-1.5.5/docs/dyn/drive_v3.changes.html000066400000000000000000000533571300622755700241240ustar00rootroot00000000000000

Drive API . changes

Instance Methods

getStartPageToken()

Gets the starting pageToken for listing future changes.

list(pageToken, restrictToMyDrive=None, spaces=None, pageSize=None, includeRemoved=None)

Lists changes for a user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

watch(pageToken, body, pageSize=None, restrictToMyDrive=None, spaces=None, includeRemoved=None)

Subscribes to changes for a user.

Method Details

getStartPageToken() 
Gets the starting pageToken for listing future changes.

Args:

Returns:
  An object of the form:

    {
    "kind": "drive#startPageToken", # Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
    "startPageToken": "A String", # The starting page token for listing changes.
  }
list(pageToken, restrictToMyDrive=None, spaces=None, pageSize=None, includeRemoved=None) 
Lists changes for a user.

Args:
  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. (required)
  restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
  spaces: string, A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
  pageSize: integer, The maximum number of changes to return per page.
  includeRemoved: boolean, Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access.

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. This will be absent if the end of the current changes list has been reached.
    "kind": "drive#changeList", # Identifies what kind of resource this is. Value: the fixed string "drive#changeList".
    "changes": [ # The page of changes.
      { # A change to a file.
        "kind": "drive#change", # Identifies what kind of resource this is. Value: the fixed string "drive#change".
        "removed": True or False, # Whether the file has been removed from the view of the changes list, for example by deletion or lost access.
        "time": "A String", # The time of this change (RFC 3339 date-time).
        "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been removed.
          "mimeType": "A String", # The MIME type of the file.
              # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
              # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
          "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
          "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
          "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
          "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
          "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
          "ownedByMe": True or False, # Whether the user owns the file.
          "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
          "id": "A String", # The ID of the file.
          "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
          "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
            "width": 42, # The width of the video in pixels.
            "durationMillis": "A String", # The duration of the video in milliseconds.
            "height": 42, # The height of the video in pixels.
          },
          "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
              # If an unsupported color is specified, the closest color in the palette will be used instead.
          "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
              # Entries with null values are cleared in update and copy requests.
            "a_key": "A String",
          },
          "capabilities": { # Capabilities the current user has on the file.
            "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
            "canCopy": True or False, # Whether the user can copy the file.
            "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
            "canEdit": True or False, # Whether the user can edit the file's content.
            "canComment": True or False, # Whether the user can comment on the file.
          },
          "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
          "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
          "parents": [ # The IDs of the parent folders which contain the file.
              # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
            "A String",
          ],
          "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
          "shared": True or False, # Whether the file has been shared.
          "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
            { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
              "domain": "A String", # The domain to which this permission refers.
              "displayName": "A String", # A displayable name for users, groups or domains.
              "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
              "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
              "emailAddress": "A String", # The email address of the user or group to which this permission refers.
              "photoLink": "A String", # A link to the user's profile photo, if available.
              "role": "A String", # The role granted by this permission. Valid values are:
                  # - owner
                  # - writer
                  # - commenter
                  # - reader
              "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
              "type": "A String", # The type of the grantee. Valid values are:
                  # - user
                  # - group
                  # - domain
                  # - anyone
              "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
            },
          ],
          "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
              # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
          "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
          "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
          "description": "A String", # A short description of the file.
          "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
              # Note that setting modifiedTime will also update modifiedByMeTime for the user.
          "viewedByMe": True or False, # Whether the file has been viewed by this user.
          "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
            { # Information about a Drive user.
              "me": True or False, # Whether this user is the requesting user.
              "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
              "displayName": "A String", # A plain text displayable name for this user.
              "permissionId": "A String", # The user's ID as visible in Permission resources.
              "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
              "photoLink": "A String", # A link to the user's profile photo, if available.
            },
          ],
          "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
          "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
          "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
              # Entries with null values are cleared in update and copy requests.
            "a_key": "A String",
          },
          "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
          "iconLink": "A String", # A static, unauthenticated link to the file's icon.
          "imageMediaMetadata": { # Additional metadata about image media, if available.
            "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).
            "width": 42, # The width of the image in pixels.
            "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.
            "isoSpeed": 42, # The ISO speed used to create the photo.
            "meteringMode": "A String", # The metering mode used to create the photo.
            "flashUsed": True or False, # Whether a flash was used to create the photo.
            "time": "A String", # The date and time the photo was taken (EXIF DateTime).
            "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.
          },
          "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
          "name": "A String", # The name of the file. This is not necessarily unique within a folder.
          "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
          "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
            "A String",
          ],
          "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
          "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
            "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
            "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
              "mimeType": "A String", # The MIME type of the thumbnail.
              "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
            },
          },
          "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
          "starred": True or False, # Whether the user has starred the file.
          "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
        },
        "fileId": "A String", # The ID of the file which has changed.
      },
    ],
    "newStartPageToken": "A String", # The starting page token for future changes. This will be present only if the end of the current changes list has been reached.
  }
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(pageToken, body, pageSize=None, restrictToMyDrive=None, spaces=None, includeRemoved=None) 
Subscribes to changes for a user.

Args:
  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  pageSize: integer, The maximum number of changes to return per page.
  restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
  spaces: string, A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
  includeRemoved: boolean, Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access.

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/drive_v3.channels.html000066400000000000000000000052351300622755700242770ustar00rootroot00000000000000

Drive API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v3.comments.html000066400000000000000000000702721300622755700243340ustar00rootroot00000000000000

Drive API . comments

Instance Methods

create(fileId, body)

Creates a new comment on a file.

delete(fileId, commentId)

Deletes a comment.

get(fileId, commentId, includeDeleted=None)

Gets a comment by ID.

list(fileId, includeDeleted=None, pageToken=None, startModifiedTime=None, pageSize=None)

Lists a file's comments.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(fileId, commentId, body)

Updates a comment with patch semantics.

Method Details

create(fileId, body) 
Creates a new comment on a file.

Args:
  fileId: string, The ID of the file. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A comment on a file.
    "resolved": True or False, # Whether the comment has been resolved by one of its replies.
    "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
    "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
    "author": { # Information about a Drive user. # The user who created the comment.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
    "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
      "mimeType": "A String", # The MIME type of the quoted content.
      "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
    },
    "htmlContent": "A String", # The content of the comment with HTML formatting.
    "id": "A String", # The ID of the comment.
    "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
    "replies": [ # The full list of replies to the comment in chronological order.
      { # A reply to a comment on a file.
        "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
        "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
        "author": { # Information about a Drive user. # The user who created the reply.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
        "htmlContent": "A String", # The content of the reply with HTML formatting.
        "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
        "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
        "action": "A String", # The action the reply performed to the parent comment. Valid values are:
            # - resolve
            # - reopen
        "id": "A String", # The ID of the reply.
      },
    ],
    "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
    "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.
  }


Returns:
  An object of the form:

    { # A comment on a file.
      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
      "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
      "author": { # Information about a Drive user. # The user who created the comment.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
      "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
        "mimeType": "A String", # The MIME type of the quoted content.
        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
      },
      "htmlContent": "A String", # The content of the comment with HTML formatting.
      "id": "A String", # The ID of the comment.
      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
      "replies": [ # The full list of replies to the comment in chronological order.
        { # A reply to a comment on a file.
          "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
          "author": { # Information about a Drive user. # The user who created the reply.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
          "htmlContent": "A String", # The content of the reply with HTML formatting.
          "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
              # - resolve
              # - reopen
          "id": "A String", # The ID of the reply.
        },
      ],
      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
      "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.
    }
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, Whether to return deleted comments. Deleted comments will not include their original content.

Returns:
  An object of the form:

    { # A comment on a file.
      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
      "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
      "author": { # Information about a Drive user. # The user who created the comment.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
      "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
        "mimeType": "A String", # The MIME type of the quoted content.
        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
      },
      "htmlContent": "A String", # The content of the comment with HTML formatting.
      "id": "A String", # The ID of the comment.
      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
      "replies": [ # The full list of replies to the comment in chronological order.
        { # A reply to a comment on a file.
          "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
          "author": { # Information about a Drive user. # The user who created the reply.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
          "htmlContent": "A String", # The content of the reply with HTML formatting.
          "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
              # - resolve
              # - reopen
          "id": "A String", # The ID of the reply.
        },
      ],
      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
      "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.
    }
list(fileId, includeDeleted=None, pageToken=None, startModifiedTime=None, pageSize=None) 
Lists a file's comments.

Args:
  fileId: string, The ID of the file. (required)
  includeDeleted: boolean, Whether to include deleted comments. Deleted comments will not include their original content.
  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  startModifiedTime: string, The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
  pageSize: integer, The maximum number of comments to return per page.

Returns:
  An object of the form:

    { # A list of comments on a file.
    "nextPageToken": "A String", # The page token for the next page of comments. This will be absent if the end of the comments list has been reached.
    "kind": "drive#commentList", # Identifies what kind of resource this is. Value: the fixed string "drive#commentList".
    "comments": [ # The page of comments.
      { # A comment on a file.
          "resolved": True or False, # Whether the comment has been resolved by one of its replies.
          "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
          "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
          "author": { # Information about a Drive user. # The user who created the comment.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
          "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
            "mimeType": "A String", # The MIME type of the quoted content.
            "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
          },
          "htmlContent": "A String", # The content of the comment with HTML formatting.
          "id": "A String", # The ID of the comment.
          "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
          "replies": [ # The full list of replies to the comment in chronological order.
            { # A reply to a comment on a file.
              "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
              "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
              "author": { # Information about a Drive user. # The user who created the reply.
                "me": True or False, # Whether this user is the requesting user.
                "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
                "displayName": "A String", # A plain text displayable name for this user.
                "permissionId": "A String", # The user's ID as visible in Permission resources.
                "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
                "photoLink": "A String", # A link to the user's profile photo, if available.
              },
              "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
              "htmlContent": "A String", # The content of the reply with HTML formatting.
              "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
              "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
              "action": "A String", # The action the reply performed to the parent comment. Valid values are:
                  # - resolve
                  # - reopen
              "id": "A String", # The ID of the reply.
            },
          ],
          "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
          "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.
        },
    ],
  }
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(fileId, commentId, body) 
Updates a comment with 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 comment on a file.
    "resolved": True or False, # Whether the comment has been resolved by one of its replies.
    "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
    "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
    "author": { # Information about a Drive user. # The user who created the comment.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
    "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
      "mimeType": "A String", # The MIME type of the quoted content.
      "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
    },
    "htmlContent": "A String", # The content of the comment with HTML formatting.
    "id": "A String", # The ID of the comment.
    "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
    "replies": [ # The full list of replies to the comment in chronological order.
      { # A reply to a comment on a file.
        "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
        "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
        "author": { # Information about a Drive user. # The user who created the reply.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
        "htmlContent": "A String", # The content of the reply with HTML formatting.
        "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
        "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
        "action": "A String", # The action the reply performed to the parent comment. Valid values are:
            # - resolve
            # - reopen
        "id": "A String", # The ID of the reply.
      },
    ],
    "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
    "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.
  }


Returns:
  An object of the form:

    { # A comment on a file.
      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
      "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
      "author": { # Information about a Drive user. # The user who created the comment.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
      "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
        "mimeType": "A String", # The MIME type of the quoted content.
        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
      },
      "htmlContent": "A String", # The content of the comment with HTML formatting.
      "id": "A String", # The ID of the comment.
      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
      "replies": [ # The full list of replies to the comment in chronological order.
        { # A reply to a comment on a file.
          "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
          "author": { # Information about a Drive user. # The user who created the reply.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
          "htmlContent": "A String", # The content of the reply with HTML formatting.
          "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
              # - resolve
              # - reopen
          "id": "A String", # The ID of the reply.
        },
      ],
      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
      "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.
    }
google-api-python-client-1.5.5/docs/dyn/drive_v3.files.html000066400000000000000000003475731300622755700236240ustar00rootroot00000000000000

Drive API . files

Instance Methods

copy(fileId, body, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None)

Creates a copy of a file and applies any requested updates with patch semantics.

create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, ignoreDefaultVisibility=None, ocrLanguage=None)

Creates a new file.

delete(fileId)

Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.

emptyTrash()

Permanently deletes all of the user's trashed files.

export(fileId, mimeType)

Exports a Google Doc to the requested MIME type and returns the exported content.

export_media(fileId, mimeType)

Exports a Google Doc to the requested MIME type and returns the exported content.

generateIds(count=None, space=None)

Generates a set of file IDs which can be provided in create requests.

get(fileId, acknowledgeAbuse=None)

Gets a file's metadata or content by ID.

get_media(fileId, acknowledgeAbuse=None)

Gets a file's metadata or content by ID.

list(orderBy=None, q=None, pageSize=None, pageToken=None, spaces=None, corpus=None)

Lists or searches files.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(fileId, body=None, media_body=None, addParents=None, removeParents=None, useContentAsIndexableText=None, keepRevisionForever=None, ocrLanguage=None)

Updates a file's metadata and/or content with patch semantics.

watch(fileId, body, acknowledgeAbuse=None)

Subscribes to changes to a file

watch_media(fileId, body, acknowledgeAbuse=None)

Subscribes to changes to a file

Method Details

copy(fileId, body, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None) 
Creates a copy of a file and applies any requested updates with patch semantics.

Args:
  fileId: string, The ID of the file. (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.
      # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
      # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
  "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
  "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
  "ownedByMe": True or False, # Whether the user owns the file.
  "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
  "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
      # If an unsupported color is specified, the closest color in the palette will be used instead.
  "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
      # Entries with null values are cleared in update and copy requests.
    "a_key": "A String",
  },
  "capabilities": { # Capabilities the current user has on the file.
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "canCopy": True or False, # Whether the user can copy the file.
    "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
    "canEdit": True or False, # Whether the user can edit the file's content.
    "canComment": True or False, # Whether the user can comment on the file.
  },
  "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
  "parents": [ # The IDs of the parent folders which contain the file.
      # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
    "A String",
  ],
  "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
  "shared": True or False, # Whether the file has been shared.
  "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
      "domain": "A String", # The domain to which this permission refers.
      "displayName": "A String", # A displayable name for users, groups or domains.
      "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
      "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
      "emailAddress": "A String", # The email address of the user or group to which this permission refers.
      "photoLink": "A String", # A link to the user's profile photo, if available.
      "role": "A String", # The role granted by this permission. Valid values are:
          # - owner
          # - writer
          # - commenter
          # - reader
      "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "type": "A String", # The type of the grantee. Valid values are:
          # - user
          # - group
          # - domain
          # - anyone
      "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
    },
  ],
  "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
      # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
  "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
  "description": "A String", # A short description of the file.
  "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
      # Note that setting modifiedTime will also update modifiedByMeTime for the user.
  "viewedByMe": True or False, # Whether the file has been viewed by this user.
  "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
    { # Information about a Drive user.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
  ],
  "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
  "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
  "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
      # Entries with null values are cleared in update and copy requests.
    "a_key": "A String",
  },
  "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
  "iconLink": "A String", # A static, unauthenticated link to the file's icon.
  "imageMediaMetadata": { # Additional metadata about image media, if available.
    "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).
    "width": 42, # The width of the image in pixels.
    "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.
    "isoSpeed": 42, # The ISO speed used to create the photo.
    "meteringMode": "A String", # The metering mode used to create the photo.
    "flashUsed": True or False, # Whether a flash was used to create the photo.
    "time": "A String", # The date and time the photo was taken (EXIF DateTime).
    "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.
  },
  "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
  "name": "A String", # The name of the file. This is not necessarily unique within a folder.
  "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
  "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
  "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
    "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
    "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
      "mimeType": "A String", # The MIME type of the thumbnail.
      "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
    },
  },
  "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
  "starred": True or False, # Whether the user has starred the file.
  "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
}

  keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
  ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
  ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).

Returns:
  An object of the form:

    { # The metadata for a file.
    "mimeType": "A String", # The MIME type of the file.
        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
    "ownedByMe": True or False, # Whether the user owns the file.
    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
        # If an unsupported color is specified, the closest color in the palette will be used instead.
    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "capabilities": { # Capabilities the current user has on the file.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
      "canCopy": True or False, # Whether the user can copy the file.
      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
      "canEdit": True or False, # Whether the user can edit the file's content.
      "canComment": True or False, # Whether the user can comment on the file.
    },
    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
    "parents": [ # The IDs of the parent folders which contain the file.
        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
      "A String",
    ],
    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
    "shared": True or False, # Whether the file has been shared.
    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
        "domain": "A String", # The domain to which this permission refers.
        "displayName": "A String", # A displayable name for users, groups or domains.
        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
        "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
        "photoLink": "A String", # A link to the user's profile photo, if available.
        "role": "A String", # The role granted by this permission. Valid values are:
            # - owner
            # - writer
            # - commenter
            # - reader
        "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "type": "A String", # The type of the grantee. Valid values are:
            # - user
            # - group
            # - domain
            # - anyone
        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
      },
    ],
    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
    "description": "A String", # A short description of the file.
    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
    "viewedByMe": True or False, # Whether the file has been viewed by this user.
    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
      { # Information about a Drive user.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
    ],
    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
    "imageMediaMetadata": { # Additional metadata about image media, if available.
      "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).
      "width": 42, # The width of the image in pixels.
      "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.
      "isoSpeed": 42, # The ISO speed used to create the photo.
      "meteringMode": "A String", # The metering mode used to create the photo.
      "flashUsed": True or False, # Whether a flash was used to create the photo.
      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
      "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.
    },
    "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
        "mimeType": "A String", # The MIME type of the thumbnail.
        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
      },
    },
    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
    "starred": True or False, # Whether the user has starred the file.
    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
  }
create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, ignoreDefaultVisibility=None, ocrLanguage=None) 
Creates 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.
      # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
      # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
  "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
  "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
  "ownedByMe": True or False, # Whether the user owns the file.
  "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
  "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
      # If an unsupported color is specified, the closest color in the palette will be used instead.
  "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
      # Entries with null values are cleared in update and copy requests.
    "a_key": "A String",
  },
  "capabilities": { # Capabilities the current user has on the file.
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "canCopy": True or False, # Whether the user can copy the file.
    "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
    "canEdit": True or False, # Whether the user can edit the file's content.
    "canComment": True or False, # Whether the user can comment on the file.
  },
  "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
  "parents": [ # The IDs of the parent folders which contain the file.
      # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
    "A String",
  ],
  "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
  "shared": True or False, # Whether the file has been shared.
  "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
      "domain": "A String", # The domain to which this permission refers.
      "displayName": "A String", # A displayable name for users, groups or domains.
      "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
      "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
      "emailAddress": "A String", # The email address of the user or group to which this permission refers.
      "photoLink": "A String", # A link to the user's profile photo, if available.
      "role": "A String", # The role granted by this permission. Valid values are:
          # - owner
          # - writer
          # - commenter
          # - reader
      "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "type": "A String", # The type of the grantee. Valid values are:
          # - user
          # - group
          # - domain
          # - anyone
      "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
    },
  ],
  "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
      # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
  "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
  "description": "A String", # A short description of the file.
  "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
      # Note that setting modifiedTime will also update modifiedByMeTime for the user.
  "viewedByMe": True or False, # Whether the file has been viewed by this user.
  "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
    { # Information about a Drive user.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
  ],
  "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
  "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
  "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
      # Entries with null values are cleared in update and copy requests.
    "a_key": "A String",
  },
  "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
  "iconLink": "A String", # A static, unauthenticated link to the file's icon.
  "imageMediaMetadata": { # Additional metadata about image media, if available.
    "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).
    "width": 42, # The width of the image in pixels.
    "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.
    "isoSpeed": 42, # The ISO speed used to create the photo.
    "meteringMode": "A String", # The metering mode used to create the photo.
    "flashUsed": True or False, # Whether a flash was used to create the photo.
    "time": "A String", # The date and time the photo was taken (EXIF DateTime).
    "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.
  },
  "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
  "name": "A String", # The name of the file. This is not necessarily unique within a folder.
  "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
  "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
  "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
    "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
    "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
      "mimeType": "A String", # The MIME type of the thumbnail.
      "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
    },
  },
  "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
  "starred": True or False, # Whether the user has starred the file.
  "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
  useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
  ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
  ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).

Returns:
  An object of the form:

    { # The metadata for a file.
    "mimeType": "A String", # The MIME type of the file.
        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
    "ownedByMe": True or False, # Whether the user owns the file.
    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
        # If an unsupported color is specified, the closest color in the palette will be used instead.
    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "capabilities": { # Capabilities the current user has on the file.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
      "canCopy": True or False, # Whether the user can copy the file.
      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
      "canEdit": True or False, # Whether the user can edit the file's content.
      "canComment": True or False, # Whether the user can comment on the file.
    },
    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
    "parents": [ # The IDs of the parent folders which contain the file.
        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
      "A String",
    ],
    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
    "shared": True or False, # Whether the file has been shared.
    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
        "domain": "A String", # The domain to which this permission refers.
        "displayName": "A String", # A displayable name for users, groups or domains.
        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
        "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
        "photoLink": "A String", # A link to the user's profile photo, if available.
        "role": "A String", # The role granted by this permission. Valid values are:
            # - owner
            # - writer
            # - commenter
            # - reader
        "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "type": "A String", # The type of the grantee. Valid values are:
            # - user
            # - group
            # - domain
            # - anyone
        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
      },
    ],
    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
    "description": "A String", # A short description of the file.
    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
    "viewedByMe": True or False, # Whether the file has been viewed by this user.
    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
      { # Information about a Drive user.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
    ],
    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
    "imageMediaMetadata": { # Additional metadata about image media, if available.
      "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).
      "width": 42, # The width of the image in pixels.
      "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.
      "isoSpeed": 42, # The ISO speed used to create the photo.
      "meteringMode": "A String", # The metering mode used to create the photo.
      "flashUsed": True or False, # Whether a flash was used to create the photo.
      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
      "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.
    },
    "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
        "mimeType": "A String", # The MIME type of the thumbnail.
        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
      },
    },
    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
    "starred": True or False, # Whether the user has starred the file.
    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
  }
delete(fileId) 
Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.

Args:
  fileId: string, The ID of the file. (required)
emptyTrash() 
Permanently deletes all of the user's trashed files.

Args:
export(fileId, mimeType) 
Exports a Google Doc to the requested MIME type and returns the exported content.

Args:
  fileId: string, The ID of the file. (required)
  mimeType: string, The MIME type of the format requested for this export. (required)
export_media(fileId, mimeType) 
Exports a Google Doc to the requested MIME type and returns the exported content.

Args:
  fileId: string, The ID of the file. (required)
  mimeType: string, The MIME type of the format requested for this export. (required)
generateIds(count=None, space=None) 
Generates a set of file IDs which can be provided in create requests.

Args:
  count: integer, The number of IDs to return.
  space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.

Returns:
  An object of the form:

    { # A list of generated file IDs which can be provided in create requests.
    "kind": "drive#generatedIds", # Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".
    "ids": [ # The IDs generated for the requesting user in the specified space.
      "A String",
    ],
    "space": "A String", # The type of file that can be created with these IDs.
  }
get(fileId, acknowledgeAbuse=None) 
Gets a file's metadata or content by ID.

Args:
  fileId: string, The ID of the file. (required)
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  An object of the form:

    { # The metadata for a file.
    "mimeType": "A String", # The MIME type of the file.
        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
    "ownedByMe": True or False, # Whether the user owns the file.
    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
        # If an unsupported color is specified, the closest color in the palette will be used instead.
    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "capabilities": { # Capabilities the current user has on the file.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
      "canCopy": True or False, # Whether the user can copy the file.
      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
      "canEdit": True or False, # Whether the user can edit the file's content.
      "canComment": True or False, # Whether the user can comment on the file.
    },
    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
    "parents": [ # The IDs of the parent folders which contain the file.
        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
      "A String",
    ],
    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
    "shared": True or False, # Whether the file has been shared.
    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
        "domain": "A String", # The domain to which this permission refers.
        "displayName": "A String", # A displayable name for users, groups or domains.
        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
        "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
        "photoLink": "A String", # A link to the user's profile photo, if available.
        "role": "A String", # The role granted by this permission. Valid values are:
            # - owner
            # - writer
            # - commenter
            # - reader
        "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "type": "A String", # The type of the grantee. Valid values are:
            # - user
            # - group
            # - domain
            # - anyone
        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
      },
    ],
    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
    "description": "A String", # A short description of the file.
    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
    "viewedByMe": True or False, # Whether the file has been viewed by this user.
    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
      { # Information about a Drive user.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
    ],
    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
    "imageMediaMetadata": { # Additional metadata about image media, if available.
      "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).
      "width": 42, # The width of the image in pixels.
      "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.
      "isoSpeed": 42, # The ISO speed used to create the photo.
      "meteringMode": "A String", # The metering mode used to create the photo.
      "flashUsed": True or False, # Whether a flash was used to create the photo.
      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
      "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.
    },
    "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
        "mimeType": "A String", # The MIME type of the thumbnail.
        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
      },
    },
    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
    "starred": True or False, # Whether the user has starred the file.
    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
  }
get_media(fileId, acknowledgeAbuse=None) 
Gets a file's metadata or content by ID.

Args:
  fileId: string, The ID of the file. (required)
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  The media object as a string.
list(orderBy=None, q=None, pageSize=None, pageToken=None, spaces=None, corpus=None) 
Lists or searches files.

Args:
  orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
  q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.
  pageSize: integer, The maximum number of files to return per page.
  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  spaces: string, A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
  corpus: string, The source of files to list.
    Allowed values
      domain - Files shared to the user's domain.
      user - Files owned by or shared to the user.

Returns:
  An object of the form:

    { # A list of files.
    "files": [ # The page of files.
      { # The metadata for a file.
        "mimeType": "A String", # The MIME type of the file.
            # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
            # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
        "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
        "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
        "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
        "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
        "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
        "ownedByMe": True or False, # Whether the user owns the file.
        "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
        "id": "A String", # The ID of the file.
        "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
        "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
          "width": 42, # The width of the video in pixels.
          "durationMillis": "A String", # The duration of the video in milliseconds.
          "height": 42, # The height of the video in pixels.
        },
        "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
            # If an unsupported color is specified, the closest color in the palette will be used instead.
        "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
            # Entries with null values are cleared in update and copy requests.
          "a_key": "A String",
        },
        "capabilities": { # Capabilities the current user has on the file.
          "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
          "canCopy": True or False, # Whether the user can copy the file.
          "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
          "canEdit": True or False, # Whether the user can edit the file's content.
          "canComment": True or False, # Whether the user can comment on the file.
        },
        "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
        "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
        "parents": [ # The IDs of the parent folders which contain the file.
            # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
          "A String",
        ],
        "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
        "shared": True or False, # Whether the file has been shared.
        "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
          { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
            "domain": "A String", # The domain to which this permission refers.
            "displayName": "A String", # A displayable name for users, groups or domains.
            "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
            "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
            "emailAddress": "A String", # The email address of the user or group to which this permission refers.
            "photoLink": "A String", # A link to the user's profile photo, if available.
            "role": "A String", # The role granted by this permission. Valid values are:
                # - owner
                # - writer
                # - commenter
                # - reader
            "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
            "type": "A String", # The type of the grantee. Valid values are:
                # - user
                # - group
                # - domain
                # - anyone
            "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
          },
        ],
        "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
            # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
        "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
        "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
        "description": "A String", # A short description of the file.
        "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
            # Note that setting modifiedTime will also update modifiedByMeTime for the user.
        "viewedByMe": True or False, # Whether the file has been viewed by this user.
        "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
          { # Information about a Drive user.
            "me": True or False, # Whether this user is the requesting user.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "displayName": "A String", # A plain text displayable name for this user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
        ],
        "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
        "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
        "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
            # Entries with null values are cleared in update and copy requests.
          "a_key": "A String",
        },
        "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
        "iconLink": "A String", # A static, unauthenticated link to the file's icon.
        "imageMediaMetadata": { # Additional metadata about image media, if available.
          "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).
          "width": 42, # The width of the image in pixels.
          "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.
          "isoSpeed": 42, # The ISO speed used to create the photo.
          "meteringMode": "A String", # The metering mode used to create the photo.
          "flashUsed": True or False, # Whether a flash was used to create the photo.
          "time": "A String", # The date and time the photo was taken (EXIF DateTime).
          "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.
        },
        "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
        "name": "A String", # The name of the file. This is not necessarily unique within a folder.
        "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
        "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
          "A String",
        ],
        "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
        "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
          "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
          "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
            "mimeType": "A String", # The MIME type of the thumbnail.
            "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
          },
        },
        "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
        "starred": True or False, # Whether the user has starred the file.
        "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
      },
    ],
    "nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached.
    "kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string "drive#fileList".
  }
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(fileId, body=None, media_body=None, addParents=None, removeParents=None, useContentAsIndexableText=None, keepRevisionForever=None, ocrLanguage=None) 
Updates a file's metadata and/or content with patch semantics.

Args:
  fileId: string, The ID of the file. (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.
      # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
      # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
  "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
  "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
  "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
  "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
  "ownedByMe": True or False, # Whether the user owns the file.
  "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
  "id": "A String", # The ID of the file.
  "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
  "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
    "width": 42, # The width of the video in pixels.
    "durationMillis": "A String", # The duration of the video in milliseconds.
    "height": 42, # The height of the video in pixels.
  },
  "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
      # If an unsupported color is specified, the closest color in the palette will be used instead.
  "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
      # Entries with null values are cleared in update and copy requests.
    "a_key": "A String",
  },
  "capabilities": { # Capabilities the current user has on the file.
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
    "canCopy": True or False, # Whether the user can copy the file.
    "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
    "canEdit": True or False, # Whether the user can edit the file's content.
    "canComment": True or False, # Whether the user can comment on the file.
  },
  "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
  "parents": [ # The IDs of the parent folders which contain the file.
      # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
    "A String",
  ],
  "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
  "shared": True or False, # Whether the file has been shared.
  "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
      "domain": "A String", # The domain to which this permission refers.
      "displayName": "A String", # A displayable name for users, groups or domains.
      "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
      "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
      "emailAddress": "A String", # The email address of the user or group to which this permission refers.
      "photoLink": "A String", # A link to the user's profile photo, if available.
      "role": "A String", # The role granted by this permission. Valid values are:
          # - owner
          # - writer
          # - commenter
          # - reader
      "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
      "type": "A String", # The type of the grantee. Valid values are:
          # - user
          # - group
          # - domain
          # - anyone
      "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
    },
  ],
  "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
      # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
  "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
  "description": "A String", # A short description of the file.
  "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
      # Note that setting modifiedTime will also update modifiedByMeTime for the user.
  "viewedByMe": True or False, # Whether the file has been viewed by this user.
  "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
    { # Information about a Drive user.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
  ],
  "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
  "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
  "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
      # Entries with null values are cleared in update and copy requests.
    "a_key": "A String",
  },
  "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
  "iconLink": "A String", # A static, unauthenticated link to the file's icon.
  "imageMediaMetadata": { # Additional metadata about image media, if available.
    "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).
    "width": 42, # The width of the image in pixels.
    "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.
    "isoSpeed": 42, # The ISO speed used to create the photo.
    "meteringMode": "A String", # The metering mode used to create the photo.
    "flashUsed": True or False, # Whether a flash was used to create the photo.
    "time": "A String", # The date and time the photo was taken (EXIF DateTime).
    "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.
  },
  "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
  "name": "A String", # The name of the file. This is not necessarily unique within a folder.
  "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
  "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
    "A String",
  ],
  "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
  "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
    "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
    "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
      "mimeType": "A String", # The MIME type of the thumbnail.
      "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
    },
  },
  "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
  "starred": True or False, # Whether the user has starred the file.
  "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  addParents: string, A comma-separated list of parent IDs to add.
  removeParents: string, A comma-separated list of parent IDs to remove.
  useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
  keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
  ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).

Returns:
  An object of the form:

    { # The metadata for a file.
    "mimeType": "A String", # The MIME type of the file.
        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
    "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
    "ownedByMe": True or False, # Whether the user owns the file.
    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
    "id": "A String", # The ID of the file.
    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
      "width": 42, # The width of the video in pixels.
      "durationMillis": "A String", # The duration of the video in milliseconds.
      "height": 42, # The height of the video in pixels.
    },
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
        # If an unsupported color is specified, the closest color in the palette will be used instead.
    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "capabilities": { # Capabilities the current user has on the file.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
      "canCopy": True or False, # Whether the user can copy the file.
      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
      "canEdit": True or False, # Whether the user can edit the file's content.
      "canComment": True or False, # Whether the user can comment on the file.
    },
    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
    "parents": [ # The IDs of the parent folders which contain the file.
        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
      "A String",
    ],
    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
    "shared": True or False, # Whether the file has been shared.
    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
        "domain": "A String", # The domain to which this permission refers.
        "displayName": "A String", # A displayable name for users, groups or domains.
        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
        "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
        "photoLink": "A String", # A link to the user's profile photo, if available.
        "role": "A String", # The role granted by this permission. Valid values are:
            # - owner
            # - writer
            # - commenter
            # - reader
        "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "type": "A String", # The type of the grantee. Valid values are:
            # - user
            # - group
            # - domain
            # - anyone
        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
      },
    ],
    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
    "description": "A String", # A short description of the file.
    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
    "viewedByMe": True or False, # Whether the file has been viewed by this user.
    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
      { # Information about a Drive user.
        "me": True or False, # Whether this user is the requesting user.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "displayName": "A String", # A plain text displayable name for this user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
    ],
    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
        # Entries with null values are cleared in update and copy requests.
      "a_key": "A String",
    },
    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
    "imageMediaMetadata": { # Additional metadata about image media, if available.
      "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).
      "width": 42, # The width of the image in pixels.
      "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.
      "isoSpeed": 42, # The ISO speed used to create the photo.
      "meteringMode": "A String", # The metering mode used to create the photo.
      "flashUsed": True or False, # Whether a flash was used to create the photo.
      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
      "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.
    },
    "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
      "A String",
    ],
    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
        "mimeType": "A String", # The MIME type of the thumbnail.
        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
      },
    },
    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
    "starred": True or False, # Whether the user has starred the file.
    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
  }
watch(fileId, body, acknowledgeAbuse=None) 
Subscribes to changes to a file

Args:
  fileId: string, The ID of the file. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  An object of the form:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
watch_media(fileId, body, acknowledgeAbuse=None) 
Subscribes to changes to a file

Args:
  fileId: string, The ID of the file. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/drive_v3.html000066400000000000000000000061131300622755700225010ustar00rootroot00000000000000

Drive API

Instance Methods

about()

Returns the about Resource.

changes()

Returns the changes Resource.

channels()

Returns the channels Resource.

comments()

Returns the comments Resource.

files()

Returns the files Resource.

permissions()

Returns the permissions Resource.

replies()

Returns the replies Resource.

revisions()

Returns the revisions Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/drive_v3.permissions.html000066400000000000000000000303231300622755700250530ustar00rootroot00000000000000

Drive API . permissions

Instance Methods

create(fileId, body, sendNotificationEmail=None, transferOwnership=None, emailMessage=None)

Creates a permission for a file.

delete(fileId, permissionId)

Deletes a permission.

get(fileId, permissionId)

Gets a permission by ID.

list(fileId)

Lists a file's permissions.

update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)

Updates a permission with patch semantics.

Method Details

create(fileId, body, sendNotificationEmail=None, transferOwnership=None, emailMessage=None) 
Creates a permission 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 permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
  "domain": "A String", # The domain to which this permission refers.
  "displayName": "A String", # A displayable name for users, groups or domains.
  "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
  "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
  "emailAddress": "A String", # The email address of the user or group to which this permission refers.
  "photoLink": "A String", # A link to the user's profile photo, if available.
  "role": "A String", # The role granted by this permission. Valid values are:
      # - owner
      # - writer
      # - commenter
      # - reader
  "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
  "type": "A String", # The type of the grantee. Valid values are:
      # - user
      # - group
      # - domain
      # - anyone
  "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}

  sendNotificationEmail: boolean, Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
  transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
  emailMessage: string, A custom message to include in the notification email.

Returns:
  An object of the form:

    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
    "domain": "A String", # The domain to which this permission refers.
    "displayName": "A String", # A displayable name for users, groups or domains.
    "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
    "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
    "emailAddress": "A String", # The email address of the user or group to which this permission refers.
    "photoLink": "A String", # A link to the user's profile photo, if available.
    "role": "A String", # The role granted by this permission. Valid values are:
        # - owner
        # - writer
        # - commenter
        # - reader
    "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "type": "A String", # The type of the grantee. Valid values are:
        # - user
        # - group
        # - domain
        # - anyone
    "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
  }
delete(fileId, permissionId) 
Deletes a permission.

Args:
  fileId: string, The ID of the file. (required)
  permissionId: string, The ID of the permission. (required)
get(fileId, permissionId) 
Gets a permission by ID.

Args:
  fileId: string, The ID of the file. (required)
  permissionId: string, The ID of the permission. (required)

Returns:
  An object of the form:

    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
    "domain": "A String", # The domain to which this permission refers.
    "displayName": "A String", # A displayable name for users, groups or domains.
    "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
    "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
    "emailAddress": "A String", # The email address of the user or group to which this permission refers.
    "photoLink": "A String", # A link to the user's profile photo, if available.
    "role": "A String", # The role granted by this permission. Valid values are:
        # - owner
        # - writer
        # - commenter
        # - reader
    "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "type": "A String", # The type of the grantee. Valid values are:
        # - user
        # - group
        # - domain
        # - anyone
    "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
  }
list(fileId) 
Lists a file's permissions.

Args:
  fileId: string, The ID of the file. (required)

Returns:
  An object of the form:

    { # A list of permissions for a file.
    "kind": "drive#permissionList", # Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
    "permissions": [ # The full list of permissions.
      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
        "domain": "A String", # The domain to which this permission refers.
        "displayName": "A String", # A displayable name for users, groups or domains.
        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
        "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
        "photoLink": "A String", # A link to the user's profile photo, if available.
        "role": "A String", # The role granted by this permission. Valid values are:
            # - owner
            # - writer
            # - commenter
            # - reader
        "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
        "type": "A String", # The type of the grantee. Valid values are:
            # - user
            # - group
            # - domain
            # - anyone
        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
      },
    ],
  }
update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None) 
Updates a permission with patch semantics.

Args:
  fileId: string, The ID of the file. (required)
  permissionId: string, The ID of the permission. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
  "domain": "A String", # The domain to which this permission refers.
  "displayName": "A String", # A displayable name for users, groups or domains.
  "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
  "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
  "emailAddress": "A String", # The email address of the user or group to which this permission refers.
  "photoLink": "A String", # A link to the user's profile photo, if available.
  "role": "A String", # The role granted by this permission. Valid values are:
      # - owner
      # - writer
      # - commenter
      # - reader
  "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
  "type": "A String", # The type of the grantee. Valid values are:
      # - user
      # - group
      # - domain
      # - anyone
  "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}

  removeExpiration: boolean, Whether to remove the expiration date.
  transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

Returns:
  An object of the form:

    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
    "domain": "A String", # The domain to which this permission refers.
    "displayName": "A String", # A displayable name for users, groups or domains.
    "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
    "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
    "emailAddress": "A String", # The email address of the user or group to which this permission refers.
    "photoLink": "A String", # A link to the user's profile photo, if available.
    "role": "A String", # The role granted by this permission. Valid values are:
        # - owner
        # - writer
        # - commenter
        # - reader
    "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
    "type": "A String", # The type of the grantee. Valid values are:
        # - user
        # - group
        # - domain
        # - anyone
    "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v3.replies.html000066400000000000000000000350751300622755700241540ustar00rootroot00000000000000

Drive API . replies

Instance Methods

create(fileId, commentId, body)

Creates a new reply to a comment.

delete(fileId, commentId, replyId)

Deletes a reply.

get(fileId, commentId, replyId, includeDeleted=None)

Gets a reply by ID.

list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None)

Lists a comment's replies.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(fileId, commentId, replyId, body)

Updates a reply with patch semantics.

Method Details

create(fileId, commentId, body) 
Creates a new reply to a 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 reply to a comment on a file.
  "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
  "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
  "author": { # Information about a Drive user. # The user who created the reply.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
  "htmlContent": "A String", # The content of the reply with HTML formatting.
  "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
  "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
  "action": "A String", # The action the reply performed to the parent comment. Valid values are:
      # - resolve
      # - reopen
  "id": "A String", # The ID of the reply.
}


Returns:
  An object of the form:

    { # A reply to a comment on a file.
    "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
    "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    "author": { # Information about a Drive user. # The user who created the reply.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
    "htmlContent": "A String", # The content of the reply with HTML formatting.
    "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
    "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
    "action": "A String", # The action the reply performed to the parent comment. Valid values are:
        # - resolve
        # - reopen
    "id": "A String", # The ID of the reply.
  }
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 by ID.

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, Whether to return deleted replies. Deleted replies will not include their original content.

Returns:
  An object of the form:

    { # A reply to a comment on a file.
    "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
    "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    "author": { # Information about a Drive user. # The user who created the reply.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
    "htmlContent": "A String", # The content of the reply with HTML formatting.
    "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
    "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
    "action": "A String", # The action the reply performed to the parent comment. Valid values are:
        # - resolve
        # - reopen
    "id": "A String", # The ID of the reply.
  }
list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None) 
Lists a comment's replies.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  includeDeleted: boolean, Whether to include deleted replies. Deleted replies will not include their original content.
  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  pageSize: integer, The maximum number of replies to return per page.

Returns:
  An object of the form:

    { # A list of replies to a comment on a file.
    "nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached.
    "kind": "drive#replyList", # Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
    "replies": [ # The page of replies.
      { # A reply to a comment on a file.
        "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
        "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
        "author": { # Information about a Drive user. # The user who created the reply.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
        "htmlContent": "A String", # The content of the reply with HTML formatting.
        "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
        "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
        "action": "A String", # The action the reply performed to the parent comment. Valid values are:
            # - resolve
            # - reopen
        "id": "A String", # The ID of the reply.
      },
    ],
  }
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(fileId, commentId, replyId, body) 
Updates a reply with 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 reply to a comment on a file.
  "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
  "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
  "author": { # Information about a Drive user. # The user who created the reply.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
  "htmlContent": "A String", # The content of the reply with HTML formatting.
  "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
  "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
  "action": "A String", # The action the reply performed to the parent comment. Valid values are:
      # - resolve
      # - reopen
  "id": "A String", # The ID of the reply.
}


Returns:
  An object of the form:

    { # A reply to a comment on a file.
    "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
    "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    "author": { # Information about a Drive user. # The user who created the reply.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
    "htmlContent": "A String", # The content of the reply with HTML formatting.
    "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
    "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
    "action": "A String", # The action the reply performed to the parent comment. Valid values are:
        # - resolve
        # - reopen
    "id": "A String", # The ID of the reply.
  }
google-api-python-client-1.5.5/docs/dyn/drive_v3.revisions.html000066400000000000000000000340131300622755700245210ustar00rootroot00000000000000

Drive API . revisions

Instance Methods

delete(fileId, revisionId)

Permanently deletes a revision. This method is only applicable to files with binary content in Drive.

get(fileId, revisionId, acknowledgeAbuse=None)

Gets a revision's metadata or content by ID.

get_media(fileId, revisionId, acknowledgeAbuse=None)

Gets a revision's metadata or content by ID.

list(fileId, pageToken=None, pageSize=None)

Lists a file's revisions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(fileId, revisionId, body)

Updates a revision with patch semantics.

Method Details

delete(fileId, revisionId) 
Permanently deletes a revision. This method is only applicable to files with binary content in Drive.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
get(fileId, revisionId, acknowledgeAbuse=None) 
Gets a revision's metadata or content by ID.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  An object of the form:

    { # The metadata for a revision to a file.
    "mimeType": "A String", # The MIME type of the revision.
    "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
    "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
        # This field is only applicable to files with binary content in Drive.
    "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
    "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
    "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
    "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
    "id": "A String", # The ID of the revision.
    "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
    "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
  }
get_media(fileId, revisionId, acknowledgeAbuse=None) 
Gets a revision's metadata or content by ID.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  The media object as a string.
list(fileId, pageToken=None, pageSize=None) 
Lists a file's revisions.

Args:
  fileId: string, The ID of the file. (required)
  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  pageSize: integer, The maximum number of revisions to return per page.

Returns:
  An object of the form:

    { # A list of revisions of a file.
    "nextPageToken": "A String", # The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached.
    "kind": "drive#revisionList", # Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
    "revisions": [ # The full list of revisions.
      { # The metadata for a revision to a file.
        "mimeType": "A String", # The MIME type of the revision.
        "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
        "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
        "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
            # This field is only applicable to files with binary content in Drive.
        "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
        "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
        "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
        "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
        "id": "A String", # The ID of the revision.
        "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
        "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
      },
    ],
  }
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(fileId, revisionId, body) 
Updates a revision with patch semantics.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The metadata for a revision to a file.
  "mimeType": "A String", # The MIME type of the revision.
  "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
  "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
  "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
      # This field is only applicable to files with binary content in Drive.
  "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
  "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
  "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
  "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
  "id": "A String", # The ID of the revision.
  "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
  "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
}


Returns:
  An object of the form:

    { # The metadata for a revision to a file.
    "mimeType": "A String", # The MIME type of the revision.
    "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
    "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
        # This field is only applicable to files with binary content in Drive.
    "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
    "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
    "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
    "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
    "id": "A String", # The ID of the revision.
    "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
    "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
  }
google-api-python-client-1.5.5/docs/dyn/firebasedynamiclinks_v1.html000066400000000000000000000041711300622755700255560ustar00rootroot00000000000000

Firebase Dynamic Links API

Instance Methods

shortLinks()

Returns the shortLinks Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/firebasedynamiclinks_v1.shortLinks.html000066400000000000000000000205641300622755700277210ustar00rootroot00000000000000

Firebase Dynamic Links API . shortLinks

Instance Methods

create(body, x__xgafv=None)

Creates a short Dynamic Link given either a valid long Dynamic Link or

Method Details

create(body, x__xgafv=None) 
Creates a short Dynamic Link given either a valid long Dynamic Link or
details such as Dynamic Link domain, Android and iOS app information.
The created short Dynamic Link will not expire.

Repeated calls with the same long Dynamic Link or Dynamic Link information
will produce the same short Dynamic Link.

The Dynamic Link domain in the request must be owned by requester's
Firebase project.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to create a short Dynamic Link.
    "dynamicLinkInfo": { # Information about a Dynamic Link. # Information about the Dynamic Link to be shortened.
        # [Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
      "analyticsInfo": { # Tracking parameters supported by Dynamic Link. # Parameters used for tracking. See all tracking parameters in the
          # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
        "googlePlayAnalytics": { # Parameters for Google Play Campaign Measurements. # Google Play Campaign Measurements.
            # [Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)
          "utmMedium": "A String", # Campaign medium; used to identify a medium such as email or cost-per-click.
          "utmSource": "A String", # Campaign source; used to identify a search engine, newsletter, or other
              # source.
          "gclid": "A String", # [AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);
              # used to measure Google AdWords ads. This value is generated dynamically
              # and should never be modified.
          "utmTerm": "A String", # Campaign term; used with paid search to supply the keywords for ads.
          "utmContent": "A String", # Campaign content; used for A/B testing and content-targeted ads to
              # differentiate ads or links that point to the same URL.
          "utmCampaign": "A String", # Campaign name; used for keyword analysis to identify a specific product
              # promotion or strategic campaign.
        },
        "itunesConnectAnalytics": { # Parameters for iTunes Connect App Analytics. # iTunes Connect App Analytics.
          "mt": "A String", # iTune media types, including music, podcasts, audiobooks and so on.
          "at": "A String", # Affiliate token used to create affiliate-coded links.
          "pt": "A String", # Provider token that enables analytics for Dynamic Links from within iTunes
              # Connect.
          "ct": "A String", # Campaign text that developers can optionally add to any link in order to
              # track sales from a specific marketing campaign.
        },
      },
      "isAd": True or False, # Declares that the Dynamic Link is used in an advertisement.
          # See the 'ad' parameter in the
          # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
      "iosInfo": { # iOS related attributes to the Dynamic Link.. # iOS related information. See iOS related parameters in the
          # [documentation](https://firebase.google.com/docs/dynamic-links/ios#create-a-dynamic-link-programmatically).
        "iosCustomScheme": "A String", # Custom (destination) scheme to use for iOS. By default, we’ll use the
            # bundle ID as the custom scheme. Developer can override this behavior using
            # this param.
        "iosFallbackLink": "A String", # Link to open on iOS if the app is not installed.
        "iosBundleId": "A String", # iOS bundle ID of the app.
        "iosIpadBundleId": "A String", # iPad bundle ID of the app.
        "iosAppStoreId": "A String", # iOS App Store ID.
        "iosIpadFallbackLink": "A String", # If specified, this overrides the ios_fallback_link value on iPads.
      },
      "androidInfo": { # Android related attributes to the Dynamic Link. # Android related information. See Android related parameters in the
          # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
        "androidFallbackLink": "A String", # Link to open on Android if the app is not installed.
        "androidPackageName": "A String", # Android package name of the app.
        "androidLink": "A String", # If specified, this overrides the ‘link’ parameter on Android.
        "androidMinPackageVersionCode": "A String", # Minimum version code for the Android app. If the installed app’s version
            # code is lower, then the user is taken to the Play Store.
      },
      "socialMetaTagInfo": { # Parameters for social meta tag params. # Parameters for social meta tag params.
          # Used to set meta tag data for link previews on social sites.
          # Used to set meta tag data for link previews on social sites.
        "socialTitle": "A String", # Title to be displayed. Optional.
        "socialDescription": "A String", # A short description of the link. Optional.
        "socialImageLink": "A String", # An image url string. Optional.
      },
      "link": "A String", # The link your app will open, You can specify any URL your app can handle.
          # This link must be a well-formatted URL, be properly URL-encoded, and use
          # the HTTP or HTTPS scheme. See 'link' parameters in the
          # [documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
          #
          # Required.
      "dynamicLinkDomain": "A String", # Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl
          # [Learn more](https://firebase.google.com/docs/dynamic-links/android#set-up-firebase-and-the-dynamic-links-sdk)
          # on how to set up Dynamic Link domain associated with your Firebase project.
          #
          # Required.
    },
    "longDynamicLink": "A String", # Full long Dynamic Link URL with desired query parameters specified.
        # For example,
        # "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample",
        # [Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).
    "suffix": { # Short Dynamic Link suffix. # Short Dynamic Link suffix. Optional.
      "option": "A String", # Suffix option.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to create a short Dynamic Link.
    "shortLink": "A String", # Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz
    "warning": [ # Information about potential warnings on link creation.
      { # Dynamic Links warning messages.
        "warningCode": "A String", # The warning code.
        "warningMessage": "A String", # The warning message to help developers improve their requests.
      },
    ],
    "previewLink": "A String", # Preivew link to show the link flow chart.
  }
google-api-python-client-1.5.5/docs/dyn/firebaserules_v1.html000066400000000000000000000041351300622755700242230ustar00rootroot00000000000000

Firebase Rules API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/firebaserules_v1.projects.html000066400000000000000000000104761300622755700260600ustar00rootroot00000000000000

Firebase Rules API . projects

Instance Methods

releases()

Returns the releases Resource.

rulesets()

Returns the rulesets Resource.

test(name=None, body, x__xgafv=None)

Test `Source` for syntactic and semantic correctness. Issues present in the

Method Details

test(name=None, body, x__xgafv=None) 
Test `Source` for syntactic and semantic correctness. Issues present in the
rules, if any, will be returned to the caller with a description, severity,
and source location.

The test method will typically be executed with a developer provided
`Source`, but if regression testing is desired, this method may be
executed against a `Ruleset` resource name and the `Source` will be
retrieved from the persisted `Ruleset`.

The following is an example of `Source` that permits users to upload images
to a bucket bearing their user id and matching the correct metadata:

_*Example*_

    // Users are allowed to subscribe and unsubscribe to the blog.
    service firebase.storage {
      match /users/{userId}/images/{imageName} {
          allow write: if userId == request.userId
              && (imageName.endsWith('.png') || imageName.endsWith('.jpg'))
              && resource.mimeType.startsWith('image/')
      }
    }

Args:
  name: string, Name of the project.

Format: `projects/{project_id}` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for FirebaseRulesService.TestRuleset.
    "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` to be checked for correctness.
      "files": [ # `File` set constituting the `Source` bundle.
        { # `File` containing source content.
          "content": "A String", # Textual Content.
          "name": "A String", # File name.
          "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
        },
      ],
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for FirebaseRulesService.TestRuleset.
    "issues": [ # Syntactic and semantic `Source` issues of varying severity. Issues of
        # `ERROR` severity will prevent tests from executing.
      { # Issues include warnings, errors, and deprecation notices.
        "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position of the issue in the `Source`.
            # index of the `File` in the `Source` message. Used for debug purposes.
          "column": 42, # First column on the source line associated with the source fragment.
          "line": 42, # Line number of the source fragment. 1-based.
          "fileName": "A String", # Name of the `File`.
        },
        "description": "A String", # Short error description.
        "severity": "A String", # The severity of the issue.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/firebaserules_v1.projects.releases.html000066400000000000000000000513361300622755700276620ustar00rootroot00000000000000

Firebase Rules API . projects . releases

Instance Methods

create(name=None, body, x__xgafv=None)

Create a `Release`.

delete(name=None, x__xgafv=None)

Delete a `Release` by resource name.

get(name=None, x__xgafv=None)

Get a `Release` by name.

list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

List the `Release` values for a project. This list may optionally be

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name=None, body, x__xgafv=None)

Update a `Release`.

Method Details

create(name=None, body, x__xgafv=None) 
Create a `Release`.

Release names should reflect the developer's deployment practices. For
example, the release name may include the environment name, application
name, application version, or any other name meaningful to the developer.
Once a `Release` refers to a `Ruleset`, the rules can be enforced by
Firebase Rules-enabled services.

More than one `Release` may be 'live' concurrently. Consider the following
three `Release` names for `projects/foo` and the `Ruleset` to which they
refer.

Release Name                    | Ruleset Name
--------------------------------|-------------
projects/foo/releases/prod      | projects/foo/rulesets/uuid123
projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123
projects/foo/releases/prod/v23  | projects/foo/rulesets/uuid456

The table reflects the `Ruleset` rollout in progress. The `prod` and
`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`
refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be
updated using the UpdateRelease method, and the custom `Release` name
may be referenced by specifying the `X-Firebase-Rules-Release-Name` header.

Args:
  name: string, Resource name for the project which owns this `Release`.

Format: `projects/{project_id}` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
      # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
    "updateTime": "A String", # Time the release was updated.
        # @OutputOnly
    "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
        # exist the `Release` to be created.
    "createTime": "A String", # Time the release was created.
        # @OutputOnly
    "name": "A String", # Resource name for the `Release`.
        # 
        # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
        # which affords developers a great deal of flexibility in mapping the name
        # to the style that best fits their existing development practices. For
        # example, a name could refer to an environment, an app, a version, or some
        # combination of three.
        # 
        # In the table below, for the project name `projects/foo`, the following
        # relative release paths show how flat and structured names might be chosen
        # to match a desired development / deployment strategy.
        # 
        # Use Case     | Flat Name           | Structured Name
        # -------------|---------------------|----------------
        # Environments | releases/qa         | releases/qa
        # Apps         | releases/app1_qa    | releases/app1/qa
        # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
        # 
        # The delimiter between the release name path elements can be almost anything
        # and it should work equally well with the release name list filter, but in
        # many ways the structured paths provide a clearer picture of the
        # relationship between `Release` instances.
        # 
        # Format: `projects/{project_id}/releases/{release_id}`
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
        # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
      "updateTime": "A String", # Time the release was updated.
          # @OutputOnly
      "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
          # exist the `Release` to be created.
      "createTime": "A String", # Time the release was created.
          # @OutputOnly
      "name": "A String", # Resource name for the `Release`.
          #
          # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
          # which affords developers a great deal of flexibility in mapping the name
          # to the style that best fits their existing development practices. For
          # example, a name could refer to an environment, an app, a version, or some
          # combination of three.
          #
          # In the table below, for the project name `projects/foo`, the following
          # relative release paths show how flat and structured names might be chosen
          # to match a desired development / deployment strategy.
          #
          # Use Case     | Flat Name           | Structured Name
          # -------------|---------------------|----------------
          # Environments | releases/qa         | releases/qa
          # Apps         | releases/app1_qa    | releases/app1/qa
          # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
          #
          # The delimiter between the release name path elements can be almost anything
          # and it should work equally well with the release name list filter, but in
          # many ways the structured paths provide a clearer picture of the
          # relationship between `Release` instances.
          #
          # Format: `projects/{project_id}/releases/{release_id}`
    }
delete(name=None, x__xgafv=None) 
Delete a `Release` by resource name.

Args:
  name: string, Resource name for the `Release` to delete.

Format: `projects/{project_id}/releases/{release_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name=None, x__xgafv=None) 
Get a `Release` by name.

Args:
  name: string, Resource name of the `Release`.


Format: `projects/{project_id}/releases/{release_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
        # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
      "updateTime": "A String", # Time the release was updated.
          # @OutputOnly
      "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
          # exist the `Release` to be created.
      "createTime": "A String", # Time the release was created.
          # @OutputOnly
      "name": "A String", # Resource name for the `Release`.
          #
          # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
          # which affords developers a great deal of flexibility in mapping the name
          # to the style that best fits their existing development practices. For
          # example, a name could refer to an environment, an app, a version, or some
          # combination of three.
          #
          # In the table below, for the project name `projects/foo`, the following
          # relative release paths show how flat and structured names might be chosen
          # to match a desired development / deployment strategy.
          #
          # Use Case     | Flat Name           | Structured Name
          # -------------|---------------------|----------------
          # Environments | releases/qa         | releases/qa
          # Apps         | releases/app1_qa    | releases/app1/qa
          # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
          #
          # The delimiter between the release name path elements can be almost anything
          # and it should work equally well with the release name list filter, but in
          # many ways the structured paths provide a clearer picture of the
          # relationship between `Release` instances.
          #
          # Format: `projects/{project_id}/releases/{release_id}`
    }
list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
List the `Release` values for a project. This list may optionally be
filtered by `Release` name or `Ruleset` id or both.

Args:
  name: string, Resource name for the project.

Format: `projects/{project_id}` (required)
  pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
Note: `page_size` is just a hint and the service may choose to load less
than `page_size` due to the size of the output. To traverse all of the
releases, caller should iterate until the `page_token` is empty.
  filter: string, `Release` filter. The list method supports filters with restrictions on the
`Release` `name` and also on the `Ruleset` `ruleset_name`.

Example 1) A filter of 'name=prod*' might return `Release`s with names
within 'projects/foo' prefixed with 'prod':

Name                          | Ruleset Name
------------------------------|-------------
projects/foo/releases/prod    | projects/foo/rulesets/uuid1234
projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234
projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888

Example 2) A filter of `name=prod* ruleset_name=uuid1234` would return only
`Release` instances for 'projects/foo' with names prefixed with 'prod'
referring to the same `Ruleset` name of 'uuid1234':

Name                          | Ruleset Name
------------------------------|-------------
projects/foo/releases/prod    | projects/foo/rulesets/1234
projects/foo/releases/prod/v1 | projects/foo/rulesets/1234

In the examples, the filter parameters refer to the search filters for
release and ruleset names are relative to the project releases and rulesets
collections. Fully qualified prefixed may also be used. e.g.
`name=projects/foo/releases/prod* ruleset_name=projects/foo/rulesets/uuid1`
  pageToken: string, Next page token for the next batch of `Release` instances.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for FirebaseRulesService.ListReleases.
    "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
        # empty, no further results remain.
    "releases": [ # List of `Release` instances.
      { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
            # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
          "updateTime": "A String", # Time the release was updated.
              # @OutputOnly
          "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
              # exist the `Release` to be created.
          "createTime": "A String", # Time the release was created.
              # @OutputOnly
          "name": "A String", # Resource name for the `Release`.
              #
              # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
              # which affords developers a great deal of flexibility in mapping the name
              # to the style that best fits their existing development practices. For
              # example, a name could refer to an environment, an app, a version, or some
              # combination of three.
              #
              # In the table below, for the project name `projects/foo`, the following
              # relative release paths show how flat and structured names might be chosen
              # to match a desired development / deployment strategy.
              #
              # Use Case     | Flat Name           | Structured Name
              # -------------|---------------------|----------------
              # Environments | releases/qa         | releases/qa
              # Apps         | releases/app1_qa    | releases/app1/qa
              # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
              #
              # The delimiter between the release name path elements can be almost anything
              # and it should work equally well with the release name list filter, but in
              # many ways the structured paths provide a clearer picture of the
              # relationship between `Release` instances.
              #
              # Format: `projects/{project_id}/releases/{release_id}`
        },
    ],
  }
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(name=None, body, x__xgafv=None) 
Update a `Release`.

Only updates to the `ruleset_name` field will be honored. `Release` rename
is not supported. To create a `Release` use the CreateRelease method
instead.

Args:
  name: string, Resource name for the `Release`.

`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
which affords developers a great deal of flexibility in mapping the name
to the style that best fits their existing development practices. For
example, a name could refer to an environment, an app, a version, or some
combination of three.

In the table below, for the project name `projects/foo`, the following
relative release paths show how flat and structured names might be chosen
to match a desired development / deployment strategy.

Use Case     | Flat Name           | Structured Name
-------------|---------------------|----------------
Environments | releases/qa         | releases/qa
Apps         | releases/app1_qa    | releases/app1/qa
Versions     | releases/app1_v2_qa | releases/app1/v2/qa

The delimiter between the release name path elements can be almost anything
and it should work equally well with the release name list filter, but in
many ways the structured paths provide a clearer picture of the
relationship between `Release` instances.

Format: `projects/{project_id}/releases/{release_id}` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
      # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
    "updateTime": "A String", # Time the release was updated.
        # @OutputOnly
    "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
        # exist the `Release` to be created.
    "createTime": "A String", # Time the release was created.
        # @OutputOnly
    "name": "A String", # Resource name for the `Release`.
        # 
        # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
        # which affords developers a great deal of flexibility in mapping the name
        # to the style that best fits their existing development practices. For
        # example, a name could refer to an environment, an app, a version, or some
        # combination of three.
        # 
        # In the table below, for the project name `projects/foo`, the following
        # relative release paths show how flat and structured names might be chosen
        # to match a desired development / deployment strategy.
        # 
        # Use Case     | Flat Name           | Structured Name
        # -------------|---------------------|----------------
        # Environments | releases/qa         | releases/qa
        # Apps         | releases/app1_qa    | releases/app1/qa
        # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
        # 
        # The delimiter between the release name path elements can be almost anything
        # and it should work equally well with the release name list filter, but in
        # many ways the structured paths provide a clearer picture of the
        # relationship between `Release` instances.
        # 
        # Format: `projects/{project_id}/releases/{release_id}`
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
        # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
      "updateTime": "A String", # Time the release was updated.
          # @OutputOnly
      "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
          # exist the `Release` to be created.
      "createTime": "A String", # Time the release was created.
          # @OutputOnly
      "name": "A String", # Resource name for the `Release`.
          #
          # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
          # which affords developers a great deal of flexibility in mapping the name
          # to the style that best fits their existing development practices. For
          # example, a name could refer to an environment, an app, a version, or some
          # combination of three.
          #
          # In the table below, for the project name `projects/foo`, the following
          # relative release paths show how flat and structured names might be chosen
          # to match a desired development / deployment strategy.
          #
          # Use Case     | Flat Name           | Structured Name
          # -------------|---------------------|----------------
          # Environments | releases/qa         | releases/qa
          # Apps         | releases/app1_qa    | releases/app1/qa
          # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
          #
          # The delimiter between the release name path elements can be almost anything
          # and it should work equally well with the release name list filter, but in
          # many ways the structured paths provide a clearer picture of the
          # relationship between `Release` instances.
          #
          # Format: `projects/{project_id}/releases/{release_id}`
    }
google-api-python-client-1.5.5/docs/dyn/firebaserules_v1.projects.rulesets.html000066400000000000000000000223261300622755700277220ustar00rootroot00000000000000

Firebase Rules API . projects . rulesets

Instance Methods

create(name=None, body, x__xgafv=None)

Create a `Ruleset` from `Source`.

delete(name=None, x__xgafv=None)

Delete a `Ruleset` by resource name.

get(name=None, x__xgafv=None)

Get a `Ruleset` by name including the full `Source` contents.

list(name=None, pageToken=None, x__xgafv=None, pageSize=None)

List `Ruleset` metadata only and optionally filter the results by Ruleset

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(name=None, body, x__xgafv=None) 
Create a `Ruleset` from `Source`.

The `Ruleset` is given a unique generated name which is returned to the
caller. `Source` containing syntactic or semantics errors will result in an
error response indicating the first error encountered. For a detailed view
of `Source` issues, use TestRuleset.

Args:
  name: string, Resource name for Project which owns this `Ruleset`.

Format: `projects/{project_id}` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
      # and a creation time.
    "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
      "files": [ # `File` set constituting the `Source` bundle.
        { # `File` containing source content.
          "content": "A String", # Textual Content.
          "name": "A String", # File name.
          "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
        },
      ],
    },
    "createTime": "A String", # Time the `Ruleset` was created.
        # @OutputOnly
    "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
        # Format: `projects/{project_id}/rulesets/{ruleset_id}`
        # @OutputOnly
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
        # and a creation time.
      "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
        "files": [ # `File` set constituting the `Source` bundle.
          { # `File` containing source content.
            "content": "A String", # Textual Content.
            "name": "A String", # File name.
            "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
          },
        ],
      },
      "createTime": "A String", # Time the `Ruleset` was created.
          # @OutputOnly
      "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
          # Format: `projects/{project_id}/rulesets/{ruleset_id}`
          # @OutputOnly
    }
delete(name=None, x__xgafv=None) 
Delete a `Ruleset` by resource name.

If the `Ruleset` is referenced by a `Release` the operation will fail.

Args:
  name: string, Resource name for the ruleset to delete.

Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name=None, x__xgafv=None) 
Get a `Ruleset` by name including the full `Source` contents.

Args:
  name: string, Resource name for the ruleset to get.

Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
        # and a creation time.
      "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
        "files": [ # `File` set constituting the `Source` bundle.
          { # `File` containing source content.
            "content": "A String", # Textual Content.
            "name": "A String", # File name.
            "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
          },
        ],
      },
      "createTime": "A String", # Time the `Ruleset` was created.
          # @OutputOnly
      "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
          # Format: `projects/{project_id}/rulesets/{ruleset_id}`
          # @OutputOnly
    }
list(name=None, pageToken=None, x__xgafv=None, pageSize=None) 
List `Ruleset` metadata only and optionally filter the results by Ruleset
name.

The full `Source` contents of a `Ruleset` may be retrieved with
GetRuleset.

Args:
  name: string, Resource name for the project.

Format: `projects/{project_id}` (required)
  pageToken: string, Next page token for loading the next batch of `Ruleset` instances.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
Note: `page_size` is just a hint and the service may choose to load less
than `page_size` due to the size of the output. To traverse all of the
releases, caller should iterate until the `page_token` is empty.

Returns:
  An object of the form:

    { # The response for FirebaseRulesService.ListRulesets
    "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
        # empty, no further results remain.
    "rulesets": [ # List of `Ruleset` instances.
      { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
            # and a creation time.
          "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
            "files": [ # `File` set constituting the `Source` bundle.
              { # `File` containing source content.
                "content": "A String", # Textual Content.
                "name": "A String", # File name.
                "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
              },
            ],
          },
          "createTime": "A String", # Time the `Ruleset` was created.
              # @OutputOnly
          "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
              # Format: `projects/{project_id}/rulesets/{ruleset_id}`
              # @OutputOnly
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/fitness_v1.html000066400000000000000000000040751300622755700230460ustar00rootroot00000000000000

Fitness

Instance Methods

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/fitness_v1.users.dataSources.datasets.html000066400000000000000000000534241300622755700302730ustar00rootroot00000000000000

Fitness . users . dataSources . datasets

Instance Methods

delete(userId, dataSourceId, datasetId, modifiedTimeMillis=None, currentTimeMillis=None)

Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID. For most data types, the entire data point will be deleted. For data types where the time span represents a consistent value (such as com.google.activity.segment), and a data point straddles either end point of the dataset, only the overlapping portion of the data point will be deleted.

get(userId, dataSourceId, datasetId, pageToken=None, limit=None)

Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time. Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time.

get_next(previous_request, previous_response)

Retrieves the next page of results.

patch(userId, dataSourceId, datasetId, body, currentTimeMillis=None)

Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics.

Method Details

delete(userId, dataSourceId, datasetId, modifiedTimeMillis=None, currentTimeMillis=None) 
Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID. For most data types, the entire data point will be deleted. For data types where the time span represents a consistent value (such as com.google.activity.segment), and a data point straddles either end point of the dataset, only the overlapping portion of the data point will be deleted.

Args:
  userId: string, Delete a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source that created the dataset. (required)
  datasetId: string, Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers. (required)
  modifiedTimeMillis: string, When the operation was performed on the client.
  currentTimeMillis: string, The client's current time in milliseconds since epoch.
get(userId, dataSourceId, datasetId, pageToken=None, limit=None) 
Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time. Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time.

Args:
  userId: string, Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source that created the dataset. (required)
  datasetId: string, Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers. (required)
  pageToken: string, The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of nextPageToken from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response.
  limit: integer, If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response.

Returns:
  An object of the form:

    { # A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset.
      "minStartTimeNs": "A String", # The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
      "nextPageToken": "A String", # This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset.
      "maxEndTimeNs": "A String", # The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
      "dataSourceId": "A String", # The data stream ID of the data source that created the points in this dataset.
      "point": [ # A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response.
        { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
            #
            # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
            #
            # Data points always contain one value for each field of the data type.
          "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
          "startTimeNanos": "A String", # The start time of the interval represented by this data point, in nanoseconds since epoch.
          "dataTypeName": "A String", # The data type defining the format of the values in this data point.
          "endTimeNanos": "A String", # The end time of the interval represented by this data point, in nanoseconds since epoch.
          "value": [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
              #
              # Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field.
            { # Holder object for the value of a single field in a data point.
                #
                # A field value has a particular format and is only ever set to one of an integer or a floating point value.
              "mapVal": [ # Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
                {
                  "value": { # Holder object for the value of an entry in a map field of a data point.
                      #
                      # A map value supports a subset of the formats that the regular Value supports.
                    "fpVal": 3.14, # Floating point value.
                  },
                  "key": "A String",
                },
              ],
              "fpVal": 3.14, # Floating point value. When this is set, other values must not be set.
              "intVal": 42, # Integer value. When this is set, other values must not be set.
              "stringVal": "A String", # String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
            },
          ],
          "computationTimeMillis": "A String", # Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.
          "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
          "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.
        },
      ],
    }
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.
patch(userId, dataSourceId, datasetId, body, currentTimeMillis=None) 
Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics.

Args:
  userId: string, Patch a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source that created the dataset. (required)
  datasetId: string, Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset.
    "minStartTimeNs": "A String", # The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
    "nextPageToken": "A String", # This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset.
    "maxEndTimeNs": "A String", # The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
    "dataSourceId": "A String", # The data stream ID of the data source that created the points in this dataset.
    "point": [ # A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response.
      { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
          #
          # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
          #
          # Data points always contain one value for each field of the data type.
        "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
        "startTimeNanos": "A String", # The start time of the interval represented by this data point, in nanoseconds since epoch.
        "dataTypeName": "A String", # The data type defining the format of the values in this data point.
        "endTimeNanos": "A String", # The end time of the interval represented by this data point, in nanoseconds since epoch.
        "value": [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
            #
            # Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field.
          { # Holder object for the value of a single field in a data point.
              #
              # A field value has a particular format and is only ever set to one of an integer or a floating point value.
            "mapVal": [ # Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
              {
                "value": { # Holder object for the value of an entry in a map field of a data point.
                    #
                    # A map value supports a subset of the formats that the regular Value supports.
                  "fpVal": 3.14, # Floating point value.
                },
                "key": "A String",
              },
            ],
            "fpVal": 3.14, # Floating point value. When this is set, other values must not be set.
            "intVal": 42, # Integer value. When this is set, other values must not be set.
            "stringVal": "A String", # String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
          },
        ],
        "computationTimeMillis": "A String", # Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.
        "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
        "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.
      },
    ],
  }

  currentTimeMillis: string, The client's current time in milliseconds since epoch. Note that the minStartTimeNs and maxEndTimeNs properties in the request body are in nanoseconds instead of milliseconds.

Returns:
  An object of the form:

    { # A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset.
      "minStartTimeNs": "A String", # The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
      "nextPageToken": "A String", # This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset.
      "maxEndTimeNs": "A String", # The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
      "dataSourceId": "A String", # The data stream ID of the data source that created the points in this dataset.
      "point": [ # A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response.
        { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
            #
            # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
            #
            # Data points always contain one value for each field of the data type.
          "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
          "startTimeNanos": "A String", # The start time of the interval represented by this data point, in nanoseconds since epoch.
          "dataTypeName": "A String", # The data type defining the format of the values in this data point.
          "endTimeNanos": "A String", # The end time of the interval represented by this data point, in nanoseconds since epoch.
          "value": [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
              #
              # Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field.
            { # Holder object for the value of a single field in a data point.
                #
                # A field value has a particular format and is only ever set to one of an integer or a floating point value.
              "mapVal": [ # Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
                {
                  "value": { # Holder object for the value of an entry in a map field of a data point.
                      #
                      # A map value supports a subset of the formats that the regular Value supports.
                    "fpVal": 3.14, # Floating point value.
                  },
                  "key": "A String",
                },
              ],
              "fpVal": 3.14, # Floating point value. When this is set, other values must not be set.
              "intVal": 42, # Integer value. When this is set, other values must not be set.
              "stringVal": "A String", # String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
            },
          ],
          "computationTimeMillis": "A String", # Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.
          "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
          "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/fitness_v1.users.dataSources.html000066400000000000000000002052471300622755700264660ustar00rootroot00000000000000

Fitness . users . dataSources

Instance Methods

datasets()

Returns the datasets Resource.

create(userId, body)

Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.

delete(userId, dataSourceId)

Deletes the specified data source. The request will fail if the data source contains any data points.

get(userId, dataSourceId)

Returns the specified data source.

list(userId, dataTypeName=None)

Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes.

patch(userId, dataSourceId, body)

Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

update(userId, dataSourceId, body)

Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

Method Details

create(userId, body) 
Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.

Args:
  userId: string, Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
    # 
    # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
    # 
    # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
  "name": "A String", # An end-user visible name for this data source.
  "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
  "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
    "field": [ # A field represents one dimension of a data type.
      { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
          #
          # This message is only instantiated in code and not used for wire comms or stored in any way.
        "optional": True or False,
        "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
        "format": "A String", # The different supported formats for each field in a data type.
      },
    ],
    "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
  },
  "dataQualityStandard": [
    "A String",
  ],
  "application": { # Information about an application which feeds sensor data into the platform.
    "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
    "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
    "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
    "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
  },
  "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
      #
      # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
      # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
      # - Display the source of data to the user (by using the device make / model)
      # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
      # - Build different analysis models for each device/version.
    "model": "A String", # End-user visible model name for the device.
    "version": "A String", # Version string for the device hardware/software.
    "type": "A String", # A constant representing the type of the device.
    "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
    "manufacturer": "A String", # Manufacturer of the product/hardware.
  },
  "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
      # 
      # 
      # - The physical device's manufacturer, model, and serial number (UID).
      # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
      # - The data source's type.
      # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
      # 
      # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
      # 
      # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
      # 
      # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
      # 
      # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
  "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
}


Returns:
  An object of the form:

    { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
      #
      # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
      #
      # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
    "name": "A String", # An end-user visible name for this data source.
    "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
    "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
      "field": [ # A field represents one dimension of a data type.
        { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
            #
            # This message is only instantiated in code and not used for wire comms or stored in any way.
          "optional": True or False,
          "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
          "format": "A String", # The different supported formats for each field in a data type.
        },
      ],
      "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
    },
    "dataQualityStandard": [
      "A String",
    ],
    "application": { # Information about an application which feeds sensor data into the platform.
      "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
      "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
      "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    },
    "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
        #
        # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
        # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
        # - Display the source of data to the user (by using the device make / model)
        # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
        # - Build different analysis models for each device/version.
      "model": "A String", # End-user visible model name for the device.
      "version": "A String", # Version string for the device hardware/software.
      "type": "A String", # A constant representing the type of the device.
      "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
      "manufacturer": "A String", # Manufacturer of the product/hardware.
    },
    "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
        #
        #
        # - The physical device's manufacturer, model, and serial number (UID).
        # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
        # - The data source's type.
        # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
        #
        # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
        #
        # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
    "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
  }
delete(userId, dataSourceId) 
Deletes the specified data source. The request will fail if the data source contains any data points.

Args:
  userId: string, Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source to delete. (required)

Returns:
  An object of the form:

    { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
      #
      # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
      #
      # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
    "name": "A String", # An end-user visible name for this data source.
    "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
    "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
      "field": [ # A field represents one dimension of a data type.
        { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
            #
            # This message is only instantiated in code and not used for wire comms or stored in any way.
          "optional": True or False,
          "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
          "format": "A String", # The different supported formats for each field in a data type.
        },
      ],
      "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
    },
    "dataQualityStandard": [
      "A String",
    ],
    "application": { # Information about an application which feeds sensor data into the platform.
      "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
      "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
      "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    },
    "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
        #
        # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
        # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
        # - Display the source of data to the user (by using the device make / model)
        # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
        # - Build different analysis models for each device/version.
      "model": "A String", # End-user visible model name for the device.
      "version": "A String", # Version string for the device hardware/software.
      "type": "A String", # A constant representing the type of the device.
      "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
      "manufacturer": "A String", # Manufacturer of the product/hardware.
    },
    "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
        #
        #
        # - The physical device's manufacturer, model, and serial number (UID).
        # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
        # - The data source's type.
        # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
        #
        # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
        #
        # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
    "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
  }
get(userId, dataSourceId) 
Returns the specified data source.

Args:
  userId: string, Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source to retrieve. (required)

Returns:
  An object of the form:

    { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
      #
      # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
      #
      # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
    "name": "A String", # An end-user visible name for this data source.
    "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
    "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
      "field": [ # A field represents one dimension of a data type.
        { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
            #
            # This message is only instantiated in code and not used for wire comms or stored in any way.
          "optional": True or False,
          "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
          "format": "A String", # The different supported formats for each field in a data type.
        },
      ],
      "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
    },
    "dataQualityStandard": [
      "A String",
    ],
    "application": { # Information about an application which feeds sensor data into the platform.
      "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
      "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
      "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    },
    "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
        #
        # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
        # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
        # - Display the source of data to the user (by using the device make / model)
        # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
        # - Build different analysis models for each device/version.
      "model": "A String", # End-user visible model name for the device.
      "version": "A String", # Version string for the device hardware/software.
      "type": "A String", # A constant representing the type of the device.
      "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
      "manufacturer": "A String", # Manufacturer of the product/hardware.
    },
    "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
        #
        #
        # - The physical device's manufacturer, model, and serial number (UID).
        # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
        # - The data source's type.
        # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
        #
        # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
        #
        # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
    "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
  }
list(userId, dataTypeName=None) 
Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes.

Args:
  userId: string, List data sources for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataTypeName: string, The names of data types to include in the list. If not specified, all data sources will be returned. (repeated)

Returns:
  An object of the form:

    {
    "dataSource": [ # A previously created data source.
      { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
          #
          # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
          #
          # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
        "name": "A String", # An end-user visible name for this data source.
        "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
        "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
          "field": [ # A field represents one dimension of a data type.
            { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
                #
                # This message is only instantiated in code and not used for wire comms or stored in any way.
              "optional": True or False,
              "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
              "format": "A String", # The different supported formats for each field in a data type.
            },
          ],
          "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
        },
        "dataQualityStandard": [
          "A String",
        ],
        "application": { # Information about an application which feeds sensor data into the platform.
          "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
          "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
          "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
          "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
        },
        "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
            #
            # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
            # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
            # - Display the source of data to the user (by using the device make / model)
            # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
            # - Build different analysis models for each device/version.
          "model": "A String", # End-user visible model name for the device.
          "version": "A String", # Version string for the device hardware/software.
          "type": "A String", # A constant representing the type of the device.
          "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
          "manufacturer": "A String", # Manufacturer of the product/hardware.
        },
        "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
            #
            #
            # - The physical device's manufacturer, model, and serial number (UID).
            # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
            # - The data source's type.
            # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
            #
            # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
            #
            # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
            #
            # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
            #
            # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
        "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
      },
    ],
  }
patch(userId, dataSourceId, body) 
Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

Data sources are identified by their dataStreamId. This method supports patch semantics.

Args:
  userId: string, Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
    # 
    # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
    # 
    # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
  "name": "A String", # An end-user visible name for this data source.
  "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
  "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
    "field": [ # A field represents one dimension of a data type.
      { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
          #
          # This message is only instantiated in code and not used for wire comms or stored in any way.
        "optional": True or False,
        "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
        "format": "A String", # The different supported formats for each field in a data type.
      },
    ],
    "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
  },
  "dataQualityStandard": [
    "A String",
  ],
  "application": { # Information about an application which feeds sensor data into the platform.
    "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
    "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
    "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
    "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
  },
  "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
      #
      # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
      # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
      # - Display the source of data to the user (by using the device make / model)
      # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
      # - Build different analysis models for each device/version.
    "model": "A String", # End-user visible model name for the device.
    "version": "A String", # Version string for the device hardware/software.
    "type": "A String", # A constant representing the type of the device.
    "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
    "manufacturer": "A String", # Manufacturer of the product/hardware.
  },
  "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
      # 
      # 
      # - The physical device's manufacturer, model, and serial number (UID).
      # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
      # - The data source's type.
      # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
      # 
      # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
      # 
      # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
      # 
      # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
      # 
      # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
  "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
}


Returns:
  An object of the form:

    { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
      #
      # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
      #
      # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
    "name": "A String", # An end-user visible name for this data source.
    "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
    "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
      "field": [ # A field represents one dimension of a data type.
        { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
            #
            # This message is only instantiated in code and not used for wire comms or stored in any way.
          "optional": True or False,
          "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
          "format": "A String", # The different supported formats for each field in a data type.
        },
      ],
      "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
    },
    "dataQualityStandard": [
      "A String",
    ],
    "application": { # Information about an application which feeds sensor data into the platform.
      "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
      "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
      "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    },
    "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
        #
        # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
        # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
        # - Display the source of data to the user (by using the device make / model)
        # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
        # - Build different analysis models for each device/version.
      "model": "A String", # End-user visible model name for the device.
      "version": "A String", # Version string for the device hardware/software.
      "type": "A String", # A constant representing the type of the device.
      "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
      "manufacturer": "A String", # Manufacturer of the product/hardware.
    },
    "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
        #
        #
        # - The physical device's manufacturer, model, and serial number (UID).
        # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
        # - The data source's type.
        # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
        #
        # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
        #
        # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
    "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
  }
update(userId, dataSourceId, body) 
Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

Data sources are identified by their dataStreamId.

Args:
  userId: string, Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  dataSourceId: string, The data stream ID of the data source to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
    # 
    # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
    # 
    # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
  "name": "A String", # An end-user visible name for this data source.
  "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
  "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
    "field": [ # A field represents one dimension of a data type.
      { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
          #
          # This message is only instantiated in code and not used for wire comms or stored in any way.
        "optional": True or False,
        "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
        "format": "A String", # The different supported formats for each field in a data type.
      },
    ],
    "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
  },
  "dataQualityStandard": [
    "A String",
  ],
  "application": { # Information about an application which feeds sensor data into the platform.
    "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
    "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
    "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
    "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
  },
  "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
      #
      # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
      # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
      # - Display the source of data to the user (by using the device make / model)
      # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
      # - Build different analysis models for each device/version.
    "model": "A String", # End-user visible model name for the device.
    "version": "A String", # Version string for the device hardware/software.
    "type": "A String", # A constant representing the type of the device.
    "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
    "manufacturer": "A String", # Manufacturer of the product/hardware.
  },
  "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
      # 
      # 
      # - The physical device's manufacturer, model, and serial number (UID).
      # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
      # - The data source's type.
      # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
      # 
      # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
      # 
      # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
      # 
      # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
      # 
      # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
  "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
}


Returns:
  An object of the form:

    { # Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.
      #
      # The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.
      #
      # Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
    "name": "A String", # An end-user visible name for this data source.
    "dataStreamName": "A String", # The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
    "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
      "field": [ # A field represents one dimension of a data type.
        { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
            #
            # This message is only instantiated in code and not used for wire comms or stored in any way.
          "optional": True or False,
          "name": "A String", # Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
          "format": "A String", # The different supported formats for each field in a data type.
        },
      ],
      "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
    },
    "dataQualityStandard": [
      "A String",
    ],
    "application": { # Information about an application which feeds sensor data into the platform.
      "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
      "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
      "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    },
    "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
        #
        # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
        # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
        # - Display the source of data to the user (by using the device make / model)
        # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
        # - Build different analysis models for each device/version.
      "model": "A String", # End-user visible model name for the device.
      "version": "A String", # Version string for the device hardware/software.
      "type": "A String", # A constant representing the type of the device.
      "uid": "A String", # The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
      "manufacturer": "A String", # Manufacturer of the product/hardware.
    },
    "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
        #
        #
        # - The physical device's manufacturer, model, and serial number (UID).
        # - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
        # - The data source's type.
        # - The data source's stream name.  Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.
        #
        # The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName
        #
        # When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minnimum viable data stream ID would be: type:dataType.name:developer project number
        #
        # Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.
    "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
  }
google-api-python-client-1.5.5/docs/dyn/fitness_v1.users.dataset.html000066400000000000000000000331621300622755700256310ustar00rootroot00000000000000

Fitness . users . dataset

Instance Methods

aggregate(userId, body)

Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request.

Method Details

aggregate(userId, body) 
Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request.

Args:
  userId: string, Aggregate data for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Next id: 10
    "aggregateBy": [ # The specification of data to be aggregated. At least one aggregateBy spec must be provided. All data that is specified will be aggregated using the same bucketing criteria. There will be one dataset in the response for every aggregateBy spec.
      { # The specification of which data to aggregate.
        "dataSourceId": "A String", # A data source ID to aggregate. Mutually exclusive of dataTypeName. Only data from the specified data source ID will be included in the aggregation. The dataset in the response will have the same data source ID.
        "dataTypeName": "A String", # The data type to aggregate. All data sources providing this data type will contribute data to the aggregation. The response will contain a single dataset for this data type name. The dataset will have a data source ID of derived:com.google.:com.google.android.gms:aggregated
      },
    ],
    "bucketByActivitySegment": { # Specifies that data be aggregated each activity segment recored for a user. Similar to bucketByActivitySegment, but bucketing is done for each activity segment rather than all segments of the same type. Mutually exclusive of other bucketing specifications.
      "activityDataSourceId": "A String", # The default activity stream will be used if a specific activityDataSourceId is not specified.
      "minDurationMillis": "A String", # Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data.
    },
    "endTimeMillis": "A String", # The end of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive.
    "bucketBySession": { # Specifies that data be aggregated by user sessions. Data that does not fall within the time range of a session will not be included in the response. Mutually exclusive of other bucketing specifications.
      "minDurationMillis": "A String", # Specifies that only sessions of duration longer than minDurationMillis are considered and used as a container for aggregated data.
    },
    "bucketByActivityType": { # Specifies that data be aggregated by the type of activity being performed when the data was recorded. All data that was recorded during a certain activity type (for the given time range) will be aggregated into the same bucket. Data that was recorded while the user was not active will not be included in the response. Mutually exclusive of other bucketing specifications.
      "activityDataSourceId": "A String", # The default activity stream will be used if a specific activityDataSourceId is not specified.
      "minDurationMillis": "A String", # Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data.
    },
    "startTimeMillis": "A String", # The start of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive.
    "filteredDataQualityStandard": [ # A list of acceptable data quality standards. Only data points which conform to at least one of the specified data quality standards will be returned. If the list is empty, all data points are returned.
      "A String",
    ],
    "bucketByTime": { # Specifies that data be aggregated by a single time interval. Mutually exclusive of other bucketing specifications.
      "durationMillis": "A String", # Specifies that result buckets aggregate data by exactly durationMillis time frames. Time frames that contain no data will be included in the response with an empty dataset.
      "period": {
        "timeZoneId": "A String", # org.joda.timezone.DateTimeZone
        "type": "A String",
        "value": 42,
      },
    },
  }


Returns:
  An object of the form:

    {
    "bucket": [ # A list of buckets containing the aggregated data.
      {
        "endTimeMillis": "A String", # The end time for the aggregated data, in milliseconds since epoch, inclusive.
        "dataset": [ # There will be one dataset per AggregateBy in the request.
          { # A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset.
              "minStartTimeNs": "A String", # The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
              "nextPageToken": "A String", # This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset.
              "maxEndTimeNs": "A String", # The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier.
              "dataSourceId": "A String", # The data stream ID of the data source that created the points in this dataset.
              "point": [ # A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response.
                { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
                    #
                    # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
                    #
                    # Data points always contain one value for each field of the data type.
                  "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
                  "startTimeNanos": "A String", # The start time of the interval represented by this data point, in nanoseconds since epoch.
                  "dataTypeName": "A String", # The data type defining the format of the values in this data point.
                  "endTimeNanos": "A String", # The end time of the interval represented by this data point, in nanoseconds since epoch.
                  "value": [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
                      #
                      # Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field.
                    { # Holder object for the value of a single field in a data point.
                        #
                        # A field value has a particular format and is only ever set to one of an integer or a floating point value.
                      "mapVal": [ # Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
                        {
                          "value": { # Holder object for the value of an entry in a map field of a data point.
                              #
                              # A map value supports a subset of the formats that the regular Value supports.
                            "fpVal": 3.14, # Floating point value.
                          },
                          "key": "A String",
                        },
                      ],
                      "fpVal": 3.14, # Floating point value. When this is set, other values must not be set.
                      "intVal": 42, # Integer value. When this is set, other values must not be set.
                      "stringVal": "A String", # String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
                    },
                  ],
                  "computationTimeMillis": "A String", # Used for version checking during transformation; that is, a datapoint can only replace another datapoint that has an older computation time stamp.
                  "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
                  "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.
                },
              ],
            },
        ],
        "session": { # Sessions contain metadata, such as a user-friendly name and time interval information. # Available for Bucket.Type.SESSION
          "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
          "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
          "description": "A String", # A description for this session.
          "activityType": 42, # The type of activity this session represents.
          "application": { # The application that created the session.
            "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
            "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
            "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
            "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
          },
          "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
          "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
          "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
          "name": "A String", # A human readable name of the session.
        },
        "activity": 42, # Available for Bucket.Type.ACTIVITY_TYPE, Bucket.Type.ACTIVITY_SEGMENT
        "startTimeMillis": "A String", # The start time for the aggregated data, in milliseconds since epoch, inclusive.
        "type": "A String", # The type of a bucket signifies how the data aggregation is performed in the bucket.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/fitness_v1.users.html000066400000000000000000000030111300622755700241730ustar00rootroot00000000000000

Fitness . users

Instance Methods

dataSources()

Returns the dataSources Resource.

dataset()

Returns the dataset Resource.

sessions()

Returns the sessions Resource.

google-api-python-client-1.5.5/docs/dyn/fitness_v1.users.sessions.html000066400000000000000000000315631300622755700260550ustar00rootroot00000000000000

Fitness . users . sessions

Instance Methods

delete(userId, sessionId, currentTimeMillis=None)

Deletes a session specified by the given session ID.

list(userId, includeDeleted=None, pageToken=None, startTime=None, endTime=None)

Lists sessions previously created.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(userId, sessionId, body, currentTimeMillis=None)

Updates or insert a given session.

Method Details

delete(userId, sessionId, currentTimeMillis=None) 
Deletes a session specified by the given session ID.

Args:
  userId: string, Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  sessionId: string, The ID of the session to be deleted. (required)
  currentTimeMillis: string, The client's current time in milliseconds since epoch.
list(userId, includeDeleted=None, pageToken=None, startTime=None, endTime=None) 
Lists sessions previously created.

Args:
  userId: string, List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  includeDeleted: boolean, If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields.
  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.
  startTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.
  endTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.

Returns:
  An object of the form:

    {
    "hasMoreData": True or False, # Flag to indicate server has more data to transfer
    "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.
    "deletedSession": [ # If includeDeleted is set to true in the request, this list will contain sessions deleted with original end times that are within the startTime and endTime frame.
      { # Sessions contain metadata, such as a user-friendly name and time interval information.
        "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
        "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
        "description": "A String", # A description for this session.
        "activityType": 42, # The type of activity this session represents.
        "application": { # The application that created the session.
          "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
          "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
          "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
          "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
        },
        "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
        "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
        "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
        "name": "A String", # A human readable name of the session.
      },
    ],
    "session": [ # Sessions with an end time that is between startTime and endTime of the request.
      { # Sessions contain metadata, such as a user-friendly name and time interval information.
        "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
        "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
        "description": "A String", # A description for this session.
        "activityType": 42, # The type of activity this session represents.
        "application": { # The application that created the session.
          "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
          "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
          "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
          "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
        },
        "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
        "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
        "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
        "name": "A String", # A human readable name of the session.
      },
    ],
  }
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(userId, sessionId, body, currentTimeMillis=None) 
Updates or insert a given session.

Args:
  userId: string, Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  sessionId: string, The ID of the session to be created. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Sessions contain metadata, such as a user-friendly name and time interval information.
  "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
  "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
  "description": "A String", # A description for this session.
  "activityType": 42, # The type of activity this session represents.
  "application": { # The application that created the session.
    "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
    "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
    "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
    "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
  },
  "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
  "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
  "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
  "name": "A String", # A human readable name of the session.
}

  currentTimeMillis: string, The client's current time in milliseconds since epoch.

Returns:
  An object of the form:

    { # Sessions contain metadata, such as a user-friendly name and time interval information.
    "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
    "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
    "description": "A String", # A description for this session.
    "activityType": 42, # The type of activity this session represents.
    "application": { # The application that created the session.
      "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
      "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
      "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    },
    "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
    "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
    "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
    "name": "A String", # A human readable name of the session.
  }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.column.html000066400000000000000000000311271300622755700253630ustar00rootroot00000000000000

Fusion Tables API . column

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.
      "description": "A String", # Optional column description.
      "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.
      },
      "columnId": 42, # Identifier for the column.
      "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
      "type": "A String", # Required type of the column.
      "name": "A String", # Required name of the column.
    }
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.
    "description": "A String", # Optional column description.
    "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.
    },
    "columnId": 42, # Identifier for the column.
    "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
    "type": "A String", # Required type of the column.
    "name": "A String", # Required name of the column.
  }


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.
      "description": "A String", # Optional column description.
      "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.
      },
      "columnId": 42, # Identifier for the column.
      "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
      "type": "A String", # Required type of the column.
      "name": "A String", # Required name of the column.
    }
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 pages 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.
          "description": "A String", # Optional column description.
          "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.
          },
          "columnId": 42, # Identifier for the column.
          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
          "type": "A String", # Required type of the column.
          "name": "A String", # Required name of the column.
        },
    ],
    "kind": "fusiontables#columnList", # Type name: a list of all columns.
    "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.
    "description": "A String", # Optional column description.
    "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.
    },
    "columnId": 42, # Identifier for the column.
    "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
    "type": "A String", # Required type of the column.
    "name": "A String", # Required name of the column.
  }


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.
      "description": "A String", # Optional column description.
      "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.
      },
      "columnId": 42, # Identifier for the column.
      "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
      "type": "A String", # Required type of the column.
      "name": "A String", # Required name of the column.
    }
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.
    "description": "A String", # Optional column description.
    "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.
    },
    "columnId": 42, # Identifier for the column.
    "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
    "type": "A String", # Required type of the column.
    "name": "A String", # Required name of the column.
  }


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.
      "description": "A String", # Optional column description.
      "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.
      },
      "columnId": 42, # Identifier for the column.
      "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
      "type": "A String", # Required type of the column.
      "name": "A String", # Required name of the column.
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.html000066400000000000000000000054711300622755700240720ustar00rootroot00000000000000

Fusion Tables API

Instance Methods

column()

Returns the column Resource.

query()

Returns the query Resource.

style()

Returns the style Resource.

table()

Returns the table Resource.

task()

Returns the task Resource.

template()

Returns the template Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.query.html000066400000000000000000000115421300622755700252320ustar00rootroot00000000000000

Fusion Tables API . query

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.

sqlGet_media(sql, hdrs=None, typed=None)

Executes an SQL SELECT/SHOW/DESCRIBE statement.

sql_media(sql, hdrs=None, typed=None)

Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE 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",
    ],
  }
sqlGet_media(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:
  The media object as a string.
sql_media(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:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.style.html000066400000000000000000003657221300622755700252410ustar00rootroot00000000000000

Fusion Tables API . style

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 pages 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).
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.table.html000066400000000000000000000667231300622755700251670ustar00rootroot00000000000000

Fusion Tables API . table

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.
            "description": "A String", # Optional column description.
            "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.
            },
            "columnId": 42, # Identifier for the column.
            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
            "type": "A String", # Required type of the column.
            "name": "A String", # Required name of the column.
          },
      ],
      "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.
            "description": "A String", # Optional column description.
            "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.
            },
            "columnId": 42, # Identifier for the column.
            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
            "type": "A String", # Required type of the column.
            "name": "A String", # Required name of the column.
          },
      ],
      "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.
            "description": "A String", # Optional column description.
            "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.
            },
            "columnId": 42, # Identifier for the column.
            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
            "type": "A String", # Required type of the column.
            "name": "A String", # Required name of the column.
          },
      ],
      "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.
          "description": "A String", # Optional column description.
          "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.
          },
          "columnId": 42, # Identifier for the column.
          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
          "type": "A String", # Required type of the column.
          "name": "A String", # Required name of the column.
        },
    ],
    "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.
            "description": "A String", # Optional column description.
            "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.
            },
            "columnId": 42, # Identifier for the column.
            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
            "type": "A String", # Required type of the column.
            "name": "A String", # Required name of the column.
          },
      ],
      "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 pages 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.
                "description": "A String", # Optional column description.
                "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.
                },
                "columnId": 42, # Identifier for the column.
                "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
                "type": "A String", # Required type of the column.
                "name": "A String", # Required name of the column.
              },
          ],
          "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.
          "description": "A String", # Optional column description.
          "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.
          },
          "columnId": 42, # Identifier for the column.
          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
          "type": "A String", # Required type of the column.
          "name": "A String", # Required name of the column.
        },
    ],
    "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.
            "description": "A String", # Optional column description.
            "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.
            },
            "columnId": 42, # Identifier for the column.
            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
            "type": "A String", # Required type of the column.
            "name": "A String", # Required name of the column.
          },
      ],
      "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.
          "description": "A String", # Optional column description.
          "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.
          },
          "columnId": 42, # Identifier for the column.
          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
          "type": "A String", # Required type of the column.
          "name": "A String", # Required name of the column.
        },
    ],
    "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.
            "description": "A String", # Optional column description.
            "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.
            },
            "columnId": 42, # Identifier for the column.
            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
            "type": "A String", # Required type of the column.
            "name": "A String", # Required name of the column.
          },
      ],
      "name": "A String", # Name assigned to a table.
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.task.html000066400000000000000000000121001300622755700250160ustar00rootroot00000000000000

Fusion Tables API . task

Instance Methods

delete(tableId, taskId)

Deletes the task, unless already started.

get(tableId, taskId)

Retrieves a specific task by its id.

list(tableId, pageToken=None, maxResults=None, startIndex=None)

Retrieves a list of tasks.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(tableId, taskId) 
Deletes the task, unless already started.

Args:
  tableId: string, Table from which the task is being deleted. (required)
  taskId: string, A parameter (required)
get(tableId, taskId) 
Retrieves a specific task by its id.

Args:
  tableId: string, Table to which the task belongs. (required)
  taskId: string, A parameter (required)

Returns:
  An object of the form:

    { # Specifies the identifier, name, and type of a task in a table.
    "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
    "progress": "A String", # An indication of task progress.
    "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
    "type": "A String", # Type of background task. One of  DELETE_ROWS Deletes one or more rows from the table. ADD_ROWS "Adds one or more rows to a table. Includes importing data into a new table and importing more rows into an existing table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the type of a column.
    "taskId": "A String", # Identifier for the task.
  }
list(tableId, pageToken=None, maxResults=None, startIndex=None) 
Retrieves a list of tasks.

Args:
  tableId: string, Table whose tasks are being listed. (required)
  pageToken: string, A parameter
  maxResults: integer, Maximum number of columns to return. Optional. Default is 5.
  startIndex: integer, A parameter

Returns:
  An object of the form:

    { # Represents a list of tasks for a table.
    "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
    "items": [ # List of all requested tasks.
      { # Specifies the identifier, name, and type of a task in a table.
        "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
        "progress": "A String", # An indication of task progress.
        "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
        "type": "A String", # Type of background task. One of  DELETE_ROWS Deletes one or more rows from the table. ADD_ROWS "Adds one or more rows to a table. Includes importing data into a new table and importing more rows into an existing table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the type of a column.
        "taskId": "A String", # Identifier for the task.
      },
    ],
    "kind": "fusiontables#taskList", # Type of the resource. This is always "fusiontables#taskList".
    "totalItems": 42, # Total number of tasks 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.
google-api-python-client-1.5.5/docs/dyn/fusiontables_v1.template.html000066400000000000000000000317041300622755700257020ustar00rootroot00000000000000

Fusion Tables API . template

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 pages 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.
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.column.html000066400000000000000000000715661300622755700253770ustar00rootroot00000000000000

Fusion Tables API . column

Instance Methods

delete(tableId, columnId)

Deletes the specified 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 specified 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 details of a column in a table.
      "graphPredicate": "A String", # Column graph predicate.
          # Used to map table to graph data model (subject,predicate,object)
          # See W3C Graph-based Data Model.
      "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
      "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
        "A String",
      ],
      "description": "A String", # Column description.
      "baseColumn": { # 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 of the column.
      "columnPropertiesJson": "A String", # JSON object containing custom column properties.
      "formatPattern": "A String", # Format pattern.
          # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
      "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
      "type": "A String", # Type of the column.
      "validateData": True or False, # If true, data entered via the web application is validated.
      "columnId": 42, # Identifier for the column.
    }
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 details of a column in a table.
    "graphPredicate": "A String", # Column graph predicate.
        # Used to map table to graph data model (subject,predicate,object)
        # See W3C Graph-based Data Model.
    "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
    "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
      "A String",
    ],
    "description": "A String", # Column description.
    "baseColumn": { # 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 of the column.
    "columnPropertiesJson": "A String", # JSON object containing custom column properties.
    "formatPattern": "A String", # Format pattern.
        # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
    "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
    "type": "A String", # Type of the column.
    "validateData": True or False, # If true, data entered via the web application is validated.
    "columnId": 42, # Identifier for the column.
  }


Returns:
  An object of the form:

    { # Specifies the details of a column in a table.
      "graphPredicate": "A String", # Column graph predicate.
          # Used to map table to graph data model (subject,predicate,object)
          # See W3C Graph-based Data Model.
      "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
      "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
        "A String",
      ],
      "description": "A String", # Column description.
      "baseColumn": { # 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 of the column.
      "columnPropertiesJson": "A String", # JSON object containing custom column properties.
      "formatPattern": "A String", # Format pattern.
          # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
      "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
      "type": "A String", # Type of the column.
      "validateData": True or False, # If true, data entered via the web application is validated.
      "columnId": 42, # Identifier for the column.
    }
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.
  maxResults: integer, Maximum number of columns to return. 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 pages left.
    "items": [ # List of all requested columns.
      { # Specifies the details of a column in a table.
          "graphPredicate": "A String", # Column graph predicate.
              # Used to map table to graph data model (subject,predicate,object)
              # See W3C Graph-based Data Model.
          "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
          "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
            "A String",
          ],
          "description": "A String", # Column description.
          "baseColumn": { # 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 of the column.
          "columnPropertiesJson": "A String", # JSON object containing custom column properties.
          "formatPattern": "A String", # Format pattern.
              # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
          "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
          "type": "A String", # Type of the column.
          "validateData": True or False, # If true, data entered via the web application is validated.
          "columnId": 42, # Identifier for the column.
        },
    ],
    "kind": "fusiontables#columnList", # The kind of item this is. For a column list, this is always fusiontables#columnList.
    "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 details of a column in a table.
    "graphPredicate": "A String", # Column graph predicate.
        # Used to map table to graph data model (subject,predicate,object)
        # See W3C Graph-based Data Model.
    "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
    "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
      "A String",
    ],
    "description": "A String", # Column description.
    "baseColumn": { # 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 of the column.
    "columnPropertiesJson": "A String", # JSON object containing custom column properties.
    "formatPattern": "A String", # Format pattern.
        # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
    "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
    "type": "A String", # Type of the column.
    "validateData": True or False, # If true, data entered via the web application is validated.
    "columnId": 42, # Identifier for the column.
  }


Returns:
  An object of the form:

    { # Specifies the details of a column in a table.
      "graphPredicate": "A String", # Column graph predicate.
          # Used to map table to graph data model (subject,predicate,object)
          # See W3C Graph-based Data Model.
      "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
      "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
        "A String",
      ],
      "description": "A String", # Column description.
      "baseColumn": { # 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 of the column.
      "columnPropertiesJson": "A String", # JSON object containing custom column properties.
      "formatPattern": "A String", # Format pattern.
          # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
      "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
      "type": "A String", # Type of the column.
      "validateData": True or False, # If true, data entered via the web application is validated.
      "columnId": 42, # Identifier for the column.
    }
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 details of a column in a table.
    "graphPredicate": "A String", # Column graph predicate.
        # Used to map table to graph data model (subject,predicate,object)
        # See W3C Graph-based Data Model.
    "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
    "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
      "A String",
    ],
    "description": "A String", # Column description.
    "baseColumn": { # 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 of the column.
    "columnPropertiesJson": "A String", # JSON object containing custom column properties.
    "formatPattern": "A String", # Format pattern.
        # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
    "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
    "type": "A String", # Type of the column.
    "validateData": True or False, # If true, data entered via the web application is validated.
    "columnId": 42, # Identifier for the column.
  }


Returns:
  An object of the form:

    { # Specifies the details of a column in a table.
      "graphPredicate": "A String", # Column graph predicate.
          # Used to map table to graph data model (subject,predicate,object)
          # See W3C Graph-based Data Model.
      "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
      "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
        "A String",
      ],
      "description": "A String", # Column description.
      "baseColumn": { # 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 of the column.
      "columnPropertiesJson": "A String", # JSON object containing custom column properties.
      "formatPattern": "A String", # Format pattern.
          # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
      "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
      "type": "A String", # Type of the column.
      "validateData": True or False, # If true, data entered via the web application is validated.
      "columnId": 42, # Identifier for the column.
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.html000066400000000000000000000054711300622755700240730ustar00rootroot00000000000000

Fusion Tables API

Instance Methods

column()

Returns the column Resource.

query()

Returns the query Resource.

style()

Returns the style Resource.

table()

Returns the table Resource.

task()

Returns the task Resource.

template()

Returns the template Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.query.html000066400000000000000000000124041300622755700252310ustar00rootroot00000000000000

Fusion Tables API . query

Instance Methods

sql(sql=None, hdrs=None, typed=None)

Executes a Fusion Tables SQL statement, which can be any of

sqlGet(sql=None, hdrs=None, typed=None)

Executes a SQL statement which can be any of

sqlGet_media(sql=None, hdrs=None, typed=None)

Executes a SQL statement which can be any of

sql_media(sql=None, hdrs=None, typed=None)

Executes a Fusion Tables SQL statement, which can be any of

Method Details

sql(sql=None, hdrs=None, typed=None) 
Executes a Fusion Tables SQL statement, which can be any of 
- SELECT
- INSERT
- UPDATE
- DELETE
- SHOW
- DESCRIBE
- CREATE statement.

Args:
  sql: string, A Fusion Tables SQL statement, which can be any of 
- SELECT
- INSERT
- UPDATE
- DELETE
- SHOW
- DESCRIBE
- CREATE (required)
  hdrs: boolean, Whether column names are included in the first row. Default is true.
  typed: boolean, Whether typed values are 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 a SQL statement.
    "kind": "fusiontables#sqlresponse", # The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse.
    "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=None, hdrs=None, typed=None) 
Executes a SQL statement which can be any of 
- SELECT
- SHOW
- DESCRIBE

Args:
  sql: string, A SQL statement which can be any of 
- SELECT
- SHOW
- DESCRIBE (required)
  hdrs: boolean, Whether column names are included (in the first row). Default is true.
  typed: boolean, Whether typed values are 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 a SQL statement.
    "kind": "fusiontables#sqlresponse", # The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse.
    "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_media(sql=None, hdrs=None, typed=None) 
Executes a SQL statement which can be any of 
- SELECT
- SHOW
- DESCRIBE

Args:
  sql: string, A SQL statement which can be any of 
- SELECT
- SHOW
- DESCRIBE (required)
  hdrs: boolean, Whether column names are included (in the first row). Default is true.
  typed: boolean, Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true.

Returns:
  The media object as a string.
sql_media(sql=None, hdrs=None, typed=None) 
Executes a Fusion Tables SQL statement, which can be any of 
- SELECT
- INSERT
- UPDATE
- DELETE
- SHOW
- DESCRIBE
- CREATE statement.

Args:
  sql: string, A Fusion Tables SQL statement, which can be any of 
- SELECT
- INSERT
- UPDATE
- DELETE
- SHOW
- DESCRIBE
- CREATE (required)
  hdrs: boolean, Whether column names are included in the first row. Default is true.
  typed: boolean, Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true.

Returns:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.style.html000066400000000000000000003652431300622755700252400ustar00rootroot00000000000000

Fusion Tables API . style

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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. For a style list, this is always fusiontables#styleSettingList .
    "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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. A StyleSetting contains the style definitions 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", # The kind of item this is. A StyleSetting contains the style definitions 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).
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.table.html000066400000000000000000001504151300622755700251600ustar00rootroot00000000000000

Fusion Tables API . table

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)

Imports more rows into a table.

importTable(name, media_body=None, encoding=None, delimiter=None)

Imports 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.

replaceRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None)

Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready.

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.
      "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
      "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
      "attribution": "A String", # Attribution assigned to the table.
      "description": "A String", # Description assigned to the table.
      "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
      "isExportable": True or False, # Variable for whether table is exportable.
      "baseTableIds": [ # Base table identifier if this table is a view or merged table.
        "A String",
      ],
      "tablePropertiesJson": "A String", # JSON object containing custom table properties.
      "attributionLink": "A String", # Optional link for attribution.
      "sql": "A String", # 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 details of a column in a table.
            "graphPredicate": "A String", # Column graph predicate.
                # Used to map table to graph data model (subject,predicate,object)
                # See W3C Graph-based Data Model.
            "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
            "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
              "A String",
            ],
            "description": "A String", # Column description.
            "baseColumn": { # 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 of the column.
            "columnPropertiesJson": "A String", # JSON object containing custom column properties.
            "formatPattern": "A String", # Format pattern.
                # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
            "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
            "type": "A String", # Type of the column.
            "validateData": True or False, # If true, data entered via the web application is validated.
            "columnId": 42, # Identifier for the column.
          },
      ],
      "name": "A String", # Name assigned to a table.
    }
delete(tableId) 
Deletes a table.

Args:
  tableId: string, ID of the table to be deleted. (required)
get(tableId) 
Retrieves a specific table by its ID.

Args:
  tableId: string, Identifier for the table being requested. (required)

Returns:
  An object of the form:

    { # Represents a table.
      "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
      "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
      "attribution": "A String", # Attribution assigned to the table.
      "description": "A String", # Description assigned to the table.
      "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
      "isExportable": True or False, # Variable for whether table is exportable.
      "baseTableIds": [ # Base table identifier if this table is a view or merged table.
        "A String",
      ],
      "tablePropertiesJson": "A String", # JSON object containing custom table properties.
      "attributionLink": "A String", # Optional link for attribution.
      "sql": "A String", # 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 details of a column in a table.
            "graphPredicate": "A String", # Column graph predicate.
                # Used to map table to graph data model (subject,predicate,object)
                # See W3C Graph-based Data Model.
            "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
            "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
              "A String",
            ],
            "description": "A String", # Column description.
            "baseColumn": { # 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 of the column.
            "columnPropertiesJson": "A String", # JSON object containing custom column properties.
            "formatPattern": "A String", # Format pattern.
                # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
            "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
            "type": "A String", # Type of the column.
            "validateData": True or False, # If true, data entered via the web application is validated.
            "columnId": 42, # Identifier for the column.
          },
      ],
      "name": "A String", # Name assigned to a table.
    }
importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None) 
Imports 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 imported 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 line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.

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", # The kind of item this is. For an import, this is always fusiontables#import.
  }
importTable(name, media_body=None, encoding=None, delimiter=None) 
Imports 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.
      "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
      "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
      "attribution": "A String", # Attribution assigned to the table.
      "description": "A String", # Description assigned to the table.
      "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
      "isExportable": True or False, # Variable for whether table is exportable.
      "baseTableIds": [ # Base table identifier if this table is a view or merged table.
        "A String",
      ],
      "tablePropertiesJson": "A String", # JSON object containing custom table properties.
      "attributionLink": "A String", # Optional link for attribution.
      "sql": "A String", # 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 details of a column in a table.
            "graphPredicate": "A String", # Column graph predicate.
                # Used to map table to graph data model (subject,predicate,object)
                # See W3C Graph-based Data Model.
            "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
            "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
              "A String",
            ],
            "description": "A String", # Column description.
            "baseColumn": { # 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 of the column.
            "columnPropertiesJson": "A String", # JSON object containing custom column properties.
            "formatPattern": "A String", # Format pattern.
                # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
            "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
            "type": "A String", # Type of the column.
            "validateData": True or False, # If true, data entered via the web application is validated.
            "columnId": 42, # Identifier for the column.
          },
      ],
      "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.
    "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
    "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
    "attribution": "A String", # Attribution assigned to the table.
    "description": "A String", # Description assigned to the table.
    "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
    "isExportable": True or False, # Variable for whether table is exportable.
    "baseTableIds": [ # Base table identifier if this table is a view or merged table.
      "A String",
    ],
    "tablePropertiesJson": "A String", # JSON object containing custom table properties.
    "attributionLink": "A String", # Optional link for attribution.
    "sql": "A String", # 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 details of a column in a table.
          "graphPredicate": "A String", # Column graph predicate.
              # Used to map table to graph data model (subject,predicate,object)
              # See W3C Graph-based Data Model.
          "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
          "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
            "A String",
          ],
          "description": "A String", # Column description.
          "baseColumn": { # 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 of the column.
          "columnPropertiesJson": "A String", # JSON object containing custom column properties.
          "formatPattern": "A String", # Format pattern.
              # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
          "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
          "type": "A String", # Type of the column.
          "validateData": True or False, # If true, data entered via the web application is validated.
          "columnId": 42, # Identifier for the column.
        },
    ],
    "name": "A String", # Name assigned to a table.
  }


Returns:
  An object of the form:

    { # Represents a table.
      "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
      "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
      "attribution": "A String", # Attribution assigned to the table.
      "description": "A String", # Description assigned to the table.
      "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
      "isExportable": True or False, # Variable for whether table is exportable.
      "baseTableIds": [ # Base table identifier if this table is a view or merged table.
        "A String",
      ],
      "tablePropertiesJson": "A String", # JSON object containing custom table properties.
      "attributionLink": "A String", # Optional link for attribution.
      "sql": "A String", # 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 details of a column in a table.
            "graphPredicate": "A String", # Column graph predicate.
                # Used to map table to graph data model (subject,predicate,object)
                # See W3C Graph-based Data Model.
            "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
            "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
              "A String",
            ],
            "description": "A String", # Column description.
            "baseColumn": { # 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 of the column.
            "columnPropertiesJson": "A String", # JSON object containing custom column properties.
            "formatPattern": "A String", # Format pattern.
                # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
            "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
            "type": "A String", # Type of the column.
            "validateData": True or False, # If true, data entered via the web application is validated.
            "columnId": 42, # Identifier for the column.
          },
      ],
      "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.
  maxResults: integer, Maximum number of tables to return. 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 pages left.
    "items": [ # List of all requested tables.
      { # Represents a table.
          "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
          "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
          "attribution": "A String", # Attribution assigned to the table.
          "description": "A String", # Description assigned to the table.
          "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
          "isExportable": True or False, # Variable for whether table is exportable.
          "baseTableIds": [ # Base table identifier if this table is a view or merged table.
            "A String",
          ],
          "tablePropertiesJson": "A String", # JSON object containing custom table properties.
          "attributionLink": "A String", # Optional link for attribution.
          "sql": "A String", # 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 details of a column in a table.
                "graphPredicate": "A String", # Column graph predicate.
                    # Used to map table to graph data model (subject,predicate,object)
                    # See W3C Graph-based Data Model.
                "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
                "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
                  "A String",
                ],
                "description": "A String", # Column description.
                "baseColumn": { # 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 of the column.
                "columnPropertiesJson": "A String", # JSON object containing custom column properties.
                "formatPattern": "A String", # Format pattern.
                    # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
                "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
                "type": "A String", # Type of the column.
                "validateData": True or False, # If true, data entered via the web application is validated.
                "columnId": 42, # Identifier for the column.
              },
          ],
          "name": "A String", # Name assigned to a table.
        },
    ],
    "kind": "fusiontables#tableList", # The kind of item this is. For table list, this is always fusiontables#tableList.
  }
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.
    "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
    "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
    "attribution": "A String", # Attribution assigned to the table.
    "description": "A String", # Description assigned to the table.
    "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
    "isExportable": True or False, # Variable for whether table is exportable.
    "baseTableIds": [ # Base table identifier if this table is a view or merged table.
      "A String",
    ],
    "tablePropertiesJson": "A String", # JSON object containing custom table properties.
    "attributionLink": "A String", # Optional link for attribution.
    "sql": "A String", # 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 details of a column in a table.
          "graphPredicate": "A String", # Column graph predicate.
              # Used to map table to graph data model (subject,predicate,object)
              # See W3C Graph-based Data Model.
          "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
          "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
            "A String",
          ],
          "description": "A String", # Column description.
          "baseColumn": { # 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 of the column.
          "columnPropertiesJson": "A String", # JSON object containing custom column properties.
          "formatPattern": "A String", # Format pattern.
              # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
          "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
          "type": "A String", # Type of the column.
          "validateData": True or False, # If true, data entered via the web application is validated.
          "columnId": 42, # Identifier for the column.
        },
    ],
    "name": "A String", # Name assigned to a table.
  }

  replaceViewDefinition: boolean, Whether the view definition is also 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.
      "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
      "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
      "attribution": "A String", # Attribution assigned to the table.
      "description": "A String", # Description assigned to the table.
      "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
      "isExportable": True or False, # Variable for whether table is exportable.
      "baseTableIds": [ # Base table identifier if this table is a view or merged table.
        "A String",
      ],
      "tablePropertiesJson": "A String", # JSON object containing custom table properties.
      "attributionLink": "A String", # Optional link for attribution.
      "sql": "A String", # 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 details of a column in a table.
            "graphPredicate": "A String", # Column graph predicate.
                # Used to map table to graph data model (subject,predicate,object)
                # See W3C Graph-based Data Model.
            "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
            "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
              "A String",
            ],
            "description": "A String", # Column description.
            "baseColumn": { # 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 of the column.
            "columnPropertiesJson": "A String", # JSON object containing custom column properties.
            "formatPattern": "A String", # Format pattern.
                # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
            "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
            "type": "A String", # Type of the column.
            "validateData": True or False, # If true, data entered via the web application is validated.
            "columnId": 42, # Identifier for the column.
          },
      ],
      "name": "A String", # Name assigned to a table.
    }
replaceRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None) 
Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready.

Args:
  tableId: string, Table whose rows will be replaced. (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 imported CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not have the same number of columns. If false, rows with fewer column 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 line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.

Returns:
  An object of the form:

    { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
    "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
    "progress": "A String", # Task percentage completion.
    "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
    "type": "A String", # Type of background task.
    "taskId": "A String", # Identifier for the task.
  }
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.
    "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
    "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
    "attribution": "A String", # Attribution assigned to the table.
    "description": "A String", # Description assigned to the table.
    "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
    "isExportable": True or False, # Variable for whether table is exportable.
    "baseTableIds": [ # Base table identifier if this table is a view or merged table.
      "A String",
    ],
    "tablePropertiesJson": "A String", # JSON object containing custom table properties.
    "attributionLink": "A String", # Optional link for attribution.
    "sql": "A String", # 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 details of a column in a table.
          "graphPredicate": "A String", # Column graph predicate.
              # Used to map table to graph data model (subject,predicate,object)
              # See W3C Graph-based Data Model.
          "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
          "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
            "A String",
          ],
          "description": "A String", # Column description.
          "baseColumn": { # 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 of the column.
          "columnPropertiesJson": "A String", # JSON object containing custom column properties.
          "formatPattern": "A String", # Format pattern.
              # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
          "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
          "type": "A String", # Type of the column.
          "validateData": True or False, # If true, data entered via the web application is validated.
          "columnId": 42, # Identifier for the column.
        },
    ],
    "name": "A String", # Name assigned to a table.
  }

  replaceViewDefinition: boolean, Whether the view definition is also 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.
      "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
      "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
      "attribution": "A String", # Attribution assigned to the table.
      "description": "A String", # Description assigned to the table.
      "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
      "isExportable": True or False, # Variable for whether table is exportable.
      "baseTableIds": [ # Base table identifier if this table is a view or merged table.
        "A String",
      ],
      "tablePropertiesJson": "A String", # JSON object containing custom table properties.
      "attributionLink": "A String", # Optional link for attribution.
      "sql": "A String", # 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 details of a column in a table.
            "graphPredicate": "A String", # Column graph predicate.
                # Used to map table to graph data model (subject,predicate,object)
                # See W3C Graph-based Data Model.
            "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
            "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
              "A String",
            ],
            "description": "A String", # Column description.
            "baseColumn": { # 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 of the column.
            "columnPropertiesJson": "A String", # JSON object containing custom column properties.
            "formatPattern": "A String", # Format pattern.
                # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
            "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
            "type": "A String", # Type of the column.
            "validateData": True or False, # If true, data entered via the web application is validated.
            "columnId": 42, # Identifier for the column.
          },
      ],
      "name": "A String", # Name assigned to a table.
    }
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.task.html000066400000000000000000000115501300622755700250270ustar00rootroot00000000000000

Fusion Tables API . task

Instance Methods

delete(tableId, taskId)

Deletes a specific task by its ID, unless that task has already started running.

get(tableId, taskId)

Retrieves a specific task by its ID.

list(tableId, pageToken=None, maxResults=None, startIndex=None)

Retrieves a list of tasks.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(tableId, taskId) 
Deletes a specific task by its ID, unless that task has already started running.

Args:
  tableId: string, Table from which the task is being deleted. (required)
  taskId: string, The identifier of the task to delete. (required)
get(tableId, taskId) 
Retrieves a specific task by its ID.

Args:
  tableId: string, Table to which the task belongs. (required)
  taskId: string, The identifier of the task to get. (required)

Returns:
  An object of the form:

    { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
    "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
    "progress": "A String", # Task percentage completion.
    "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
    "type": "A String", # Type of background task.
    "taskId": "A String", # Identifier for the task.
  }
list(tableId, pageToken=None, maxResults=None, startIndex=None) 
Retrieves a list of tasks.

Args:
  tableId: string, Table whose tasks are being listed. (required)
  pageToken: string, Continuation token specifying which result page to return.
  maxResults: integer, Maximum number of tasks to return. Default is 5.
  startIndex: integer, Index of the first result returned in the current page.

Returns:
  An object of the form:

    { # Represents a list of tasks for a table.
    "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
    "items": [ # List of all requested tasks.
      { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
        "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
        "progress": "A String", # Task percentage completion.
        "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
        "type": "A String", # Type of background task.
        "taskId": "A String", # Identifier for the task.
      },
    ],
    "kind": "fusiontables#taskList", # Type of the resource. This is always "fusiontables#taskList".
    "totalItems": 42, # Total number of tasks 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.
google-api-python-client-1.5.5/docs/dyn/fusiontables_v2.template.html000066400000000000000000000304621300622755700257030ustar00rootroot00000000000000

Fusion Tables API . template

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", # The kind of item this is. For a template, this is always fusiontables#template.
      "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", # The kind of item this is. For a template, this is always fusiontables#template.
    "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", # The kind of item this is. For a template, this is always fusiontables#template.
      "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 pages 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", # The kind of item this is. For a template, this is always fusiontables#template.
          "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", # The kind of item this is. For a template list, this is always fusiontables#templateList .
    "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", # The kind of item this is. For a template, this is always fusiontables#template.
    "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", # The kind of item this is. For a template, this is always fusiontables#template.
      "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", # The kind of item this is. For a template, this is always fusiontables#template.
    "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", # The kind of item this is. For a template, this is always fusiontables#template.
      "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.
    }
gamesConfiguration_v1configuration.achievementConfigurations.html000066400000000000000000001351641300622755700351360ustar00rootroot00000000000000google-api-python-client-1.5.5/docs/dyn

Google Play Game Services Publishing API . achievementConfigurations

Instance Methods

delete(achievementId)

Delete the achievement configuration with the given ID.

get(achievementId)

Retrieves the metadata of the achievement configuration with the given ID.

insert(applicationId, body)

Insert a new achievement configuration in this application.

list(applicationId, pageToken=None, maxResults=None)

Returns a list of the achievement configurations in this application.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(achievementId, body)

Update the metadata of the achievement configuration with the given ID. This method supports patch semantics.

update(achievementId, body)

Update the metadata of the achievement configuration with the given ID.

Method Details

delete(achievementId) 
Delete the achievement configuration with the given ID.

Args:
  achievementId: string, The ID of the achievement used by this method. (required)
get(achievementId) 
Retrieves the metadata of the achievement configuration with the given ID.

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 configuration resource.
      "achievementType": "A String", # The type of the achievement.
          # Possible values are:
          # - "STANDARD" - Achievement is either locked or unlocked.
          # - "INCREMENTAL" - Achievement is incremental.
      "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
      "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
      "initialState": "A String", # The initial state of the achievement.
          # Possible values are:
          # - "HIDDEN" - Achievement is hidden.
          # - "REVEALED" - Achievement is revealed.
          # - "UNLOCKED" - Achievement is unlocked.
      "token": "A String", # The token for this resource.
      "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "id": "A String", # The ID of the achievement.
    }
insert(applicationId, body) 
Insert a new achievement configuration in this application.

Args:
  applicationId: string, The application ID from the Google Play developer console. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an achievement configuration resource.
    "achievementType": "A String", # The type of the achievement.
        # Possible values are:
        # - "STANDARD" - Achievement is either locked or unlocked.
        # - "INCREMENTAL" - Achievement is incremental.
    "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
    "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
    "initialState": "A String", # The initial state of the achievement.
        # Possible values are:
        # - "HIDDEN" - Achievement is hidden.
        # - "REVEALED" - Achievement is revealed.
        # - "UNLOCKED" - Achievement is unlocked.
    "token": "A String", # The token for this resource.
    "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
      "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
      "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
      "pointValue": 42, # Point value for the achievement.
      "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
    },
    "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
      "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
      "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
      "pointValue": 42, # Point value for the achievement.
      "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
    },
    "id": "A String", # The ID of the achievement.
  }


Returns:
  An object of the form:

    { # This is a JSON template for an achievement configuration resource.
      "achievementType": "A String", # The type of the achievement.
          # Possible values are:
          # - "STANDARD" - Achievement is either locked or unlocked.
          # - "INCREMENTAL" - Achievement is incremental.
      "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
      "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
      "initialState": "A String", # The initial state of the achievement.
          # Possible values are:
          # - "HIDDEN" - Achievement is hidden.
          # - "REVEALED" - Achievement is revealed.
          # - "UNLOCKED" - Achievement is unlocked.
      "token": "A String", # The token for this resource.
      "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "id": "A String", # The ID of the achievement.
    }
list(applicationId, pageToken=None, maxResults=None) 
Returns a list of the achievement configurations in this application.

Args:
  applicationId: string, The application ID from the Google Play developer console. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults.

Returns:
  An object of the form:

    { # This is a JSON template for a ListConfigurations response.
    "nextPageToken": "A String", # The pagination token for the next page of results.
    "items": [ # The achievement configurations.
      { # This is a JSON template for an achievement configuration resource.
          "achievementType": "A String", # The type of the achievement.
              # Possible values are:
              # - "STANDARD" - Achievement is either locked or unlocked.
              # - "INCREMENTAL" - Achievement is incremental.
          "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
          "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
          "initialState": "A String", # The initial state of the achievement.
              # Possible values are:
              # - "HIDDEN" - Achievement is hidden.
              # - "REVEALED" - Achievement is revealed.
              # - "UNLOCKED" - Achievement is unlocked.
          "token": "A String", # The token for this resource.
          "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
            "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
            "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
            "pointValue": 42, # Point value for the achievement.
            "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
            "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
          "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
            "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
            "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
            "pointValue": 42, # Point value for the achievement.
            "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
            "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
          "id": "A String", # The ID of the achievement.
        },
    ],
    "kind": "gamesConfiguration#achievementConfigurationListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementConfigurationListResponse.
  }
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(achievementId, body) 
Update the metadata of the achievement configuration with the given ID. This method supports patch semantics.

Args:
  achievementId: string, The ID of the achievement used by this method. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an achievement configuration resource.
    "achievementType": "A String", # The type of the achievement.
        # Possible values are:
        # - "STANDARD" - Achievement is either locked or unlocked.
        # - "INCREMENTAL" - Achievement is incremental.
    "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
    "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
    "initialState": "A String", # The initial state of the achievement.
        # Possible values are:
        # - "HIDDEN" - Achievement is hidden.
        # - "REVEALED" - Achievement is revealed.
        # - "UNLOCKED" - Achievement is unlocked.
    "token": "A String", # The token for this resource.
    "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
      "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
      "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
      "pointValue": 42, # Point value for the achievement.
      "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
    },
    "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
      "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
      "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
      "pointValue": 42, # Point value for the achievement.
      "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
    },
    "id": "A String", # The ID of the achievement.
  }


Returns:
  An object of the form:

    { # This is a JSON template for an achievement configuration resource.
      "achievementType": "A String", # The type of the achievement.
          # Possible values are:
          # - "STANDARD" - Achievement is either locked or unlocked.
          # - "INCREMENTAL" - Achievement is incremental.
      "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
      "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
      "initialState": "A String", # The initial state of the achievement.
          # Possible values are:
          # - "HIDDEN" - Achievement is hidden.
          # - "REVEALED" - Achievement is revealed.
          # - "UNLOCKED" - Achievement is unlocked.
      "token": "A String", # The token for this resource.
      "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "id": "A String", # The ID of the achievement.
    }
update(achievementId, body) 
Update the metadata of the achievement configuration with the given ID.

Args:
  achievementId: string, The ID of the achievement used by this method. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an achievement configuration resource.
    "achievementType": "A String", # The type of the achievement.
        # Possible values are:
        # - "STANDARD" - Achievement is either locked or unlocked.
        # - "INCREMENTAL" - Achievement is incremental.
    "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
    "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
    "initialState": "A String", # The initial state of the achievement.
        # Possible values are:
        # - "HIDDEN" - Achievement is hidden.
        # - "REVEALED" - Achievement is revealed.
        # - "UNLOCKED" - Achievement is unlocked.
    "token": "A String", # The token for this resource.
    "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
      "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
      "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
      "pointValue": 42, # Point value for the achievement.
      "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
    },
    "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
      "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
      "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
      "pointValue": 42, # Point value for the achievement.
      "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
    },
    "id": "A String", # The ID of the achievement.
  }


Returns:
  An object of the form:

    { # This is a JSON template for an achievement configuration resource.
      "achievementType": "A String", # The type of the achievement.
          # Possible values are:
          # - "STANDARD" - Achievement is either locked or unlocked.
          # - "INCREMENTAL" - Achievement is incremental.
      "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
      "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
      "initialState": "A String", # The initial state of the achievement.
          # Possible values are:
          # - "HIDDEN" - Achievement is hidden.
          # - "REVEALED" - Achievement is revealed.
          # - "UNLOCKED" - Achievement is unlocked.
      "token": "A String", # The token for this resource.
      "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
        "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
        "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
        "pointValue": 42, # Point value for the achievement.
        "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
      },
      "id": "A String", # The ID of the achievement.
    }
google-api-python-client-1.5.5/docs/dyn/gamesConfiguration_v1configuration.html000066400000000000000000000051741300622755700300100ustar00rootroot00000000000000

Google Play Game Services Publishing API

Instance Methods

achievementConfigurations()

Returns the achievementConfigurations Resource.

imageConfigurations()

Returns the imageConfigurations Resource.

leaderboardConfigurations()

Returns the leaderboardConfigurations Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/gamesConfiguration_v1configuration.imageConfigurations.html000066400000000000000000000047161300622755700340050ustar00rootroot00000000000000

Google Play Game Services Publishing API . imageConfigurations

Instance Methods

upload(resourceId, imageType, media_body=None)

Uploads an image for a resource with the given ID and image type.

Method Details

upload(resourceId, imageType, media_body=None) 
Uploads an image for a resource with the given ID and image type.

Args:
  resourceId: string, The ID of the resource used by this method. (required)
  imageType: string, Selects which image in a resource for this method. (required)
    Allowed values
      ACHIEVEMENT_ICON - The icon image for an achievement resource.
      LEADERBOARD_ICON - The icon image for a leaderboard resource.
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # This is a JSON template for an image configuration resource.
    "url": "A String", # The url for this image.
    "resourceId": "A String", # The resource ID of resource which the image belongs to.
    "kind": "gamesConfiguration#imageConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#imageConfiguration.
    "imageType": "A String", # The image type for the image.
  }
gamesConfiguration_v1configuration.leaderboardConfigurations.html000066400000000000000000004074141300622755700351120ustar00rootroot00000000000000google-api-python-client-1.5.5/docs/dyn

Google Play Game Services Publishing API . leaderboardConfigurations

Instance Methods

delete(leaderboardId)

Delete the leaderboard configuration with the given ID.

get(leaderboardId)

Retrieves the metadata of the leaderboard configuration with the given ID.

insert(applicationId, body)

Insert a new leaderboard configuration in this application.

list(applicationId, pageToken=None, maxResults=None)

Returns a list of the leaderboard configurations in this application.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(leaderboardId, body)

Update the metadata of the leaderboard configuration with the given ID. This method supports patch semantics.

update(leaderboardId, body)

Update the metadata of the leaderboard configuration with the given ID.

Method Details

delete(leaderboardId) 
Delete the leaderboard configuration with the given ID.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
get(leaderboardId) 
Retrieves the metadata of the leaderboard configuration with the given ID.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)

Returns:
  An object of the form:

    { # This is a JSON template for an leaderboard configuration resource.
      "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
      "scoreOrder": "A String", # The type of the leaderboard.
          # Possible values are:
          # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
          # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
      "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
      "token": "A String", # The token for this resource.
      "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
      "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "id": "A String", # The ID of the leaderboard.
    }
insert(applicationId, body) 
Insert a new leaderboard configuration in this application.

Args:
  applicationId: string, The application ID from the Google Play developer console. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an leaderboard configuration resource.
    "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
    "scoreOrder": "A String", # The type of the leaderboard.
        # Possible values are:
        # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
        # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
    "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
    "token": "A String", # The token for this resource.
    "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
    "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
      "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
        "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
        "numberFormatType": "A String", # The formatting for the number.
            # Possible values are:
            # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
            # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
            # - "CURRENCY" - Numbers are formatted to currency according to locale.
        "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
        "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
          "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
        },
      },
      "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
      "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
    },
    "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
      "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
        "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
        "numberFormatType": "A String", # The formatting for the number.
            # Possible values are:
            # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
            # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
            # - "CURRENCY" - Numbers are formatted to currency according to locale.
        "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
        "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
          "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
        },
      },
      "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
      "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
    },
    "id": "A String", # The ID of the leaderboard.
  }


Returns:
  An object of the form:

    { # This is a JSON template for an leaderboard configuration resource.
      "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
      "scoreOrder": "A String", # The type of the leaderboard.
          # Possible values are:
          # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
          # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
      "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
      "token": "A String", # The token for this resource.
      "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
      "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "id": "A String", # The ID of the leaderboard.
    }
list(applicationId, pageToken=None, maxResults=None) 
Returns a list of the leaderboard configurations in this application.

Args:
  applicationId: string, The application ID from the Google Play developer console. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults.

Returns:
  An object of the form:

    { # This is a JSON template for a ListConfigurations response.
    "nextPageToken": "A String", # The pagination token for the next page of results.
    "items": [ # The leaderboard configurations.
      { # This is a JSON template for an leaderboard configuration resource.
          "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
          "scoreOrder": "A String", # The type of the leaderboard.
              # Possible values are:
              # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
              # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
          "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
          "token": "A String", # The token for this resource.
          "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
          "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
            "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
              "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
              "numberFormatType": "A String", # The formatting for the number.
                  # Possible values are:
                  # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
                  # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
                  # - "CURRENCY" - Numbers are formatted to currency according to locale.
              "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
              "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
                "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
              },
            },
            "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
            "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
            "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
          },
          "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
            "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
              "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
              "numberFormatType": "A String", # The formatting for the number.
                  # Possible values are:
                  # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
                  # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
                  # - "CURRENCY" - Numbers are formatted to currency according to locale.
              "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
              "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
                "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
                "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
                  "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
                  "translations": [ # The locale strings.
                    { # This is a JSON template for a localized string resource.
                      "locale": "A String", # The locale string.
                      "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                      "value": "A String", # The string value.
                    },
                  ],
                },
              },
            },
            "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
            "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
            "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
          },
          "id": "A String", # The ID of the leaderboard.
        },
    ],
    "kind": "gamesConfiguration#leaderboardConfigurationListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardConfigurationListResponse.
  }
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(leaderboardId, body) 
Update the metadata of the leaderboard configuration with the given ID. This method supports patch semantics.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an leaderboard configuration resource.
    "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
    "scoreOrder": "A String", # The type of the leaderboard.
        # Possible values are:
        # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
        # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
    "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
    "token": "A String", # The token for this resource.
    "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
    "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
      "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
        "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
        "numberFormatType": "A String", # The formatting for the number.
            # Possible values are:
            # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
            # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
            # - "CURRENCY" - Numbers are formatted to currency according to locale.
        "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
        "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
          "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
        },
      },
      "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
      "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
    },
    "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
      "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
        "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
        "numberFormatType": "A String", # The formatting for the number.
            # Possible values are:
            # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
            # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
            # - "CURRENCY" - Numbers are formatted to currency according to locale.
        "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
        "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
          "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
        },
      },
      "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
      "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
    },
    "id": "A String", # The ID of the leaderboard.
  }


Returns:
  An object of the form:

    { # This is a JSON template for an leaderboard configuration resource.
      "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
      "scoreOrder": "A String", # The type of the leaderboard.
          # Possible values are:
          # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
          # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
      "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
      "token": "A String", # The token for this resource.
      "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
      "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "id": "A String", # The ID of the leaderboard.
    }
update(leaderboardId, body) 
Update the metadata of the leaderboard configuration with the given ID.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an leaderboard configuration resource.
    "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
    "scoreOrder": "A String", # The type of the leaderboard.
        # Possible values are:
        # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
        # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
    "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
    "token": "A String", # The token for this resource.
    "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
    "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
      "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
        "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
        "numberFormatType": "A String", # The formatting for the number.
            # Possible values are:
            # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
            # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
            # - "CURRENCY" - Numbers are formatted to currency according to locale.
        "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
        "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
          "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
        },
      },
      "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
      "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
    },
    "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
      "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
        "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
        "numberFormatType": "A String", # The formatting for the number.
            # Possible values are:
            # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
            # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
            # - "CURRENCY" - Numbers are formatted to currency according to locale.
        "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
        "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
          "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
          "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
            "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
            "translations": [ # The locale strings.
              { # This is a JSON template for a localized string resource.
                "locale": "A String", # The locale string.
                "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                "value": "A String", # The string value.
              },
            ],
          },
        },
      },
      "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
      "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
      "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
        "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
        "translations": [ # The locale strings.
          { # This is a JSON template for a localized string resource.
            "locale": "A String", # The locale string.
            "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
            "value": "A String", # The string value.
          },
        ],
      },
      "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
    },
    "id": "A String", # The ID of the leaderboard.
  }


Returns:
  An object of the form:

    { # This is a JSON template for an leaderboard configuration resource.
      "kind": "gamesConfiguration#leaderboardConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration.
      "scoreOrder": "A String", # The type of the leaderboard.
          # Possible values are:
          # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
          # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
      "scoreMin": "A String", # Minimum score that can be posted to this leaderboard.
      "token": "A String", # The token for this resource.
      "scoreMax": "A String", # Maximum score that can be posted to this leaderboard.
      "published": { # This is a JSON template for a leaderboard configuration detail. # The read-only published data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "draft": { # This is a JSON template for a leaderboard configuration detail. # The draft data of the leaderboard.
        "scoreFormat": { # This is a JSON template for a number format resource. # The score formatting for the leaderboard.
          "currencyCode": "A String", # The curreny code string. Only used for CURRENCY format type.
          "numberFormatType": "A String", # The formatting for the number.
              # Possible values are:
              # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added.
              # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
              # - "CURRENCY" - Numbers are formatted to currency according to locale.
          "numDecimalPlaces": 42, # The number of decimal places for number. Only used for NUMERIC format type.
          "suffix": { # This is a JSON template for a number affix resource. # An optional suffix for the NUMERIC format type. These strings follow the same  plural rules as all Android string resources.
            "many": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "two": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "one": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "few": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "zero": { # This is a JSON template for a localized string bundle resource. # When the language requires special treatment of the number 0 (as in Arabic).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
            "other": { # This is a JSON template for a localized string bundle resource. # When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English).
              "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
              "translations": [ # The locale strings.
                { # This is a JSON template for a localized string resource.
                  "locale": "A String", # The locale string.
                  "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
                  "value": "A String", # The string value.
                },
              ],
            },
          },
        },
        "iconUrl": "A String", # The icon url of this leaderboard. Writes to this field are ignored.
        "kind": "gamesConfiguration#leaderboardConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail.
        "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the leaderboard name.
          "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
          "translations": [ # The locale strings.
            { # This is a JSON template for a localized string resource.
              "locale": "A String", # The locale string.
              "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
              "value": "A String", # The string value.
            },
          ],
        },
        "sortRank": 42, # The sort rank of this leaderboard. Writes to this field are ignored.
      },
      "id": "A String", # The ID of the leaderboard.
    }
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.achievements.html000066400000000000000000000146721300622755700311770ustar00rootroot00000000000000

Google Play Game Services Management API . achievements

Instance Methods

reset(achievementId)

Resets the achievement with the given ID for the currently authenticated player. 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.

resetAllForAllPlayers()

Resets all draft achievements for all players. This method is only available to user accounts for your developer console.

resetForAllPlayers(achievementId)

Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.

resetMultipleForAllPlayers(body)

Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.

Method Details

reset(achievementId) 
Resets the achievement with the given ID for the currently authenticated player. 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.
      },
    ],
  }
resetAllForAllPlayers() 
Resets all draft achievements for all players. This method is only available to user accounts for your developer console.

Args:
resetForAllPlayers(achievementId) 
Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.

Args:
  achievementId: string, The ID of the achievement used by this method. (required)
resetMultipleForAllPlayers(body) 
Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for multiple achievements reset all request.
    "achievement_ids": [ # The IDs of achievements to reset.
      "A String",
    ],
    "kind": "gamesManagement#achievementResetMultipleForAllRequest", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest.
  }
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.applications.html000066400000000000000000000162721300622755700312100ustar00rootroot00000000000000

Google Play Game Services Management API . applications

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 ID from the Google Play developer console. (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.
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "gamesManagement#player", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "gamesManagement#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.events.html000066400000000000000000000116721300622755700300250ustar00rootroot00000000000000

Google Play Game Services Management API . events

Instance Methods

reset(eventId)

Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player that use the event will also be reset.

resetAll()

Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player will also be reset.

resetAllForAllPlayers()

Resets all draft events for all players. This method is only available to user accounts for your developer console. All quests that use any of these events will also be reset.

resetForAllPlayers(eventId)

Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. All quests that use the event will also be reset.

resetMultipleForAllPlayers(body)

Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. All quests that use any of the events will also be reset.

Method Details

reset(eventId) 
Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player that use the event will also be reset.

Args:
  eventId: string, The ID of the event. (required)
resetAll() 
Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player will also be reset.

Args:
resetAllForAllPlayers() 
Resets all draft events for all players. This method is only available to user accounts for your developer console. All quests that use any of these events will also be reset.

Args:
resetForAllPlayers(eventId) 
Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. All quests that use the event will also be reset.

Args:
  eventId: string, The ID of the event. (required)
resetMultipleForAllPlayers(body) 
Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. All quests that use any of the events will also be reset.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for multiple events reset all request.
    "event_ids": [ # The IDs of events to reset.
      "A String",
    ],
    "kind": "gamesManagement#eventsResetMultipleForAllRequest", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#eventsResetMultipleForAllRequest.
  }
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.html000066400000000000000000000064741300622755700265260ustar00rootroot00000000000000

Google Play Game Services Management API

Instance Methods

achievements()

Returns the achievements Resource.

applications()

Returns the applications Resource.

events()

Returns the events Resource.

players()

Returns the players Resource.

quests()

Returns the quests Resource.

rooms()

Returns the rooms Resource.

scores()

Returns the scores Resource.

turnBasedMatches()

Returns the turnBasedMatches Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.players.html000066400000000000000000000051431300622755700301740ustar00rootroot00000000000000

Google Play Game Services Management API . players

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 ID from the Google Play developer console. (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 ID from the Google Play developer console. (required)
  playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.quests.html000066400000000000000000000106661300622755700300470ustar00rootroot00000000000000

Google Play Game Services Management API . quests

Instance Methods

reset(questId)

Resets all player progress on the quest with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

resetAll()

Resets all player progress on all quests for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

resetAllForAllPlayers()

Resets all draft quests for all players. This method is only available to user accounts for your developer console.

resetForAllPlayers(questId)

Resets all player progress on the quest with the given ID for all players. This method is only available to user accounts for your developer console. Only draft quests can be reset.

resetMultipleForAllPlayers(body)

Resets quests with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft quests may be reset.

Method Details

reset(questId) 
Resets all player progress on the quest with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

Args:
  questId: string, The ID of the quest. (required)
resetAll() 
Resets all player progress on all quests for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

Args:
resetAllForAllPlayers() 
Resets all draft quests for all players. This method is only available to user accounts for your developer console.

Args:
resetForAllPlayers(questId) 
Resets all player progress on the quest with the given ID for all players. This method is only available to user accounts for your developer console. Only draft quests can be reset.

Args:
  questId: string, The ID of the quest. (required)
resetMultipleForAllPlayers(body) 
Resets quests with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft quests may be reset.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for multiple quests reset all request.
    "quest_ids": [ # The IDs of quests to reset.
      "A String",
    ],
    "kind": "gamesManagement#questsResetMultipleForAllRequest", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#questsResetMultipleForAllRequest.
  }
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.rooms.html000066400000000000000000000043671300622755700276630ustar00rootroot00000000000000

Google Play Game Services Management API . rooms

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.

resetForAllPlayers()

Deletes rooms where the only room participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console.

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:
resetForAllPlayers() 
Deletes rooms where the only room participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console.

Args:
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.scores.html000066400000000000000000000143741300622755700300210ustar00rootroot00000000000000

Google Play Game Services Management API . scores

Instance Methods

reset(leaderboardId)

Resets scores for the leaderboard with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

resetAll()

Resets all scores for all leaderboards for the currently authenticated players. This method is only accessible to whitelisted tester accounts for your application.

resetAllForAllPlayers()

Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console.

resetForAllPlayers(leaderboardId)

Resets scores for the leaderboard with the given ID for all players. This method is only available to user accounts for your developer console. Only draft leaderboards can be reset.

resetMultipleForAllPlayers(body)

Resets scores for the leaderboards with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft leaderboards may be reset.

Method Details

reset(leaderboardId) 
Resets scores for the leaderboard with the given ID for the currently authenticated player. 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.
    "definitionId": "A String", # The ID of an leaderboard for which player state has been updated.
    "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",
    ],
  }
resetAll() 
Resets all scores for all leaderboards for the currently authenticated players. 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 a list of leaderboard reset resources.
    "kind": "gamesManagement#playerScoreResetAllResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse.
    "results": [ # The leaderboard reset results.
      { # This is a JSON template for a list of reset leaderboard entry resources.
        "definitionId": "A String", # The ID of an leaderboard for which player state has been updated.
        "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",
        ],
      },
    ],
  }
resetAllForAllPlayers() 
Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console.

Args:
resetForAllPlayers(leaderboardId) 
Resets scores for the leaderboard with the given ID for all players. This method is only available to user accounts for your developer console. Only draft leaderboards can be reset.

Args:
  leaderboardId: string, The ID of the leaderboard. (required)
resetMultipleForAllPlayers(body) 
Resets scores for the leaderboards with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft leaderboards may be reset.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for multiple scores reset all request.
    "leaderboard_ids": [ # The IDs of leaderboards to reset.
      "A String",
    ],
    "kind": "gamesManagement#scoresResetMultipleForAllRequest", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#scoresResetMultipleForAllRequest.
  }
google-api-python-client-1.5.5/docs/dyn/gamesManagement_v1management.turnBasedMatches.html000066400000000000000000000043471300622755700317560ustar00rootroot00000000000000

Google Play Game Services Management API . turnBasedMatches

Instance Methods

reset()

Reset all turn-based match data for a user. This method is only accessible to whitelisted tester accounts for your application.

resetForAllPlayers()

Deletes turn-based matches where the only match participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console.

Method Details

reset() 
Reset all turn-based match data for a user. This method is only accessible to whitelisted tester accounts for your application.

Args:
resetForAllPlayers() 
Deletes turn-based matches where the only match participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console.

Args:
google-api-python-client-1.5.5/docs/dyn/games_v1.achievementDefinitions.html000066400000000000000000000113551300622755700271510ustar00rootroot00000000000000

Google Play Game Services API . achievementDefinitions

Instance Methods

list(pageToken=None, language=None, maxResults=None, consistencyToken=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, consistencyToken=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.
  consistencyToken: string, The last-seen mutation timestamp.

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.
        "experiencePoints": "A String", # Experience points which will be earned when unlocking this achievement.
        "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.
google-api-python-client-1.5.5/docs/dyn/games_v1.achievements.html000066400000000000000000000331331300622755700251360ustar00rootroot00000000000000

Google Play Game Services API . achievements

Instance Methods

increment(achievementId, stepsToIncrement, requestId=None, consistencyToken=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, consistencyToken=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, consistencyToken=None)

Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.

setStepsAtLeast(achievementId, steps, consistencyToken=None)

Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.

unlock(achievementId, consistencyToken=None)

Unlocks this achievement for the currently authenticated player.

updateMultiple(body, consistencyToken=None)

Updates multiple achievements for the currently authenticated player.

Method Details

increment(achievementId, stepsToIncrement, requestId=None, consistencyToken=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 request is handled correctly across retries.
  consistencyToken: string, The last-seen mutation timestamp.

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 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, consistencyToken=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.
  consistencyToken: string, The last-seen mutation timestamp.

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.
        "experiencePoints": "A String", # Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished.
        "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, consistencyToken=None) 
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)
  consistencyToken: string, The last-seen mutation timestamp.

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.
  }
setStepsAtLeast(achievementId, steps, consistencyToken=None) 
Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.

Args:
  achievementId: string, The ID of the achievement used by this method. (required)
  steps: integer, The minimum value to set the steps to. (required)
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for an achievement set steps at least 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#achievementSetStepsAtLeastResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementSetStepsAtLeastResponse.
  }
unlock(achievementId, consistencyToken=None) 
Unlocks this achievement for the currently authenticated player.

Args:
  achievementId: string, The ID of the achievement used by this method. (required)
  consistencyToken: string, The last-seen mutation timestamp.

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.
  }
updateMultiple(body, consistencyToken=None) 
Updates multiple achievements for the currently authenticated player.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for a list of achievement update requests.
    "kind": "games#achievementUpdateMultipleRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateMultipleRequest.
    "updates": [ # The individual achievement update requests.
      { # This is a JSON template for a request to update an achievement.
        "setStepsAtLeastPayload": { # This is a JSON template for the payload to request to increment an achievement. # The payload if an update of type SET_STEPS_AT_LEAST was requested for the achievement.
          "kind": "games#GamesAchievementSetStepsAtLeast", # Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementSetStepsAtLeast.
          "steps": 42, # The minimum number of steps for the achievement to be set to.
        },
        "updateType": "A String", # The type of update being applied.
            # Possible values are:
            # - "REVEAL" - Achievement is revealed.
            # - "UNLOCK" - Achievement is unlocked.
            # - "INCREMENT" - Achievement is incremented.
            # - "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed value.
        "kind": "games#achievementUpdateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateRequest.
        "achievementId": "A String", # The achievement this update is being applied to.
        "incrementPayload": { # This is a JSON template for the payload to request to increment an achievement. # The payload if an update of type INCREMENT was requested for the achievement.
          "kind": "games#GamesAchievementIncrement", # Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementIncrement.
          "steps": 42, # The number of steps to be incremented.
          "requestId": "A String", # The requestId associated with an increment to an achievement.
        },
      },
    ],
  }

  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for an achievement unlock response.
    "kind": "games#achievementUpdateMultipleResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateListResponse.
    "updatedAchievements": [ # The updated state of the achievements.
      { # This is a JSON template for an achievement update response.
        "kind": "games#achievementUpdateResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateResponse.
        "achievementId": "A String", # The achievement this update is was applied to.
        "currentSteps": 42, # The current steps recorded for this achievement if it is incremental.
        "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).
        "updateOccurred": True or False, # Whether the requested updates actually affected the achievement.
        "currentState": "A String", # The current state of the achievement.
            # Possible values are:
            # - "HIDDEN" - Achievement is hidden.
            # - "REVEALED" - Achievement is revealed.
            # - "UNLOCKED" - Achievement is unlocked.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/games_v1.applications.html000066400000000000000000000213471300622755700251550ustar00rootroot00000000000000

Google Play Game Services API . applications

Instance Methods

get(applicationId, language=None, consistencyToken=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(consistencyToken=None)

Indicate that the the currently authenticated user is playing your application.

verify(applicationId, consistencyToken=None)

Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

Method Details

get(applicationId, language=None, consistencyToken=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 ID from the Google Play developer console. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.
  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.
    "themeColor": "A String", # A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. "E0E0E0").
    "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.
    "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.
      },
    ],
    "id": "A String", # The ID of the application.
    "enabledFeatures": [ # A list of features that have been enabled for the application.
        # Possible values are:
        # - "SNAPSHOTS" - Snapshots has been enabled
      "A String",
    ],
  }
played(consistencyToken=None) 
Indicate that the the currently authenticated user is playing your application.

Args:
  consistencyToken: string, The last-seen mutation timestamp.
verify(applicationId, consistencyToken=None) 
Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

Args:
  applicationId: string, The application ID from the Google Play developer console. (required)
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a third party application verification response resource.
    "player_id": "A String", # The ID of the player that was issued the auth token used in this request.
    "kind": "games#applicationVerifyResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse.
    "alternate_player_id": "A String", # An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.)
  }
google-api-python-client-1.5.5/docs/dyn/games_v1.events.html000066400000000000000000000314171300622755700237720ustar00rootroot00000000000000

Google Play Game Services API . events

Instance Methods

listByPlayer(pageToken=None, language=None, maxResults=None, consistencyToken=None)

Returns a list showing the current progress on events in this application for the currently authenticated user.

listByPlayer_next(previous_request, previous_response)

Retrieves the next page of results.

listDefinitions(pageToken=None, language=None, maxResults=None, consistencyToken=None)

Returns a list of the event definitions in this application.

listDefinitions_next(previous_request, previous_response)

Retrieves the next page of results.

record(body, language=None, consistencyToken=None)

Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.

Method Details

listByPlayer(pageToken=None, language=None, maxResults=None, consistencyToken=None) 
Returns a list showing the current progress on events in this application for the currently authenticated user.

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 events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a ListByPlayer response.
    "nextPageToken": "A String", # The pagination token for the next page of results.
    "items": [ # The player events.
      { # This is a JSON template for an event status resource.
        "definitionId": "A String", # The ID of the event definition.
        "playerId": "A String", # The ID of the player.
        "kind": "games#playerEvent", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent.
        "numEvents": "A String", # The current number of times this event has occurred.
        "formattedNumEvents": "A String", # The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console.
      },
    ],
    "kind": "games#playerEventListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerEventListResponse.
  }
listByPlayer_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.
listDefinitions(pageToken=None, language=None, maxResults=None, consistencyToken=None) 
Returns a list of the event definitions in this 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 event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a ListDefinitions response.
    "nextPageToken": "A String", # The pagination token for the next page of results.
    "items": [ # The event definitions.
      { # This is a JSON template for an event definition resource.
        "isDefaultImageUrl": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
        "kind": "games#eventDefinition", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition.
        "displayName": "A String", # The name to display for the event.
        "description": "A String", # Description of what this event represents.
        "imageUrl": "A String", # The base URL for the image that represents the event.
        "visibility": "A String", # The visibility of event being tracked in this definition.
            # Possible values are:
            # - "REVEALED": This event should be visible to all users.
            # - "HIDDEN": This event should only be shown to users that have recorded this event at least once.
        "childEvents": [ # A list of events that are a child of this event.
          { # This is a JSON template for an event child relationship resource.
            "kind": "games#eventChild", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventChild.
            "childId": "A String", # The ID of the child event.
          },
        ],
        "id": "A String", # The ID of the event.
      },
    ],
    "kind": "games#eventDefinitionListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinitionListResponse.
  }
listDefinitions_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.
record(body, language=None, consistencyToken=None) 
Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for an event period update resource.
    "timePeriods": [ # A list of the time period updates being made in this request.
      { # This is a JSON template for an event period update resource.
        "kind": "games#eventPeriodUpdate", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodUpdate.
        "timePeriod": { # This is a JSON template for an event period time range. # The time period being covered by this update.
          "kind": "games#eventPeriodRange", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange.
          "periodStartMillis": "A String", # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
          "periodEndMillis": "A String", # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
        },
        "updates": [ # The updates being made for this time period.
          { # This is a JSON template for an event period update resource.
            "definitionId": "A String", # The ID of the event being modified in this update.
            "kind": "games#eventUpdateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateRequest.
            "updateCount": "A String", # The number of times this event occurred in this time period.
          },
        ],
      },
    ],
    "kind": "games#eventRecordRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordRequest.
    "requestId": "A String", # The request ID used to identify this attempt to record events.
    "currentTimeMillis": "A String", # The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for an event period update resource.
    "playerEvents": [ # The current status of any updated events
      { # This is a JSON template for an event status resource.
        "definitionId": "A String", # The ID of the event definition.
        "playerId": "A String", # The ID of the player.
        "kind": "games#playerEvent", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent.
        "numEvents": "A String", # The current number of times this event has occurred.
        "formattedNumEvents": "A String", # The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console.
      },
    ],
    "eventFailures": [ # Any failures updating a particular event.
      { # This is a JSON template for an event update failure resource.
        "eventId": "A String", # The ID of the event that was not updated.
        "kind": "games#eventRecordFailure", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordFailure.
        "failureCause": "A String", # The cause for the update failure.
            # Possible values are:
            # - "NOT_FOUND" - An attempt was made to set an event that was not defined.
            # - "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a non-positive value.
      },
    ],
    "kind": "games#eventUpdateResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateResponse.
    "batchFailures": [ # Any batch-wide failures which occurred applying updates.
      { # This is a JSON template for a batch update failure resource.
        "kind": "games#eventBatchRecordFailure", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventBatchRecordFailure.
        "range": { # This is a JSON template for an event period time range. # The time range which was rejected; empty for a request-wide failure.
          "kind": "games#eventPeriodRange", # Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange.
          "periodStartMillis": "A String", # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
          "periodEndMillis": "A String", # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
        },
        "failureCause": "A String", # The cause for the update failure.
            # Possible values are:
            # - "TOO_LARGE": A batch request was issued with more events than are allowed in a single batch.
            # - "TIME_PERIOD_EXPIRED": A batch was sent with data too far in the past to record.
            # - "TIME_PERIOD_SHORT": A batch was sent with a time range that was too short.
            # - "TIME_PERIOD_LONG": A batch was sent with a time range that was too long.
            # - "ALREADY_UPDATED": An attempt was made to record a batch of data which was already seen.
            # - "RECORD_RATE_HIGH": An attempt was made to record data faster than the server will apply updates.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/games_v1.html000066400000000000000000000103471300622755700224660ustar00rootroot00000000000000

Google Play Game Services API

Instance Methods

achievementDefinitions()

Returns the achievementDefinitions Resource.

achievements()

Returns the achievements Resource.

applications()

Returns the applications Resource.

events()

Returns the events Resource.

leaderboards()

Returns the leaderboards Resource.

metagame()

Returns the metagame Resource.

players()

Returns the players Resource.

pushtokens()

Returns the pushtokens Resource.

questMilestones()

Returns the questMilestones Resource.

quests()

Returns the quests Resource.

revisions()

Returns the revisions Resource.

rooms()

Returns the rooms Resource.

scores()

Returns the scores Resource.

snapshots()

Returns the snapshots Resource.

turnBasedMatches()

Returns the turnBasedMatches Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/games_v1.leaderboards.html000066400000000000000000000122201300622755700251040ustar00rootroot00000000000000

Google Play Game Services API . leaderboards

Instance Methods

get(leaderboardId, language=None, consistencyToken=None)

Retrieves the metadata of the leaderboard with the given ID.

list(pageToken=None, language=None, maxResults=None, consistencyToken=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, consistencyToken=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.
  consistencyToken: string, The last-seen mutation timestamp.

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, consistencyToken=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.
  consistencyToken: string, The last-seen mutation timestamp.

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.
google-api-python-client-1.5.5/docs/dyn/games_v1.metagame.html000066400000000000000000000123431300622755700242430ustar00rootroot00000000000000

Google Play Game Services API . metagame

Instance Methods

getMetagameConfig(consistencyToken=None)

Return the metagame configuration data for the calling application.

listCategoriesByPlayer(playerId, collection, language=None, pageToken=None, maxResults=None, consistencyToken=None)

List play data aggregated per category for the player corresponding to playerId.

listCategoriesByPlayer_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

getMetagameConfig(consistencyToken=None) 
Return the metagame configuration data for the calling application.

Args:
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for the metagame config resource
    "kind": "games#metagameConfig", # Uniquely identifies the type of this resource. Value is always the fixed string games#metagameConfig.
    "currentVersion": 42, # Current version of the metagame configuration data. When this data is updated, the version number will be increased by one.
    "playerLevels": [ # The list of player levels.
      { # This is a JSON template for 1P/3P metadata about a user's level.
        "maxExperiencePoints": "A String", # The maximum experience points for this level.
        "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
        "minExperiencePoints": "A String", # The minimum experience points for this level.
        "level": 42, # The level for the user.
      },
    ],
  }
listCategoriesByPlayer(playerId, collection, language=None, pageToken=None, maxResults=None, consistencyToken=None) 
List play data aggregated per category for the player corresponding to playerId.

Args:
  playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
  collection: string, The collection of categories for which data will be returned. (required)
    Allowed values
      all - Retrieve data for all categories. This is the default.
  language: string, The preferred language to use for strings returned by this method.
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category resources returned may be less than the specified maxResults.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a list of category data objects.
    "nextPageToken": "A String", # Token corresponding to the next page of results.
    "items": [ # The list of categories with usage data.
      { # This is a JSON template for data related to individual game categories.
        "category": "A String", # The category name.
        "experiencePoints": "A String", # Experience points earned in this category.
        "kind": "games#category", # Uniquely identifies the type of this resource. Value is always the fixed string games#category.
      },
    ],
    "kind": "games#categoryListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#categoryListResponse.
  }
listCategoriesByPlayer_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.
google-api-python-client-1.5.5/docs/dyn/games_v1.players.html000066400000000000000000000311121300622755700241350ustar00rootroot00000000000000

Google Play Game Services API . players

Instance Methods

get(playerId, language=None, consistencyToken=None)

Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.

list(collection, pageToken=None, language=None, maxResults=None, consistencyToken=None)

Get the collection of players for the currently authenticated user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(playerId, language=None, consistencyToken=None) 
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)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a Player resource.
    "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
    "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
    "displayName": "A String", # The name to display for the player.
    "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
      "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
      "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
    },
    "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
      "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
      "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
      "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
    },
    "playerId": "A String", # The ID of the player.
    "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
    "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
      "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
      "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
    },
    "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
      "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
      "currentExperiencePoints": "A String", # The current number of experience points for the player.
      "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
      "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
        "maxExperiencePoints": "A String", # The maximum experience points for this level.
        "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
        "minExperiencePoints": "A String", # The minimum experience points for this level.
        "level": 42, # The level for the user.
      },
      "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
        "maxExperiencePoints": "A String", # The maximum experience points for this level.
        "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
        "minExperiencePoints": "A String", # The minimum experience points for this level.
        "level": 42, # The level for the user.
      },
    },
    "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
    "title": "A String", # The player's title rewarded for their game activities.
    "avatarImageUrl": "A String", # The base URL for the image that represents the player.
  }
list(collection, pageToken=None, language=None, maxResults=None, consistencyToken=None) 
Get the collection of players for the currently authenticated user.

Args:
  collection: string, Collection of players being retrieved (required)
    Allowed values
      connected - Retrieve a list of players that are also playing this game in reverse chronological order.
      playedWith - (DEPRECATED: please use played_with!) Retrieve a list of players you have played a multiplayer game (realtime or turn-based) with recently.
      played_with - Retrieve a list of players you have played a multiplayer game (realtime or turn-based) with recently.
      visible - Retrieve a list of players in the user's social graph that are visible to this game.
  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 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.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a third party player list response.
    "nextPageToken": "A String", # Token corresponding to the next page of results.
    "items": [ # The players.
      { # This is a JSON template for a Player resource.
        "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
        "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
        "displayName": "A String", # The name to display for the player.
        "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
          "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
          "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
        },
        "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
          "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
          "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
          "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
        },
        "playerId": "A String", # The ID of the player.
        "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
        "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
          "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
          "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
        },
        "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
          "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
          "currentExperiencePoints": "A String", # The current number of experience points for the player.
          "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
          "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "level": 42, # The level for the user.
          },
          "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "level": 42, # The level for the user.
          },
        },
        "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
        "title": "A String", # The player's title rewarded for their game activities.
        "avatarImageUrl": "A String", # The base URL for the image that represents the player.
      },
    ],
    "kind": "games#playerListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerListResponse.
  }
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.
google-api-python-client-1.5.5/docs/dyn/games_v1.pushtokens.html000066400000000000000000000076411300622755700246730ustar00rootroot00000000000000

Google Play Game Services API . pushtokens

Instance Methods

remove(body, consistencyToken=None)

Removes a push token for the current user and application. Removing a non-existent push token will report success.

update(body, consistencyToken=None)

Registers a push token for the current user and application.

Method Details

remove(body, consistencyToken=None) 
Removes a push token for the current user and application. Removing a non-existent push token will report success.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for a push token ID resource.
  "kind": "games#pushTokenId", # Uniquely identifies the type of this resource. Value is always the fixed string games#pushTokenId.
  "ios": { # A push token ID for iOS devices.
    "apns_device_token": "A String", # Device token supplied by an iOS system call to register for remote notifications. Encode this field as web-safe base64.
    "apns_environment": "A String", # Indicates whether this token should be used for the production or sandbox APNS server.
  },
}

  consistencyToken: string, The last-seen mutation timestamp.
update(body, consistencyToken=None) 
Registers a push token for the current user and application.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for a push token resource.
    "kind": "games#pushToken", # Uniquely identifies the type of this resource. Value is always the fixed string games#pushToken.
    "clientRevision": "A String", # The revision of the client SDK used by your application, in the same format that's used by revisions.check. Used to send backward compatible messages. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are:
        # - IOS - Push token is for iOS
    "id": { # This is a JSON template for a push token ID resource. # Unique identifier for this push token.
      "kind": "games#pushTokenId", # Uniquely identifies the type of this resource. Value is always the fixed string games#pushTokenId.
      "ios": { # A push token ID for iOS devices.
        "apns_device_token": "A String", # Device token supplied by an iOS system call to register for remote notifications. Encode this field as web-safe base64.
        "apns_environment": "A String", # Indicates whether this token should be used for the production or sandbox APNS server.
      },
    },
    "language": "A String", # The preferred language for notifications that are sent using this token.
  }

  consistencyToken: string, The last-seen mutation timestamp.
google-api-python-client-1.5.5/docs/dyn/games_v1.questMilestones.html000066400000000000000000000040521300622755700256650ustar00rootroot00000000000000

Google Play Game Services API . questMilestones

Instance Methods

claim(questId, milestoneId, requestId, consistencyToken=None)

Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.

Method Details

claim(questId, milestoneId, requestId, consistencyToken=None) 
Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.

Args:
  questId: string, The ID of the quest. (required)
  milestoneId: string, The ID of the milestone. (required)
  requestId: string, A numeric ID to ensure that the request is handled correctly across retries. Your client application must generate this ID randomly. (required)
  consistencyToken: string, The last-seen mutation timestamp.
google-api-python-client-1.5.5/docs/dyn/games_v1.quests.html000066400000000000000000000375071300622755700240200ustar00rootroot00000000000000

Google Play Game Services API . quests

Instance Methods

accept(questId, language=None, consistencyToken=None)

Indicates that the currently authorized user will participate in the quest.

list(playerId, language=None, pageToken=None, maxResults=None, consistencyToken=None)

Get a list of quests for your application and the currently authenticated player.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

accept(questId, language=None, consistencyToken=None) 
Indicates that the currently authorized user will participate in the quest.

Args:
  questId: string, The ID of the quest. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a Quest resource.
    "kind": "games#quest", # Uniquely identifies the type of this resource. Value is always the fixed string games#quest.
    "milestones": [ # The quest milestones.
      { # This is a JSON template for a Quest Milestone resource.
        "state": "A String", # The current state of the milestone.
            # Possible values are:
            # - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not yet been claimed.
            # - "CLAIMED" - The milestone is complete and has been claimed.
            # - "NOT_COMPLETED" - The milestone has not yet been completed.
            # - "NOT_STARTED" - The milestone is for a quest that has not yet been accepted.
        "kind": "games#questMilestone", # Uniquely identifies the type of this resource. Value is always the fixed string games#questMilestone.
        "criteria": [ # The criteria of the milestone.
          { # This is a JSON template for a Quest Criterion resource.
            "eventId": "A String", # The ID of the event the criterion corresponds to.
            "completionContribution": { # This is a JSON template for a Quest Criterion Contribution resource. # The total number of times the associated event must be incremented for the player to complete this quest.
              "formattedValue": "A String", # The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console.
              "kind": "games#questContribution", # Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution.
              "value": "A String", # The value of the contribution.
            },
            "initialPlayerProgress": { # This is a JSON template for a Quest Criterion Contribution resource. # The value of the event associated with this quest at the time that the quest was accepted. This value may change if event increments that took place before the start of quest are uploaded after the quest starts.
                # There will be no initialPlayerProgress until the player has accepted the quest.
              "formattedValue": "A String", # The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console.
              "kind": "games#questContribution", # Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution.
              "value": "A String", # The value of the contribution.
            },
            "kind": "games#questCriterion", # Uniquely identifies the type of this resource. Value is always the fixed string games#questCriterion.
            "currentContribution": { # This is a JSON template for a Quest Criterion Contribution resource. # The number of increments the player has made toward the completion count event increments required to complete the quest. This value will not exceed the completion contribution.
                # There will be no currentContribution until the player has accepted the quest.
              "formattedValue": "A String", # The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console.
              "kind": "games#questContribution", # Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution.
              "value": "A String", # The value of the contribution.
            },
          },
        ],
        "id": "A String", # The milestone ID.
        "completionRewardData": "A String", # The completion reward data of the milestone, represented as a Base64-encoded string. This is a developer-specified binary blob with size between 0 and 2 KB before encoding.
      },
    ],
    "description": "A String", # The description of the quest.
    "endTimestampMillis": "A String", # The timestamp at which the quest ceases to be active in milliseconds since the epoch in UTC.
    "bannerUrl": "A String", # The banner image URL for the quest.
    "startTimestampMillis": "A String", # The timestamp at which the quest becomes active in milliseconds since the epoch in UTC.
    "lastUpdatedTimestampMillis": "A String", # The timestamp at which the quest was last updated by the user in milliseconds since the epoch in UTC. Only present if the player has accepted the quest.
    "acceptedTimestampMillis": "A String", # The timestamp at which the user accepted the quest in milliseconds since the epoch in UTC. Only present if the player has accepted the quest.
    "iconUrl": "A String", # The icon image URL for the quest.
    "notifyTimestampMillis": "A String", # The timestamp at which the user should be notified that the quest will end soon in milliseconds since the epoch in UTC.
    "state": "A String", # The state of the quest.
        # Possible values are:
        # - "UPCOMING": The quest is upcoming. The user can see the quest, but cannot accept it until it is open.
        # - "OPEN": The quest is currently open and may be accepted at this time.
        # - "ACCEPTED": The user is currently participating in this quest.
        # - "COMPLETED": The user has completed the quest.
        # - "FAILED": The quest was attempted but was not completed before the deadline expired.
        # - "EXPIRED": The quest has expired and was not accepted.
        # - "DELETED": The quest should be deleted from the local database.
    "isDefaultBannerUrl": True or False, # Indicates whether the banner image being returned is a default image, or is game-provided.
    "isDefaultIconUrl": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
    "applicationId": "A String", # The ID of the application this quest is part of.
    "id": "A String", # The ID of the quest.
    "name": "A String", # The name of the quest.
  }
list(playerId, language=None, pageToken=None, maxResults=None, consistencyToken=None) 
Get a list of quests for your application and 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.
  maxResults: integer, The maximum number of quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (Default: 50).
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a list of quest objects.
    "nextPageToken": "A String", # Token corresponding to the next page of results.
    "items": [ # The quests.
      { # This is a JSON template for a Quest resource.
        "kind": "games#quest", # Uniquely identifies the type of this resource. Value is always the fixed string games#quest.
        "milestones": [ # The quest milestones.
          { # This is a JSON template for a Quest Milestone resource.
            "state": "A String", # The current state of the milestone.
                # Possible values are:
                # - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not yet been claimed.
                # - "CLAIMED" - The milestone is complete and has been claimed.
                # - "NOT_COMPLETED" - The milestone has not yet been completed.
                # - "NOT_STARTED" - The milestone is for a quest that has not yet been accepted.
            "kind": "games#questMilestone", # Uniquely identifies the type of this resource. Value is always the fixed string games#questMilestone.
            "criteria": [ # The criteria of the milestone.
              { # This is a JSON template for a Quest Criterion resource.
                "eventId": "A String", # The ID of the event the criterion corresponds to.
                "completionContribution": { # This is a JSON template for a Quest Criterion Contribution resource. # The total number of times the associated event must be incremented for the player to complete this quest.
                  "formattedValue": "A String", # The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console.
                  "kind": "games#questContribution", # Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution.
                  "value": "A String", # The value of the contribution.
                },
                "initialPlayerProgress": { # This is a JSON template for a Quest Criterion Contribution resource. # The value of the event associated with this quest at the time that the quest was accepted. This value may change if event increments that took place before the start of quest are uploaded after the quest starts.
                    # There will be no initialPlayerProgress until the player has accepted the quest.
                  "formattedValue": "A String", # The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console.
                  "kind": "games#questContribution", # Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution.
                  "value": "A String", # The value of the contribution.
                },
                "kind": "games#questCriterion", # Uniquely identifies the type of this resource. Value is always the fixed string games#questCriterion.
                "currentContribution": { # This is a JSON template for a Quest Criterion Contribution resource. # The number of increments the player has made toward the completion count event increments required to complete the quest. This value will not exceed the completion contribution.
                    # There will be no currentContribution until the player has accepted the quest.
                  "formattedValue": "A String", # The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console.
                  "kind": "games#questContribution", # Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution.
                  "value": "A String", # The value of the contribution.
                },
              },
            ],
            "id": "A String", # The milestone ID.
            "completionRewardData": "A String", # The completion reward data of the milestone, represented as a Base64-encoded string. This is a developer-specified binary blob with size between 0 and 2 KB before encoding.
          },
        ],
        "description": "A String", # The description of the quest.
        "endTimestampMillis": "A String", # The timestamp at which the quest ceases to be active in milliseconds since the epoch in UTC.
        "bannerUrl": "A String", # The banner image URL for the quest.
        "startTimestampMillis": "A String", # The timestamp at which the quest becomes active in milliseconds since the epoch in UTC.
        "lastUpdatedTimestampMillis": "A String", # The timestamp at which the quest was last updated by the user in milliseconds since the epoch in UTC. Only present if the player has accepted the quest.
        "acceptedTimestampMillis": "A String", # The timestamp at which the user accepted the quest in milliseconds since the epoch in UTC. Only present if the player has accepted the quest.
        "iconUrl": "A String", # The icon image URL for the quest.
        "notifyTimestampMillis": "A String", # The timestamp at which the user should be notified that the quest will end soon in milliseconds since the epoch in UTC.
        "state": "A String", # The state of the quest.
            # Possible values are:
            # - "UPCOMING": The quest is upcoming. The user can see the quest, but cannot accept it until it is open.
            # - "OPEN": The quest is currently open and may be accepted at this time.
            # - "ACCEPTED": The user is currently participating in this quest.
            # - "COMPLETED": The user has completed the quest.
            # - "FAILED": The quest was attempted but was not completed before the deadline expired.
            # - "EXPIRED": The quest has expired and was not accepted.
            # - "DELETED": The quest should be deleted from the local database.
        "isDefaultBannerUrl": True or False, # Indicates whether the banner image being returned is a default image, or is game-provided.
        "isDefaultIconUrl": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
        "applicationId": "A String", # The ID of the application this quest is part of.
        "id": "A String", # The ID of the quest.
        "name": "A String", # The name of the quest.
      },
    ],
    "kind": "games#questListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#questListResponse.
  }
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.
google-api-python-client-1.5.5/docs/dyn/games_v1.revisions.html000066400000000000000000000050621300622755700245040ustar00rootroot00000000000000

Google Play Game Services API . revisions

Instance Methods

check(clientRevision=None, consistencyToken=None)

Checks whether the games client is out of date.

Method Details

check(clientRevision=None, consistencyToken=None) 
Checks whether the games client is out of date.

Args:
  clientRevision: string, The revision of the client SDK used by your application. Format:
[PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are:
 
- "ANDROID" - Client is running the Android SDK. 
- "IOS" - Client is running the iOS SDK. 
- "WEB_APP" - Client is running as a Web App. (required)
  consistencyToken: string, The last-seen mutation timestamp.

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.
    "apiVersion": "A String", # The version of the API this client revision should use when calling API methods.
  }
google-api-python-client-1.5.5/docs/dyn/games_v1.rooms.html000066400000000000000000003117361300622755700236320ustar00rootroot00000000000000

Google Play Game Services API . rooms

Instance Methods

create(body, language=None, consistencyToken=None)

Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

decline(roomId, language=None, consistencyToken=None)

Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

dismiss(roomId, consistencyToken=None)

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, consistencyToken=None)

Get the data for a room.

join(roomId, body, language=None, consistencyToken=None)

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

leave(roomId, body, language=None, consistencyToken=None)

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

list(pageToken=None, language=None, maxResults=None, consistencyToken=None)

Returns invitations to join rooms.

list_next(previous_request, previous_response)

Retrieves the next page of results.

reportStatus(roomId, body, language=None, consistencyToken=None)

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, consistencyToken=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.
      "kind": "games#networkDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.
      "iosNetworkType": 42, # iOS network type as defined in Reachability.h.
      "networkOperatorCode": "A String", # The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html
      "androidNetworkSubtype": 42, # The Android network subtype.
      "networkOperatorName": "A String", # The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName
      "registrationLatencyMillis": 42, # The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.
      "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.
    },
    "requestId": "A String", # A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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 auto-matching 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 (in seconds) that auto-matching 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.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
    "inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
  }
decline(roomId, language=None, consistencyToken=None) 
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)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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 auto-matching 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 (in seconds) that auto-matching 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.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
    "inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
  }
dismiss(roomId, consistencyToken=None) 
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)
  consistencyToken: string, The last-seen mutation timestamp.
get(roomId, language=None, consistencyToken=None) 
Get the data for a room.

Args:
  roomId: string, The ID of the room. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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 auto-matching 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 (in seconds) that auto-matching 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.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
    "inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
  }
join(roomId, body, language=None, consistencyToken=None) 
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.
      "kind": "games#networkDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.
      "iosNetworkType": 42, # iOS network type as defined in Reachability.h.
      "networkOperatorCode": "A String", # The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html
      "androidNetworkSubtype": 42, # The Android network subtype.
      "networkOperatorName": "A String", # The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName
      "registrationLatencyMillis": 42, # The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.
      "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",
    ],
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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 auto-matching 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 (in seconds) that auto-matching 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.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
    "inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
  }
leave(roomId, body, language=None, consistencyToken=None) 
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.
        # - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first calling Leave.
        # - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room.
        # - "REALTIME_GAME_CRASHED" - The game crashed.
        # - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed.
        # - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to enter a room.
        # - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a new 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.
      "socketsUsed": True or False, # Whether or not sockets were used.
      "iosNetworkType": 42, # iOS network type as defined in Reachability.h.
      "networkOperatorCode": "A String", # The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html
      "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()
      "networkOperatorName": "A String", # The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName
      "androidNetworkType": 42, # Android network type. http://developer.android.com/reference/android/net/NetworkInfo.html#getType()
    },
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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 auto-matching 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 (in seconds) that auto-matching 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.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
    "inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
  }
list(pageToken=None, language=None, maxResults=None, consistencyToken=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.
  consistencyToken: string, The last-seen mutation timestamp.

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 auto-matching 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 (in seconds) that auto-matching 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.
            "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
            "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
              "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
              "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
              "displayName": "A String", # The name to display for the player.
              "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
                "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
                "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
              },
              "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
                "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
                "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
                "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
              },
              "playerId": "A String", # The ID of the player.
              "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
              "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
                "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
                "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
              },
              "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
                "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
                "currentExperiencePoints": "A String", # The current number of experience points for the player.
                "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
                "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
                  "maxExperiencePoints": "A String", # The maximum experience points for this level.
                  "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                  "minExperiencePoints": "A String", # The minimum experience points for this level.
                  "level": 42, # The level for the user.
                },
                "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
                  "maxExperiencePoints": "A String", # The maximum experience points for this level.
                  "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                  "minExperiencePoints": "A String", # The minimum experience points for this level.
                  "level": 42, # The level for the user.
                },
              },
              "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
              "title": "A String", # The player's title rewarded for their game activities.
              "avatarImageUrl": "A String", # The base URL for the image that represents 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.
        "inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
      },
    ],
    "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, language=None, consistencyToken=None) 
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.
      },
    ],
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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 (in seconds) that auto-matching 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.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "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 anonymously 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 anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
  }
google-api-python-client-1.5.5/docs/dyn/games_v1.scores.html000066400000000000000000001341151300622755700237630ustar00rootroot00000000000000

Google Play Game Services API . scores

Instance Methods

get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None, consistencyToken=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, consistencyToken=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, consistencyToken=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, scoreTag=None, consistencyToken=None)

Submits a score to the specified leaderboard.

submitMultiple(body, language=None, consistencyToken=None)

Submits multiple scores to leaderboards.

Method Details

get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None, consistencyToken=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.
NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.

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. Can be set to 'ALL' to retrieve data for all leaderboards for this application. (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.
  consistencyToken: string, The last-seen mutation timestamp.

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.
        },
        "scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
        "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.
    "player": { # This is a JSON template for a Player resource. # The Player resources for the owner of this score.
      "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
      "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
      "displayName": "A String", # The name to display for the player.
      "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
        "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
        "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
      },
      "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
        "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
        "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
        "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
      },
      "playerId": "A String", # The ID of the player.
      "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
      "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
        "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
        "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
      },
      "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
        "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
        "currentExperiencePoints": "A String", # The current number of experience points for the player.
        "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
        "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
          "maxExperiencePoints": "A String", # The maximum experience points for this level.
          "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
          "minExperiencePoints": "A String", # The minimum experience points for this level.
          "level": 42, # The level for the user.
        },
        "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
          "maxExperiencePoints": "A String", # The maximum experience points for this level.
          "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
          "minExperiencePoints": "A String", # The minimum experience points for this level.
          "level": 42, # The level for the user.
        },
      },
      "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
      "title": "A String", # The player's title rewarded for their game activities.
      "avatarImageUrl": "A String", # The base URL for the image that represents the player.
    },
  }
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, consistencyToken=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.
      SOCIAL_1P - List only social scores, not respecting the fACL.
  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.
  consistencyToken: string, The last-seen mutation timestamp.

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.
        "scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
        "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.
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
      "scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      "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.
        "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
        "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
        "displayName": "A String", # The name to display for the player.
        "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
          "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
          "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
        },
        "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
          "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
          "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
          "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
        },
        "playerId": "A String", # The ID of the player.
        "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
        "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
          "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
          "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
        },
        "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
          "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
          "currentExperiencePoints": "A String", # The current number of experience points for the player.
          "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
          "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "level": 42, # The level for the user.
          },
          "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "level": 42, # The level for the user.
          },
        },
        "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
        "title": "A String", # The player's title rewarded for their game activities.
        "avatarImageUrl": "A String", # The base URL for the image that represents 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, consistencyToken=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.
      SOCIAL_1P - List only social scores, not respecting the fACL.
  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.
  consistencyToken: string, The last-seen mutation timestamp.

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.
        "scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
        "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.
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents 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.
      "scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
      "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.
        "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
        "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
        "displayName": "A String", # The name to display for the player.
        "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
          "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
          "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
        },
        "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
          "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
          "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
          "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
        },
        "playerId": "A String", # The ID of the player.
        "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
        "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
          "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
          "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
        },
        "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
          "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
          "currentExperiencePoints": "A String", # The current number of experience points for the player.
          "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
          "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "level": 42, # The level for the user.
          },
          "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "level": 42, # The level for the user.
          },
        },
        "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
        "title": "A String", # The player's title rewarded for their game activities.
        "avatarImageUrl": "A String", # The base URL for the image that represents 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, scoreTag=None, consistencyToken=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.
  scoreTag: string, Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
  consistencyToken: string, The last-seen mutation timestamp.

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.
    "scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
    "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.
        "scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
        "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, consistencyToken=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.
        "scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
        "signature": "A String", # Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986.
      },
    ],
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

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.
        "scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
        "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.
            "scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
            "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.
  }
google-api-python-client-1.5.5/docs/dyn/games_v1.snapshots.html000066400000000000000000000163121300622755700245050ustar00rootroot00000000000000

Google Play Game Services API . snapshots

Instance Methods

get(snapshotId, language=None, consistencyToken=None)

Retrieves the metadata for a given snapshot ID.

list(playerId, language=None, pageToken=None, maxResults=None, consistencyToken=None)

Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(snapshotId, language=None, consistencyToken=None) 
Retrieves the metadata for a given snapshot ID.

Args:
  snapshotId: string, The ID of the snapshot. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for an snapshot object.
    "kind": "games#snapshot", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot.
    "description": "A String", # The description of this snapshot.
    "title": "A String", # The title of this snapshot.
    "coverImage": { # This is a JSON template for an image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
      "url": "A String", # The URL of the image. This URL may be invalidated at any time and should not be cached.
      "width": 42, # The width of the image.
      "kind": "games#snapshotImage", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage.
      "mime_type": "A String", # The MIME type of the image.
      "height": 42, # The height of the image.
    },
    "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
    "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this snapshot.
    "driveId": "A String", # The ID of the file underlying this snapshot in the Drive API. Only present if the snapshot is a view on a Drive file and the file is owned by the caller.
    "durationMillis": "A String", # The duration associated with this snapshot, in millis.
    "uniqueName": "A String", # The unique name provided when the snapshot was created.
    "type": "A String", # The type of this snapshot.
        # Possible values are:
        # - "SAVE_GAME" - A snapshot representing a save game.
    "id": "A String", # The ID of the snapshot.
  }
list(playerId, language=None, pageToken=None, maxResults=None, consistencyToken=None) 
Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

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.
  maxResults: integer, The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources returned may be less than the specified maxResults.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a list of snapshot objects.
    "nextPageToken": "A String", # Token corresponding to the next page of results. If there are no more results, the token is omitted.
    "items": [ # The snapshots.
      { # This is a JSON template for an snapshot object.
        "kind": "games#snapshot", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot.
        "description": "A String", # The description of this snapshot.
        "title": "A String", # The title of this snapshot.
        "coverImage": { # This is a JSON template for an image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
          "url": "A String", # The URL of the image. This URL may be invalidated at any time and should not be cached.
          "width": 42, # The width of the image.
          "kind": "games#snapshotImage", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage.
          "mime_type": "A String", # The MIME type of the image.
          "height": 42, # The height of the image.
        },
        "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
        "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this snapshot.
        "driveId": "A String", # The ID of the file underlying this snapshot in the Drive API. Only present if the snapshot is a view on a Drive file and the file is owned by the caller.
        "durationMillis": "A String", # The duration associated with this snapshot, in millis.
        "uniqueName": "A String", # The unique name provided when the snapshot was created.
        "type": "A String", # The type of this snapshot.
            # Possible values are:
            # - "SAVE_GAME" - A snapshot representing a save game.
        "id": "A String", # The ID of the snapshot.
      },
    ],
    "kind": "games#snapshotListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotListResponse.
  }
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.
google-api-python-client-1.5.5/docs/dyn/games_v1.turnBasedMatches.html000066400000000000000000005573461300622755700257400ustar00rootroot00000000000000

Google Play Game Services API . turnBasedMatches

Instance Methods

cancel(matchId, consistencyToken=None)

Cancel a turn-based match.

create(body, language=None, consistencyToken=None)

Create a turn-based match.

decline(matchId, language=None, consistencyToken=None)

Decline an invitation to play a turn-based match.

dismiss(matchId, consistencyToken=None)

Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.

finish(matchId, body, language=None, consistencyToken=None)

Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.

get(matchId, language=None, includeMatchData=None, consistencyToken=None)

Get the data for a turn-based match.

join(matchId, language=None, consistencyToken=None)

Join a turn-based match.

leave(matchId, language=None, consistencyToken=None)

Leave a turn-based match when it is not the current player's turn, without canceling the match.

leaveTurn(matchId, matchVersion, language=None, pendingParticipantId=None, consistencyToken=None)

Leave a turn-based match during the current player's turn, without canceling the match.

list(maxCompletedMatches=None, language=None, pageToken=None, maxResults=None, includeMatchData=None, consistencyToken=None)

Returns turn-based matches the player is or was involved in.

list_next(previous_request, previous_response)

Retrieves the next page of results.

rematch(matchId, language=None, requestId=None, consistencyToken=None)

Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.

sync(maxCompletedMatches=None, language=None, pageToken=None, maxResults=None, includeMatchData=None, consistencyToken=None)

Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.

sync_next(previous_request, previous_response)

Retrieves the next page of results.

takeTurn(matchId, body, language=None, consistencyToken=None)

Commit the results of a player turn.

Method Details

cancel(matchId, consistencyToken=None) 
Cancel a turn-based match.

Args:
  matchId: string, The ID of the match. (required)
  consistencyToken: string, The last-seen mutation timestamp.
create(body, language=None, consistencyToken=None) 
Create a turn-based match.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for a turn-based match creation request.
    "invitedPlayerIds": [ # The player ids to invite to the match.
      "A String",
    ],
    "kind": "games#turnBasedMatchCreateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchCreateRequest.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "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.
    "requestId": "A String", # A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
decline(matchId, language=None, consistencyToken=None) 
Decline an invitation to play a turn-based match.

Args:
  matchId: string, The ID of the match. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
dismiss(matchId, consistencyToken=None) 
Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.

Args:
  matchId: string, The ID of the match. (required)
  consistencyToken: string, The last-seen mutation timestamp.
finish(matchId, body, language=None, consistencyToken=None) 
Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.

Args:
  matchId: string, The ID of the match. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for a turn-based match results object.
    "kind": "games#turnBasedMatchResults", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchResults.
    "data": { # This is a JSON template for sending a turn-based match data object. # The final match data.
      "kind": "games#turnBasedMatchDataRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchVersion": 42, # The version of the match being updated.
    "results": [ # The match results for the participants in the match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
get(matchId, language=None, includeMatchData=None, consistencyToken=None) 
Get the data for a turn-based match.

Args:
  matchId: string, The ID of the match. (required)
  language: string, The preferred language to use for strings returned by this method.
  includeMatchData: boolean, Get match data along with metadata.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
join(matchId, language=None, consistencyToken=None) 
Join a turn-based match.

Args:
  matchId: string, The ID of the match. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
leave(matchId, language=None, consistencyToken=None) 
Leave a turn-based match when it is not the current player's turn, without canceling the match.

Args:
  matchId: string, The ID of the match. (required)
  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
leaveTurn(matchId, matchVersion, language=None, pendingParticipantId=None, consistencyToken=None) 
Leave a turn-based match during the current player's turn, without canceling the match.

Args:
  matchId: string, The ID of the match. (required)
  matchVersion: integer, The version of the match being updated. (required)
  language: string, The preferred language to use for strings returned by this method.
  pendingParticipantId: string, The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
list(maxCompletedMatches=None, language=None, pageToken=None, maxResults=None, includeMatchData=None, consistencyToken=None) 
Returns turn-based matches the player is or was involved in.

Args:
  maxCompletedMatches: integer, The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
  language: string, The preferred language to use for strings returned by this method.
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
  includeMatchData: boolean, True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a list of turn-based matches.
    "nextPageToken": "A String", # The pagination token for the next page of results.
    "items": [ # The matches.
      { # This is a JSON template for a turn-based match resource object.
        "status": "A String", # The status of the match.
            # Possible values are:
            # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
            # - "MATCH_ACTIVE" - The match has started.
            # - "MATCH_COMPLETE" - The match has finished.
            # - "MATCH_CANCELED" - The match was canceled.
            # - "MATCH_EXPIRED" - The match expired due to inactivity.
            # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
        "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
        "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
        "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
          "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
          "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
        },
        "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
          "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
          "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
          "participantId": "A String", # The ID of the participant that modified the match.
        },
        "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
        "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
          "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
          "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
          "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
        },
        "matchId": "A String", # Globally unique ID for a turn-based match.
        "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
        "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
          { # This is a JSON template for a participant in a turn-based match.
            "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
            "status": "A String", # The status of the participant with respect to the match.
                # Possible values are:
                # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
                # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
                # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
                # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
                # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
                # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
                # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
            "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
            "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
            },
            "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
              "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
              "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
              "displayName": "A String", # The name to display for the player.
              "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
                "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
                "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
              },
              "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
                "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
                "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
                "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
              },
              "playerId": "A String", # The ID of the player.
              "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
              "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
                "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
                "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
              },
              "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
                "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
                "currentExperiencePoints": "A String", # The current number of experience points for the player.
                "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
                "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
                  "maxExperiencePoints": "A String", # The maximum experience points for this level.
                  "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                  "minExperiencePoints": "A String", # The minimum experience points for this level.
                  "level": 42, # The level for the user.
                },
                "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
                  "maxExperiencePoints": "A String", # The maximum experience points for this level.
                  "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                  "minExperiencePoints": "A String", # The minimum experience points for this level.
                  "level": 42, # The level for the user.
                },
              },
              "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
              "title": "A String", # The player's title rewarded for their game activities.
              "avatarImageUrl": "A String", # The base URL for the image that represents the player.
            },
            "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
          },
        ],
        "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
        "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 turn-based match modification metadata. # Details about the last update to the match.
          "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
          "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
          "participantId": "A String", # The ID of the participant that modified the match.
        },
        "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
          "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
          "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
          "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
        },
        "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
        "results": [ # The results reported for this match.
          { # This is a JSON template for a result for a match participant.
            "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
            "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
            "participantId": "A String", # The ID of the participant.
            "result": "A String", # The result of the participant for this match.
                # Possible values are:
                # - "MATCH_RESULT_WIN" - The participant won the match.
                # - "MATCH_RESULT_LOSS" - The participant lost the match.
                # - "MATCH_RESULT_TIE" - The participant tied the match.
                # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
                # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
                # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
          },
        ],
        "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
        "applicationId": "A String", # The ID of the application being played.
        "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
            # Possible values are:
            # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
            # - "USER_AWAITING_TURN" - The user is waiting for their turn.
            # - "USER_TURN" - The user has an action to take in the match.
            # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
        "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
      },
    ],
    "kind": "games#turnBasedMatchList", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchList.
  }
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.
rematch(matchId, language=None, requestId=None, consistencyToken=None) 
Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.

Args:
  matchId: string, The ID of the match. (required)
  language: string, The preferred language to use for strings returned by this method.
  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 request is handled correctly across retries.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a rematch response.
    "rematch": { # This is a JSON template for a turn-based match resource object. # The newly created match; a rematch of the old match with the same participants.
      "status": "A String", # The status of the match.
          # Possible values are:
          # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
          # - "MATCH_ACTIVE" - The match has started.
          # - "MATCH_COMPLETE" - The match has finished.
          # - "MATCH_CANCELED" - The match was canceled.
          # - "MATCH_EXPIRED" - The match expired due to inactivity.
          # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
      "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
      "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
      "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
        "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
        "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
      },
      "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
        "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
        "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
        "participantId": "A String", # The ID of the participant that modified the match.
      },
      "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
      "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
        "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
        "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
        "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
      },
      "matchId": "A String", # Globally unique ID for a turn-based match.
      "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
      "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
        { # This is a JSON template for a participant in a turn-based match.
          "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
          "status": "A String", # The status of the participant with respect to the match.
              # Possible values are:
              # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
              # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
              # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
              # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
              # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
              # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
              # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
          "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
          "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
          },
          "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
            "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
            "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
            "displayName": "A String", # The name to display for the player.
            "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
              "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
              "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
            },
            "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
              "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
              "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
              "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
            },
            "playerId": "A String", # The ID of the player.
            "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
            "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
              "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
              "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
            },
            "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
              "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
              "currentExperiencePoints": "A String", # The current number of experience points for the player.
              "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
              "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
                "maxExperiencePoints": "A String", # The maximum experience points for this level.
                "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                "minExperiencePoints": "A String", # The minimum experience points for this level.
                "level": 42, # The level for the user.
              },
              "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
                "maxExperiencePoints": "A String", # The maximum experience points for this level.
                "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                "minExperiencePoints": "A String", # The minimum experience points for this level.
                "level": 42, # The level for the user.
              },
            },
            "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
            "title": "A String", # The player's title rewarded for their game activities.
            "avatarImageUrl": "A String", # The base URL for the image that represents the player.
          },
          "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
        },
      ],
      "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
      "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 turn-based match modification metadata. # Details about the last update to the match.
        "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
        "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
        "participantId": "A String", # The ID of the participant that modified the match.
      },
      "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
        "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
        "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
        "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
      },
      "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
      "results": [ # The results reported for this match.
        { # This is a JSON template for a result for a match participant.
          "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
          "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
          "participantId": "A String", # The ID of the participant.
          "result": "A String", # The result of the participant for this match.
              # Possible values are:
              # - "MATCH_RESULT_WIN" - The participant won the match.
              # - "MATCH_RESULT_LOSS" - The participant lost the match.
              # - "MATCH_RESULT_TIE" - The participant tied the match.
              # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
              # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
              # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
        },
      ],
      "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
      "applicationId": "A String", # The ID of the application being played.
      "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
          # Possible values are:
          # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
          # - "USER_AWAITING_TURN" - The user is waiting for their turn.
          # - "USER_TURN" - The user has an action to take in the match.
          # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
      "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
    },
    "kind": "games#turnBasedMatchRematch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchRematch.
    "previousMatch": { # This is a JSON template for a turn-based match resource object. # The old match that the rematch was created from; will be updated such that the rematchId field will point at the new match.
      "status": "A String", # The status of the match.
          # Possible values are:
          # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
          # - "MATCH_ACTIVE" - The match has started.
          # - "MATCH_COMPLETE" - The match has finished.
          # - "MATCH_CANCELED" - The match was canceled.
          # - "MATCH_EXPIRED" - The match expired due to inactivity.
          # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
      "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
      "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
      "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
        "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
        "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
      },
      "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
        "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
        "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
        "participantId": "A String", # The ID of the participant that modified the match.
      },
      "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
      "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
        "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
        "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
        "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
      },
      "matchId": "A String", # Globally unique ID for a turn-based match.
      "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
      "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
        { # This is a JSON template for a participant in a turn-based match.
          "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
          "status": "A String", # The status of the participant with respect to the match.
              # Possible values are:
              # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
              # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
              # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
              # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
              # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
              # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
              # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
          "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
          "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
          },
          "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
            "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
            "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
            "displayName": "A String", # The name to display for the player.
            "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
              "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
              "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
            },
            "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
              "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
              "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
              "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
            },
            "playerId": "A String", # The ID of the player.
            "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
            "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
              "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
              "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
            },
            "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
              "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
              "currentExperiencePoints": "A String", # The current number of experience points for the player.
              "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
              "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
                "maxExperiencePoints": "A String", # The maximum experience points for this level.
                "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                "minExperiencePoints": "A String", # The minimum experience points for this level.
                "level": 42, # The level for the user.
              },
              "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
                "maxExperiencePoints": "A String", # The maximum experience points for this level.
                "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                "minExperiencePoints": "A String", # The minimum experience points for this level.
                "level": 42, # The level for the user.
              },
            },
            "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
            "title": "A String", # The player's title rewarded for their game activities.
            "avatarImageUrl": "A String", # The base URL for the image that represents the player.
          },
          "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
        },
      ],
      "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
      "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 turn-based match modification metadata. # Details about the last update to the match.
        "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
        "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
        "participantId": "A String", # The ID of the participant that modified the match.
      },
      "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
        "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
        "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
        "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
      },
      "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
      "results": [ # The results reported for this match.
        { # This is a JSON template for a result for a match participant.
          "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
          "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
          "participantId": "A String", # The ID of the participant.
          "result": "A String", # The result of the participant for this match.
              # Possible values are:
              # - "MATCH_RESULT_WIN" - The participant won the match.
              # - "MATCH_RESULT_LOSS" - The participant lost the match.
              # - "MATCH_RESULT_TIE" - The participant tied the match.
              # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
              # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
              # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
        },
      ],
      "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
      "applicationId": "A String", # The ID of the application being played.
      "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
          # Possible values are:
          # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
          # - "USER_AWAITING_TURN" - The user is waiting for their turn.
          # - "USER_TURN" - The user has an action to take in the match.
          # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
      "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
    },
  }
sync(maxCompletedMatches=None, language=None, pageToken=None, maxResults=None, includeMatchData=None, consistencyToken=None) 
Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.

Args:
  maxCompletedMatches: integer, The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
  language: string, The preferred language to use for strings returned by this method.
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
  includeMatchData: boolean, True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a list of turn-based matches returned from a sync.
    "nextPageToken": "A String", # The pagination token for the next page of results.
    "items": [ # The matches.
      { # This is a JSON template for a turn-based match resource object.
        "status": "A String", # The status of the match.
            # Possible values are:
            # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
            # - "MATCH_ACTIVE" - The match has started.
            # - "MATCH_COMPLETE" - The match has finished.
            # - "MATCH_CANCELED" - The match was canceled.
            # - "MATCH_EXPIRED" - The match expired due to inactivity.
            # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
        "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
        "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
        "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
          "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
          "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
        },
        "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
          "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
          "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
          "participantId": "A String", # The ID of the participant that modified the match.
        },
        "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
        "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
          "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
          "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
          "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
        },
        "matchId": "A String", # Globally unique ID for a turn-based match.
        "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
        "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
          { # This is a JSON template for a participant in a turn-based match.
            "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
            "status": "A String", # The status of the participant with respect to the match.
                # Possible values are:
                # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
                # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
                # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
                # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
                # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
                # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
                # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
            "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
            "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
            },
            "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
              "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
              "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
              "displayName": "A String", # The name to display for the player.
              "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
                "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
                "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
              },
              "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
                "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
                "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
                "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
              },
              "playerId": "A String", # The ID of the player.
              "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
              "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
                "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
                "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
              },
              "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
                "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
                "currentExperiencePoints": "A String", # The current number of experience points for the player.
                "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
                "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
                  "maxExperiencePoints": "A String", # The maximum experience points for this level.
                  "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                  "minExperiencePoints": "A String", # The minimum experience points for this level.
                  "level": 42, # The level for the user.
                },
                "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
                  "maxExperiencePoints": "A String", # The maximum experience points for this level.
                  "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
                  "minExperiencePoints": "A String", # The minimum experience points for this level.
                  "level": 42, # The level for the user.
                },
              },
              "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
              "title": "A String", # The player's title rewarded for their game activities.
              "avatarImageUrl": "A String", # The base URL for the image that represents the player.
            },
            "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
          },
        ],
        "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
        "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 turn-based match modification metadata. # Details about the last update to the match.
          "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
          "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
          "participantId": "A String", # The ID of the participant that modified the match.
        },
        "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
          "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
          "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
          "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
        },
        "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
        "results": [ # The results reported for this match.
          { # This is a JSON template for a result for a match participant.
            "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
            "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
            "participantId": "A String", # The ID of the participant.
            "result": "A String", # The result of the participant for this match.
                # Possible values are:
                # - "MATCH_RESULT_WIN" - The participant won the match.
                # - "MATCH_RESULT_LOSS" - The participant lost the match.
                # - "MATCH_RESULT_TIE" - The participant tied the match.
                # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
                # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
                # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
          },
        ],
        "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
        "applicationId": "A String", # The ID of the application being played.
        "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
            # Possible values are:
            # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
            # - "USER_AWAITING_TURN" - The user is waiting for their turn.
            # - "USER_TURN" - The user has an action to take in the match.
            # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
        "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
      },
    ],
    "kind": "games#turnBasedMatchSync", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchSync.
    "moreAvailable": True or False, # True if there were more matches available to fetch at the time the response was generated (which were not returned due to page size limits.)
  }
sync_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.
takeTurn(matchId, body, language=None, consistencyToken=None) 
Commit the results of a player turn.

Args:
  matchId: string, The ID of the match. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # This is a JSON template for the object representing a turn.
    "kind": "games#turnBasedMatchTurn", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchTurn.
    "results": [ # The match results for the participants in the match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "data": { # This is a JSON template for sending a turn-based match data object. # The shared game state data after the turn is over.
      "kind": "games#turnBasedMatchDataRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "pendingParticipantId": "A String", # The ID of the participant who should take their turn next. May be set to the current player's participant ID to update match state without changing the turn. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
  }

  language: string, The preferred language to use for strings returned by this method.
  consistencyToken: string, The last-seen mutation timestamp.

Returns:
  An object of the form:

    { # This is a JSON template for a turn-based match resource object.
    "status": "A String", # The status of the match.
        # Possible values are:
        # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
        # - "MATCH_ACTIVE" - The match has started.
        # - "MATCH_COMPLETE" - The match has finished.
        # - "MATCH_CANCELED" - The match was canceled.
        # - "MATCH_EXPIRED" - The match expired due to inactivity.
        # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with.
    "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match.
      "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
      "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match 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 match by auto-matching.
    },
    "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "matchId": "A String", # Globally unique ID for a turn-based match.
    "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
      { # This is a JSON template for a participant in a turn-based match.
        "autoMatched": True or False, # True if this participant was auto-matched with the requesting player.
        "status": "A String", # The status of the participant with respect to the match.
            # Possible values are:
            # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
            # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
            # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
            # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
            # - "PARTICIPANT_LEFT" - The participant joined the match and then left it.
            # - "PARTICIPANT_FINISHED" - The participant finished playing in the match.
            # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
        "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
        "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously 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.
        },
        "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
          "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
          "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
          "displayName": "A String", # The name to display for the player.
          "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.
            "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
            "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
          },
          "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
            "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.
            "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.
            "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.
          },
          "playerId": "A String", # The ID of the player.
          "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
          "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
            "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
            "profileVisible": True or False, # The player's current profile visibility. This field is visible to both 1P and 3P APIs.
          },
          "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
            "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
            "currentExperiencePoints": "A String", # The current number of experience points for the player.
            "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
            "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
            "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
              "maxExperiencePoints": "A String", # The maximum experience points for this level.
              "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
              "minExperiencePoints": "A String", # The minimum experience points for this level.
              "level": 42, # The level for the user.
            },
          },
          "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
          "title": "A String", # The player's title rewarded for their game activities.
          "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        },
        "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
      },
    ],
    "matchNumber": 42, # The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    "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 turn-based match modification metadata. # Details about the last update to the match.
      "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
      "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
      "participantId": "A String", # The ID of the participant that modified the match.
    },
    "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only.
      "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
      "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
      "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
    },
    "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched.
    "results": [ # The results reported for this match.
      { # This is a JSON template for a result for a match participant.
        "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
        "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
        "participantId": "A String", # The ID of the participant.
        "result": "A String", # The result of the participant for this match.
            # Possible values are:
            # - "MATCH_RESULT_WIN" - The participant won the match.
            # - "MATCH_RESULT_LOSS" - The participant lost the match.
            # - "MATCH_RESULT_TIE" - The participant tied the match.
            # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.)
            # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match.
            # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
      },
    ],
    "pendingParticipantId": "A String", # The ID of the participant that is taking a turn.
    "applicationId": "A String", # The ID of the application being played.
    "userMatchStatus": "A String", # The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match.
        # Possible values are:
        # - "USER_INVITED" - The user has been invited to join the match and has not responded yet.
        # - "USER_AWAITING_TURN" - The user is waiting for their turn.
        # - "USER_TURN" - The user has an action to take in the match.
        # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    "description": "A String", # This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.annotations.html000066400000000000000000002062251300622755700255340ustar00rootroot00000000000000

Genomics API . annotations

Instance Methods

batchCreate(body, x__xgafv=None)

Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together. If the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will fail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed annotations will be created normally. For details on the requirements for each individual annotation resource, see CreateAnnotation.

create(body, x__xgafv=None)

Creates a new annotation. Caller must have WRITE permission for the associated annotation set. The following fields are required: * annotationSetId * referenceName or referenceId ### Transcripts For annotations of type TRANSCRIPT, the following fields of transcript must be provided: * exons.start * exons.end All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field). The annotated range must be no longer than 100Mbp (mega base pairs). See the Annotation resource for additional restrictions on each field.

delete(annotationId, x__xgafv=None)

Deletes an annotation. Caller must have WRITE permission for the associated annotation set.

get(annotationId, x__xgafv=None)

Gets an annotation. Caller must have READ permission for the associated annotation set.

search(body, x__xgafv=None)

Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.

update(annotationId, body, updateMask=None, x__xgafv=None)

Updates an annotation. Caller must have WRITE permission for the associated dataset.

Method Details

batchCreate(body, x__xgafv=None) 
Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together. If the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will fail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed annotations will be created normally. For details on the requirements for each individual annotation resource, see CreateAnnotation.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "annotations": [ # The annotations to be created. At most 4096 can be specified in a single request.
      { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
        "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
        "end": "A String", # The end position of the range on the reference, 0-based exclusive.
        "name": "A String", # The display name of this annotation.
        "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
          "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
            "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
            "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
          },
          "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
            {
              "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
              "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
              "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
            },
          ],
          "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
        },
        "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
          "type": "A String", # Type has been adapted from ClinVar's list of variant types.
          "effect": "A String", # Effect of the variant on the coding sequence.
          "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
            "A String",
          ],
          "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
          "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
          "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
            {
              "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
              "externalIds": [ # The set of external IDs for this condition.
                {
                  "sourceName": "A String", # The name of the source of this data.
                  "id": "A String", # The id used by the source of this data.
                },
              ],
              "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
              "names": [ # A set of names for the condition.
                "A String",
              ],
            },
          ],
          "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
        },
        "start": "A String", # The start position of the range on the reference, 0-based inclusive.
        "annotationSetId": "A String", # The annotation set to which this annotation belongs.
        "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
        "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
        "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
        "id": "A String", # The server-generated annotation ID, unique across all annotations.
      },
    ],
    "requestId": "A String", # A unique request ID which enables the server to detect duplicated requests. If provided, duplicated requests will result in the same response; if not provided, duplicated requests may result in duplicated data. For a given annotation set, callers should not reuse `request_id`s when writing different batches of annotations - behavior in this case is undefined. A common approach is to use a UUID. For batch jobs where worker crashes are a possibility, consider using some unique variant of a worker or run ID.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "entries": [ # The resulting per-annotation entries, ordered consistently with the original request.
      {
        "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The creation status.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "annotation": { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`. # The created annotation, if creation was successful.
          "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
            "a_key": [
              "",
            ],
          },
          "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
          "end": "A String", # The end position of the range on the reference, 0-based exclusive.
          "name": "A String", # The display name of this annotation.
          "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
            "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
              "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
              "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
            },
            "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
              {
                "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
                "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
                "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
              },
            ],
            "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
          },
          "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
            "type": "A String", # Type has been adapted from ClinVar's list of variant types.
            "effect": "A String", # Effect of the variant on the coding sequence.
            "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
              "A String",
            ],
            "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
            "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
            "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
              {
                "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
                "externalIds": [ # The set of external IDs for this condition.
                  {
                    "sourceName": "A String", # The name of the source of this data.
                    "id": "A String", # The id used by the source of this data.
                  },
                ],
                "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
                "names": [ # A set of names for the condition.
                  "A String",
                ],
              },
            ],
            "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
          },
          "start": "A String", # The start position of the range on the reference, 0-based inclusive.
          "annotationSetId": "A String", # The annotation set to which this annotation belongs.
          "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
          "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
          "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
          "id": "A String", # The server-generated annotation ID, unique across all annotations.
        },
      },
    ],
  }
create(body, x__xgafv=None) 
Creates a new annotation. Caller must have WRITE permission for the associated annotation set. The following fields are required: * annotationSetId * referenceName or referenceId ### Transcripts For annotations of type TRANSCRIPT, the following fields of transcript must be provided: * exons.start * exons.end All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field). The annotated range must be no longer than 100Mbp (mega base pairs). See the Annotation resource for additional restrictions on each field.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
  "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
  "end": "A String", # The end position of the range on the reference, 0-based exclusive.
  "name": "A String", # The display name of this annotation.
  "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
    "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
      "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
      "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
    },
    "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
      {
        "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
        "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
        "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
      },
    ],
    "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
  },
  "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
    "type": "A String", # Type has been adapted from ClinVar's list of variant types.
    "effect": "A String", # Effect of the variant on the coding sequence.
    "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
      "A String",
    ],
    "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
    "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
    "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
      {
        "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
        "externalIds": [ # The set of external IDs for this condition.
          {
            "sourceName": "A String", # The name of the source of this data.
            "id": "A String", # The id used by the source of this data.
          },
        ],
        "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
        "names": [ # A set of names for the condition.
          "A String",
        ],
      },
    ],
    "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
  },
  "start": "A String", # The start position of the range on the reference, 0-based inclusive.
  "annotationSetId": "A String", # The annotation set to which this annotation belongs.
  "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
  "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
  "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
  "id": "A String", # The server-generated annotation ID, unique across all annotations.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
    "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    "name": "A String", # The display name of this annotation.
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
      },
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
          "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
        },
      ],
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
    },
    "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
    "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
delete(annotationId, x__xgafv=None) 
Deletes an annotation. Caller must have WRITE permission for the associated annotation set.

Args:
  annotationId: string, The ID of the annotation to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(annotationId, x__xgafv=None) 
Gets an annotation. Caller must have READ permission for the associated annotation set.

Args:
  annotationId: string, The ID of the annotation to be retrieved. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
    "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    "name": "A String", # The display name of this annotation.
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
      },
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
          "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
        },
      ],
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
    },
    "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
    "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
search(body, x__xgafv=None) 
Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "referenceId": "A String", # The ID of the reference to query.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive. If referenceId or referenceName must be specified, Defaults to the length of the reference.
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.
    "pageToken": "A 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.
    "annotationSetIds": [ # Required. The annotation sets to search within. The caller must have `READ` access to these annotation sets. All queried annotation sets must have the same type.
      "A String",
    ],
    "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, referenceId or referenceName must be specified. Defaults to 0.
    "referenceName": "A String", # The name of the reference to query, within the reference set associated with this query.
  }

  x__xgafv: string, V1 error format.

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. This field will be empty if there aren't any additional results.
    "annotations": [ # The matching annotations.
      { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
        "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
        "end": "A String", # The end position of the range on the reference, 0-based exclusive.
        "name": "A String", # The display name of this annotation.
        "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
          "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
            "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
            "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
          },
          "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
            {
              "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
              "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
              "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
            },
          ],
          "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
        },
        "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
          "type": "A String", # Type has been adapted from ClinVar's list of variant types.
          "effect": "A String", # Effect of the variant on the coding sequence.
          "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
            "A String",
          ],
          "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
          "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
          "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
            {
              "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
              "externalIds": [ # The set of external IDs for this condition.
                {
                  "sourceName": "A String", # The name of the source of this data.
                  "id": "A String", # The id used by the source of this data.
                },
              ],
              "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
              "names": [ # A set of names for the condition.
                "A String",
              ],
            },
          ],
          "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
        },
        "start": "A String", # The start position of the range on the reference, 0-based inclusive.
        "annotationSetId": "A String", # The annotation set to which this annotation belongs.
        "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
        "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
        "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
        "id": "A String", # The server-generated annotation ID, unique across all annotations.
      },
    ],
  }
update(annotationId, body, updateMask=None, x__xgafv=None) 
Updates an annotation. Caller must have WRITE permission for the associated dataset.

Args:
  annotationId: string, The ID of the annotation to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
  "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
  "end": "A String", # The end position of the range on the reference, 0-based exclusive.
  "name": "A String", # The display name of this annotation.
  "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
    "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
      "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
      "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
    },
    "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
      {
        "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
        "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
        "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
      },
    ],
    "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
  },
  "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
    "type": "A String", # Type has been adapted from ClinVar's list of variant types.
    "effect": "A String", # Effect of the variant on the coding sequence.
    "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
      "A String",
    ],
    "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
    "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
    "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
      {
        "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
        "externalIds": [ # The set of external IDs for this condition.
          {
            "sourceName": "A String", # The name of the source of this data.
            "id": "A String", # The id used by the source of this data.
          },
        ],
        "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
        "names": [ # A set of names for the condition.
          "A String",
        ],
      },
    ],
    "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
  },
  "start": "A String", # The start position of the range on the reference, 0-based inclusive.
  "annotationSetId": "A String", # The annotation set to which this annotation belongs.
  "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
  "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
  "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
  "id": "A String", # The server-generated annotation ID, unique across all annotations.
}

  updateMask: string, An optional mask specifying which fields to update. Mutable fields are name, variant, transcript, and info. If unspecified, all mutable fields will be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.
    "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    "name": "A String", # The display name of this annotation.
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.
      },
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.
          "frame": 42, # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end `- 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.
        },
      ],
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
    },
    "variant": { # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "referenceName": "A String", # The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`.
    "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.annotationsets.html000066400000000000000000000312411300622755700262420ustar00rootroot00000000000000

Genomics API . annotationsets

Instance Methods

create(body, x__xgafv=None)

Creates a new annotation set. Caller must have WRITE permission for the associated dataset. The following fields are required: * datasetId * referenceSetId All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field).

delete(annotationSetId, x__xgafv=None)

Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

get(annotationSetId, x__xgafv=None)

Gets an annotation set. Caller must have READ permission for the associated dataset.

search(body, x__xgafv=None)

Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

update(annotationSetId, body, x__xgafv=None, updateMask=None)

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

Method Details

create(body, x__xgafv=None) 
Creates a new annotation set. Caller must have WRITE permission for the associated dataset. The following fields are required: * datasetId * referenceSetId All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
  "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "name": "A String", # The display name for this annotation set.
  "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
  "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
  "type": "A String", # The type of annotations contained within this set.
  "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
  "datasetId": "A String", # The dataset to which this annotation set belongs.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "type": "A String", # The type of annotations contained within this set.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
delete(annotationSetId, x__xgafv=None) 
Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

Args:
  annotationSetId: string, The ID of the annotation set to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(annotationSetId, x__xgafv=None) 
Gets an annotation set. Caller must have READ permission for the associated dataset.

Args:
  annotationSetId: string, The ID of the annotation set to be retrieved. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "type": "A String", # The type of annotations contained within this set.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
search(body, x__xgafv=None) 
Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive).
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.
    "datasetIds": [ # Required. The dataset IDs to search within. Caller must have `READ` access to these datasets.
      "A String",
    ],
    "pageToken": "A 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.
    "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
    "types": [ # If specified, only annotation sets that have any of these types are returned.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

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. This field will be empty if there aren't any additional results.
    "annotationSets": [ # The matching annotation sets.
      { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
        "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "name": "A String", # The display name for this annotation set.
        "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
        "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
        "type": "A String", # The type of annotations contained within this set.
        "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
        "datasetId": "A String", # The dataset to which this annotation set belongs.
      },
    ],
  }
update(annotationSetId, body, x__xgafv=None, updateMask=None) 
Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

Args:
  annotationSetId: string, The ID of the annotation set to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
  "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "name": "A String", # The display name for this annotation set.
  "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
  "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
  "type": "A String", # The type of annotations contained within this set.
  "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
  "datasetId": "A String", # The dataset to which this annotation set belongs.
}

  x__xgafv: string, V1 error format.
  updateMask: string, An optional mask specifying which fields to update. Mutable fields are name, source_uri, and info. If unspecified, all mutable fields will be updated.

Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "type": "A String", # The type of annotations contained within this set.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.callsets.html000066400000000000000000000323471300622755700250130ustar00rootroot00000000000000

Genomics API . callsets

Instance Methods

create(body, x__xgafv=None)

Creates a new call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

delete(callSetId, x__xgafv=None)

Deletes a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(callSetId, x__xgafv=None)

Gets a call set by ID. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

patch(callSetId, body, updateMask=None, x__xgafv=None)

Updates a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

search(body, x__xgafv=None)

Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).

Method Details

create(body, x__xgafv=None) 
Creates a new call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "name": "A String", # The call set name.
  "created": "A String", # The date this call set was created in milliseconds from the epoch.
  "sampleId": "A String", # The sample ID this call set corresponds to.
  "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
    "A String",
  ],
  "id": "A String", # The server-generated call set ID, unique across all call sets.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
      "A String",
    ],
    "id": "A String", # The server-generated call set ID, unique across all call sets.
  }
delete(callSetId, x__xgafv=None) 
Deletes a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  callSetId: string, The ID of the call set to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(callSetId, x__xgafv=None) 
Gets a call set by ID. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  callSetId: string, The ID of the call set. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
      "A String",
    ],
    "id": "A String", # The server-generated call set ID, unique across all call sets.
  }
patch(callSetId, body, updateMask=None, x__xgafv=None) 
Updates a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

Args:
  callSetId: string, The ID of the call set to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "name": "A String", # The call set name.
  "created": "A String", # The date this call set was created in milliseconds from the epoch.
  "sampleId": "A String", # The sample ID this call set corresponds to.
  "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
    "A String",
  ],
  "id": "A String", # The server-generated call set ID, unique across all call sets.
}

  updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
      "A String",
    ],
    "id": "A String", # The server-generated call set ID, unique across all call sets.
  }
search(body, x__xgafv=None) 
Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The call set search request.
    "pageToken": "A 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.
    "variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one ID must be provided.
      "A String",
    ],
    "name": "A String", # Only return call sets for which a substring of the name matches this string.
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The call set search response.
    "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. This field will be empty if there aren't any additional results.
    "callSets": [ # The list of matching call sets.
      { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "name": "A String", # The call set name.
        "created": "A String", # The date this call set was created in milliseconds from the epoch.
        "sampleId": "A String", # The sample ID this call set corresponds to.
        "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
          "A String",
        ],
        "id": "A String", # The server-generated call set ID, unique across all call sets.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.datasets.html000066400000000000000000000610051300622755700250020ustar00rootroot00000000000000

Genomics API . datasets

Instance Methods

create(body, x__xgafv=None)

Creates a new dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

delete(datasetId, x__xgafv=None)

Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the datasets.undelete operation. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(datasetId, x__xgafv=None)

Gets a dataset by ID. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

getIamPolicy(resource, body, x__xgafv=None)

Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See Getting a Policy for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)

Lists datasets within a project. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(datasetId, body, updateMask=None, x__xgafv=None)

Updates a dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified dataset. Replaces any existing policy. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) See Setting a Policy for more information.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource. See Testing Permissions for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

undelete(datasetId, body, x__xgafv=None)

Undeletes a dataset by restoring a dataset which was deleted via this API. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This operation is only possible for a week after the deletion occurred.

Method Details

create(body, x__xgafv=None) 
Creates a new dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
  "id": "A String", # The server-generated dataset ID, unique across all datasets.
  "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
  "name": "A String", # The dataset name.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
    "id": "A String", # The server-generated dataset ID, unique across all datasets.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
  }
delete(datasetId, x__xgafv=None) 
Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the datasets.undelete operation. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  datasetId: string, The ID of the dataset to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(datasetId, x__xgafv=None) 
Gets a dataset by ID. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  datasetId: string, The ID of the dataset. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
    "id": "A String", # The server-generated dataset ID, unique across all datasets.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
  }
getIamPolicy(resource, body, x__xgafv=None) 
Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See Getting a Policy for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None) 
Lists datasets within a project. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.
  projectId: string, Required. The Google Cloud project ID to list datasets for.
  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.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The dataset list response.
    "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. This field will be empty if there aren't any additional results.
    "datasets": [ # The list of matching Datasets.
      { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
        "id": "A String", # The server-generated dataset ID, unique across all datasets.
        "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
        "name": "A String", # The dataset name.
      },
    ],
  }
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(datasetId, body, updateMask=None, x__xgafv=None) 
Updates a dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

Args:
  datasetId: string, The ID of the dataset to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
  "id": "A String", # The server-generated dataset ID, unique across all datasets.
  "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
  "name": "A String", # The dataset name.
}

  updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
    "id": "A String", # The server-generated dataset ID, unique across all datasets.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on the specified dataset. Replaces any existing policy. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) See Setting a Policy for more information.

Args:
  resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource. See Testing Permissions for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # REQUIRED: The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. Allowed permissions are: * `genomics.datasets.create` * `genomics.datasets.delete` * `genomics.datasets.get` * `genomics.datasets.list` * `genomics.datasets.update` * `genomics.datasets.getIamPolicy` * `genomics.datasets.setIamPolicy`
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
undelete(datasetId, body, x__xgafv=None) 
Undeletes a dataset by restoring a dataset which was deleted via this API. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This operation is only possible for a week after the deletion occurred.

Args:
  datasetId: string, The ID of the dataset to be undeleted. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
    "id": "A String", # The server-generated dataset ID, unique across all datasets.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.html000066400000000000000000000072021300622755700231720ustar00rootroot00000000000000

Genomics API

Instance Methods

annotations()

Returns the annotations Resource.

annotationsets()

Returns the annotationsets Resource.

callsets()

Returns the callsets Resource.

datasets()

Returns the datasets Resource.

operations()

Returns the operations Resource.

readgroupsets()

Returns the readgroupsets Resource.

reads()

Returns the reads Resource.

references()

Returns the references Resource.

referencesets()

Returns the referencesets Resource.

variants()

Returns the variants Resource.

variantsets()

Returns the variantsets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/genomics_v1.operations.html000066400000000000000000000322151300622755700253560ustar00rootroot00000000000000

Genomics API . operations

Instance Methods

cancel(name, body, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, body, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for Operations.CancelOperation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.
  filter: string, A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
        "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/genomics_v1.readgroupsets.coveragebuckets.html000066400000000000000000000147511300622755700312420ustar00rootroot00000000000000

Genomics API . readgroupsets . coveragebuckets

Instance Methods

list(readGroupSetId, targetBucketWidth=None, pageSize=None, x__xgafv=None, end=None, start=None, referenceName=None, pageToken=None)

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(readGroupSetId, targetBucketWidth=None, pageSize=None, x__xgafv=None, end=None, start=None, referenceName=None, pageToken=None) 
Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

Args:
  readGroupSetId: string, Required. The ID of the read group set over which coverage is requested. (required)
  targetBucketWidth: string, The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as `bucketWidth` in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed `bucketWidth` is currently 2048 base pairs; this is subject to change.
  pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.
  x__xgafv: string, V1 error format.
  end: string, The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified. If unset or 0, defaults to the length of the reference.
  start: string, The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified. Defaults to 0.
  referenceName: string, The name of the reference to query, within the reference set associated with this query. Optional.
  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.

Returns:
  An object of the form:

    {
    "coverageBuckets": [ # The coverage buckets. The list of buckets is sparse; a bucket with 0 overlapping reads is not returned. A bucket never crosses more than one reference sequence. Each bucket has width `bucketWidth`, unless its end is the end of the reference sequence.
      { # A bucket over which read coverage has been precomputed. A bucket corresponds to a specific range of the reference sequence.
        "meanCoverage": 3.14, # The average number of reads which are aligned to each individual reference base in this bucket.
        "range": { # A 0-based half-open genomic coordinate range for search requests. # The genomic coordinate range spanned by this bucket.
          "start": "A String", # The start position of the range on the reference, 0-based inclusive.
          "end": "A String", # The end position of the range on the reference, 0-based exclusive.
          "referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`.
        },
      },
    ],
    "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. This field will be empty if there aren't any additional results.
    "bucketWidth": "A String", # The length of each coverage bucket in base pairs. Note that buckets at the end of a reference sequence may be shorter. This value is omitted if the bucket width is infinity (the default behaviour, with no range or `targetBucketWidth`).
  }
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.
google-api-python-client-1.5.5/docs/dyn/genomics_v1.readgroupsets.html000066400000000000000000001061701300622755700260640ustar00rootroot00000000000000

Genomics API . readgroupsets

Instance Methods

coveragebuckets()

Returns the coveragebuckets Resource.

delete(readGroupSetId, x__xgafv=None)

Deletes a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

export(readGroupSetId, body, x__xgafv=None)

Exports a read group set to a BAM file in Google Cloud Storage. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See ImportReadGroupSets for caveats.

get(readGroupSetId, x__xgafv=None)

Gets a read group set by ID. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

import_(body, x__xgafv=None)

Creates read group sets by asynchronously importing the provided information. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The caller must have WRITE permissions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import - Tags will be converted to strings - tag types are not preserved - Comments (`@CO`) in the input file header will not be preserved - Original header order of references (`@SQ`) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (also the "BQ" and "OQ" tags, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)

patch(readGroupSetId, body, updateMask=None, x__xgafv=None)

Updates a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

search(body, x__xgafv=None)

Searches for read group sets matching the criteria. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).

Method Details

delete(readGroupSetId, x__xgafv=None) 
Deletes a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  readGroupSetId: string, The ID of the read group set to be deleted. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
export(readGroupSetId, body, x__xgafv=None) 
Exports a read group set to a BAM file in Google Cloud Storage. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See ImportReadGroupSets for caveats.

Args:
  readGroupSetId: string, Required. The ID of the read group set to export. The caller must have READ access to this read group set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The read group set export request.
    "projectId": "A String", # Required. The Google Cloud project ID that owns this export. The caller must have WRITE access to this project.
    "referenceNames": [ # The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use `*` to export only unmapped reads.
      "A String",
    ],
    "exportUri": "A String", # Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated user must have write access to the new file. An error will be returned if the URI already contains data.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(readGroupSetId, x__xgafv=None) 
Gets a read group set by ID. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  readGroupSetId: string, The ID of the read group set. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "info": { # A map of additional read group set information.
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
    "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
      { # A read group is all the data that's processed the same way by the sequencer.
        "info": { # A map of additional read group information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
        "description": "A String", # A free-form text description of this read group.
        "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
          {
            "commandLine": "A String", # The command line used to run this program.
            "prevProgramId": "A String", # The ID of the program run before this one.
            "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs.
            "version": "A String", # The version of the program run.
            "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
          },
        ],
        "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
        "experiment": { # The experiment used to generate this read group.
          "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
          "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation.
          "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec.
          "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec.
        },
        "referenceSetId": "A String", # The reference set the reads in this read group are aligned to.
        "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name.
        "datasetId": "A String", # The dataset to which this read group belongs.
        "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
      },
    ],
    "filename": "A String", # The filename of the original source file for this read group set, if any.
    "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned.
    "id": "A String", # The server-generated read group set ID, unique for all read group sets.
    "datasetId": "A String", # The dataset to which this read group set belongs.
  }
import_(body, x__xgafv=None) 
Creates read group sets by asynchronously importing the provided information. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The caller must have WRITE permissions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import - Tags will be converted to strings - tag types are not preserved - Comments (`@CO`) in the input file header will not be preserved - Original header order of references (`@SQ`) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (also the "BQ" and "OQ" tags, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read group set import request.
    "sourceUris": [ # A list of URIs pointing at [BAM files](https://samtools.github.io/hts-specs/SAMv1.pdf) in Google Cloud Storage.
      "A String",
    ],
    "referenceSetId": "A String", # The reference set to which the imported read group sets are aligned to, if any. The reference names of this reference set must be a superset of those found in the imported file headers. If no reference set id is provided, a best effort is made to associate with a matching reference set.
    "partitionStrategy": "A String", # The partition strategy describes how read groups are partitioned into read group sets.
    "datasetId": "A String", # Required. The ID of the dataset these read group sets will belong to. The caller must have WRITE permissions to this dataset.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
patch(readGroupSetId, body, updateMask=None, x__xgafv=None) 
Updates a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

Args:
  readGroupSetId: string, The ID of the read group set to be updated. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "info": { # A map of additional read group set information.
    "a_key": [
      "",
    ],
  },
  "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
  "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
    { # A read group is all the data that's processed the same way by the sequencer.
      "info": { # A map of additional read group information. This must be of the form map (string key mapping to a list of string values).
        "a_key": [
          "",
        ],
      },
      "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
      "description": "A String", # A free-form text description of this read group.
      "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
        {
          "commandLine": "A String", # The command line used to run this program.
          "prevProgramId": "A String", # The ID of the program run before this one.
          "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs.
          "version": "A String", # The version of the program run.
          "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
        },
      ],
      "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
      "experiment": { # The experiment used to generate this read group.
        "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
        "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation.
        "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec.
        "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec.
      },
      "referenceSetId": "A String", # The reference set the reads in this read group are aligned to.
      "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name.
      "datasetId": "A String", # The dataset to which this read group belongs.
      "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
    },
  ],
  "filename": "A String", # The filename of the original source file for this read group set, if any.
  "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned.
  "id": "A String", # The server-generated read group set ID, unique for all read group sets.
  "datasetId": "A String", # The dataset to which this read group set belongs.
}

  updateMask: string, An optional mask specifying which fields to update. Supported fields: * name. * referenceSetId. Leaving `updateMask` unset is equivalent to specifying all mutable fields.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "info": { # A map of additional read group set information.
      "a_key": [
        "",
      ],
    },
    "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
    "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
      { # A read group is all the data that's processed the same way by the sequencer.
        "info": { # A map of additional read group information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
        "description": "A String", # A free-form text description of this read group.
        "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
          {
            "commandLine": "A String", # The command line used to run this program.
            "prevProgramId": "A String", # The ID of the program run before this one.
            "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs.
            "version": "A String", # The version of the program run.
            "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
          },
        ],
        "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
        "experiment": { # The experiment used to generate this read group.
          "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
          "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation.
          "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec.
          "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec.
        },
        "referenceSetId": "A String", # The reference set the reads in this read group are aligned to.
        "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name.
        "datasetId": "A String", # The dataset to which this read group belongs.
        "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
      },
    ],
    "filename": "A String", # The filename of the original source file for this read group set, if any.
    "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned.
    "id": "A String", # The server-generated read group set ID, unique for all read group sets.
    "datasetId": "A String", # The dataset to which this read group set belongs.
  }
search(body, x__xgafv=None) 
Searches for read group sets matching the criteria. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read group set search request.
    "pageToken": "A 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.
    "datasetIds": [ # Restricts this query to read group sets within the given datasets. At least one ID must be provided.
      "A String",
    ],
    "name": "A String", # Only return read group sets for which a substring of the name matches this string.
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 1024.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The read group set search response.
    "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. This field will be empty if there aren't any additional results.
    "readGroupSets": [ # The list of matching read group sets.
      { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "info": { # A map of additional read group set information.
          "a_key": [
            "",
          ],
        },
        "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
        "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
          { # A read group is all the data that's processed the same way by the sequencer.
            "info": { # A map of additional read group information. This must be of the form map (string key mapping to a list of string values).
              "a_key": [
                "",
              ],
            },
            "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
            "description": "A String", # A free-form text description of this read group.
            "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
              {
                "commandLine": "A String", # The command line used to run this program.
                "prevProgramId": "A String", # The ID of the program run before this one.
                "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs.
                "version": "A String", # The version of the program run.
                "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
              },
            ],
            "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
            "experiment": { # The experiment used to generate this read group.
              "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
              "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation.
              "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec.
              "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec.
            },
            "referenceSetId": "A String", # The reference set the reads in this read group are aligned to.
            "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name.
            "datasetId": "A String", # The dataset to which this read group belongs.
            "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
          },
        ],
        "filename": "A String", # The filename of the original source file for this read group set, if any.
        "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned.
        "id": "A String", # The server-generated read group set ID, unique for all read group sets.
        "datasetId": "A String", # The dataset to which this read group set belongs.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.reads.html000066400000000000000000000637021300622755700242760ustar00rootroot00000000000000

Genomics API . reads

Instance Methods

search(body, x__xgafv=None)

Gets a list of reads for one or more read group sets. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield reads in the same order across their respective streams of paginated responses. Implements [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).

stream(body, x__xgafv=None)

Returns a stream of all the reads matching the search request, ordered by reference name, position, and ID.

Method Details

search(body, x__xgafv=None) 
Gets a list of reads for one or more read group sets. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield reads in the same order across their respective streams of paginated responses. Implements [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read search request.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified.
    "readGroupIds": [ # The IDs of the read groups within which to search for reads. All specified read groups must belong to the same read group sets. Must specify one of `readGroupSetIds` or `readGroupIds`.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.
    "pageToken": "A 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.
    "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified.
    "referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to `*`, only unmapped reads are returned. If unspecified, all reads (mapped and unmapped) are returned.
    "readGroupSetIds": [ # The IDs of the read groups sets within which to search for reads. All specified read group sets must be aligned against a common set of reference sequences; this defines the genomic coordinates for the query. Must specify one of `readGroupSetIds` or `readGroupIds`.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The read search response.
    "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. This field will be empty if there aren't any additional results.
    "alignments": [ # The list of matching alignments sorted by mapped genomic coordinate, if any, ascending in position within the same reference. Unmapped reads, which have no position, are returned contiguously and are sorted in ascending lexicographic order by fragment name.
      { # A read alignment describes a linear alignment of a string of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one read group set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) ### Reverse-stranded reads Mapped reads (reads having a non-null `alignment`) can be aligned to either the forward or the reverse strand of their associated reference. Strandedness of a mapped read is encoded by `alignment.position.reverseStrand`. If we consider the reference to be a forward-stranded coordinate space of `[0, reference.length)` with `0` as the left-most position and `reference.length` as the right-most position, reads are always aligned left to right. That is, `alignment.position.position` always refers to the left-most reference coordinate and `alignment.cigar` describes the alignment of this read to the reference from left to right. All per-base fields such as `alignedSequence` and `alignedQuality` share this same left-to-right orientation; this is true of reads which are aligned to either strand. For reverse-stranded reads, this means that `alignedSequence` is the reverse complement of the bases that were originally reported by the sequencing machine. ### Generating a reference-aligned sequence string When interacting with mapped reads, it's often useful to produce a string representing the local alignment of the read to reference. The following pseudocode demonstrates one way of doing this: out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out ### Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the `cigar` field. Note that this is a lossy conversion (`cigar.referenceSequence` is lost). cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr
        "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400).
        "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The mapping of the primary alignment of the `(readNumber+1)%numberReads` read in the fragment. It replaces mate position and mate strand in SAM.
          "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
          "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
          "referenceName": "A String", # The name of the reference in whatever reference set is being used.
        },
        "readGroupSetId": "A String", # The ID of the read group set this read belongs to. A read belongs to exactly one read group set.
        "numberReads": 42, # The number of reads in the fragment (extension to SAM flag 0x1).
        "failedVendorQualityChecks": True or False, # Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200).
        "fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM.
        "readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80.
        "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2).
        "readGroupId": "A String", # The ID of the read group this read belongs to. A read belongs to exactly one read group. This is a server-generated ID which is distinct from SAM's RG tag (for that value, see ReadGroup.name).
        "supplementaryAlignment": True or False, # Whether this alignment is supplementary. Equivalent to SAM flag 0x800. Supplementary alignments are used in the representation of a chimeric alignment. In a chimeric alignment, a read is split into multiple linear alignments that map to different reference contigs. The first linear alignment in the read will be designated as the representative alignment; the remaining linear alignments will be designated as supplementary alignments. These alignments may have different mapping quality scores. In each linear alignment in a chimeric alignment, the read will be hard clipped. The `alignedSequence` and `alignedQuality` fields in the alignment record will only represent the bases for its respective linear alignment.
        "alignedQuality": [ # The quality of the read sequence contained in this alignment record (equivalent to QUAL in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
          42,
        ],
        "fragmentLength": 42, # The observed length of the fragment, equivalent to TLEN in SAM.
        "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, **without CIGAR operations applied** (equivalent to SEQ in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
        "id": "A String", # The server-generated read ID, unique across all reads. This is different from the `fragmentName`.
        "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field is null for unmapped reads.
          "position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment.
            "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
            "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
            "referenceName": "A String", # The name of the reference in whatever reference set is being used.
          },
          "cigar": [ # Represents the local alignment of this sequence (alignment matches, indels, etc) against the reference.
            { # A single CIGAR operation.
              "referenceSequence": "A String", # `referenceSequence` is only used at mismatches (`SEQUENCE_MISMATCH`) and deletions (`DELETE`). Filling this field replaces SAM's MD tag. If the relevant information is not available, this field is unset.
              "operation": "A String",
              "operationLength": "A String", # The number of genomic bases that the operation runs for. Required.
            },
          ],
          "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations. Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer.
        },
        "secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both `secondaryAlignment` and `supplementaryAlignment` are false.
      },
    ],
  }
stream(body, x__xgafv=None) 
Returns a stream of all the reads matching the search request, ordered by reference name, position, and ID.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The stream reads request.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified.
    "totalShards": 42, # Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned for each query with a unique `shard` parameter specified. A best effort is made to yield equally sized shards. Sharding can be used to distribute processing amongst workers, where each worker is assigned a unique `shard` number and all workers specify the same `totalShards` number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to those returned by a single unsharded query. Queries for different values of `totalShards` with common divisors will share shard boundaries. For example, streaming `shard` 2 of 5 `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This property can be leveraged for adaptive retries.
    "readGroupSetId": "A String", # The ID of the read group set from which to stream reads.
    "projectId": "A String", # The Google Cloud project ID which will be billed for this access. The caller must have WRITE access to this project. Required.
    "shard": 42, # Restricts results to a shard containing approximately `1/totalShards` of the normal response payload for this query. Results from a sharded request are disjoint from those returned by all queries which differ only in their shard parameter. A shard may yield 0 results; this is especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`.
    "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified.
    "referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, only unmapped reads are returned.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "alignments": [
      { # A read alignment describes a linear alignment of a string of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one read group set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) ### Reverse-stranded reads Mapped reads (reads having a non-null `alignment`) can be aligned to either the forward or the reverse strand of their associated reference. Strandedness of a mapped read is encoded by `alignment.position.reverseStrand`. If we consider the reference to be a forward-stranded coordinate space of `[0, reference.length)` with `0` as the left-most position and `reference.length` as the right-most position, reads are always aligned left to right. That is, `alignment.position.position` always refers to the left-most reference coordinate and `alignment.cigar` describes the alignment of this read to the reference from left to right. All per-base fields such as `alignedSequence` and `alignedQuality` share this same left-to-right orientation; this is true of reads which are aligned to either strand. For reverse-stranded reads, this means that `alignedSequence` is the reverse complement of the bases that were originally reported by the sequencing machine. ### Generating a reference-aligned sequence string When interacting with mapped reads, it's often useful to produce a string representing the local alignment of the read to reference. The following pseudocode demonstrates one way of doing this: out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out ### Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the `cigar` field. Note that this is a lossy conversion (`cigar.referenceSequence` is lost). cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr
        "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400).
        "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The mapping of the primary alignment of the `(readNumber+1)%numberReads` read in the fragment. It replaces mate position and mate strand in SAM.
          "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
          "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
          "referenceName": "A String", # The name of the reference in whatever reference set is being used.
        },
        "readGroupSetId": "A String", # The ID of the read group set this read belongs to. A read belongs to exactly one read group set.
        "numberReads": 42, # The number of reads in the fragment (extension to SAM flag 0x1).
        "failedVendorQualityChecks": True or False, # Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200).
        "fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM.
        "readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80.
        "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2).
        "readGroupId": "A String", # The ID of the read group this read belongs to. A read belongs to exactly one read group. This is a server-generated ID which is distinct from SAM's RG tag (for that value, see ReadGroup.name).
        "supplementaryAlignment": True or False, # Whether this alignment is supplementary. Equivalent to SAM flag 0x800. Supplementary alignments are used in the representation of a chimeric alignment. In a chimeric alignment, a read is split into multiple linear alignments that map to different reference contigs. The first linear alignment in the read will be designated as the representative alignment; the remaining linear alignments will be designated as supplementary alignments. These alignments may have different mapping quality scores. In each linear alignment in a chimeric alignment, the read will be hard clipped. The `alignedSequence` and `alignedQuality` fields in the alignment record will only represent the bases for its respective linear alignment.
        "alignedQuality": [ # The quality of the read sequence contained in this alignment record (equivalent to QUAL in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
          42,
        ],
        "fragmentLength": 42, # The observed length of the fragment, equivalent to TLEN in SAM.
        "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, **without CIGAR operations applied** (equivalent to SEQ in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
        "id": "A String", # The server-generated read ID, unique across all reads. This is different from the `fragmentName`.
        "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field is null for unmapped reads.
          "position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment.
            "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
            "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
            "referenceName": "A String", # The name of the reference in whatever reference set is being used.
          },
          "cigar": [ # Represents the local alignment of this sequence (alignment matches, indels, etc) against the reference.
            { # A single CIGAR operation.
              "referenceSequence": "A String", # `referenceSequence` is only used at mismatches (`SEQUENCE_MISMATCH`) and deletions (`DELETE`). Filling this field replaces SAM's MD tag. If the relevant information is not available, this field is unset.
              "operation": "A String",
              "operationLength": "A String", # The number of genomic bases that the operation runs for. Required.
            },
          ],
          "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations. Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer.
        },
        "secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both `secondaryAlignment` and `supplementaryAlignment` are false.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.references.bases.html000066400000000000000000000101101300622755700263760ustar00rootroot00000000000000

Genomics API . references . bases

Instance Methods

list(referenceId, end=None, pageSize=None, x__xgafv=None, pageToken=None, start=None)

Lists the bases in a reference, optionally restricted to a range. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(referenceId, end=None, pageSize=None, x__xgafv=None, pageToken=None, start=None) 
Lists the bases in a reference, optionally restricted to a range. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).

Args:
  referenceId: string, The ID of the reference. (required)
  end: string, The end position (0-based, exclusive) of this query. Defaults to the length of this reference.
  pageSize: integer, The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base pairs).
  x__xgafv: string, V1 error format.
  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.
  start: string, The start position (0-based) of this query. Defaults to 0.

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. This field will be empty if there aren't any additional results.
    "sequence": "A String", # A substring of the bases that make up this reference.
    "offset": "A String", # The offset position (0-based) of the given `sequence` from the start of this `Reference`. This value will differ for each page in a paginated 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.
google-api-python-client-1.5.5/docs/dyn/genomics_v1.references.html000066400000000000000000000157531300622755700253240ustar00rootroot00000000000000

Genomics API . references

Instance Methods

bases()

Returns the bases Resource.

get(referenceId, x__xgafv=None)

Gets a reference. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).

search(body, x__xgafv=None)

Searches for references which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).

Method Details

get(referenceId, x__xgafv=None) 
Gets a reference. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).

Args:
  referenceId: string, The ID of the reference. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "name": "A String", # The name of this reference, for example `22`.
    "sourceUri": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file.
    "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.26`.
      "A String",
    ],
    "length": "A String", # The length of this reference's sequence.
    "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
    "id": "A String", # The server-generated reference ID, unique across all references.
    "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
  }
search(body, x__xgafv=None) 
Searches for references which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "md5checksums": [ # If present, return references for which the md5checksum matches exactly.
      "A String",
    ],
    "pageToken": "A 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.
    "referenceSetId": "A String", # If present, return only references which belong to this reference set.
    "accessions": [ # If present, return references for which a prefix of any of sourceAccessions match any of these strings. Accession numbers typically have a main number and a version, for example `GCF_000001405.26`.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
  }

  x__xgafv: string, V1 error format.

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. This field will be empty if there aren't any additional results.
    "references": [ # The matching references.
      { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "name": "A String", # The name of this reference, for example `22`.
        "sourceUri": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.26`.
          "A String",
        ],
        "length": "A String", # The length of this reference's sequence.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
        "id": "A String", # The server-generated reference ID, unique across all references.
        "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.referencesets.html000066400000000000000000000203011300622755700260210ustar00rootroot00000000000000

Genomics API . referencesets

Instance Methods

get(referenceSetId, x__xgafv=None)

Gets a reference set. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

search(body, x__xgafv=None)

Searches for reference sets which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)

Method Details

get(referenceSetId, x__xgafv=None) 
Gets a reference set. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

Args:
  referenceSetId: string, The ID of the reference set. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "description": "A String", # Free text description of this reference set.
    "sourceUri": "A String", # The URI from which the references were obtained.
    "referenceIds": [ # The IDs of the reference objects that are part of this set. `Reference.md5checksum` must be unique within this set.
      "A String",
    ],
    "assemblyId": "A String", # Public id of this reference set, such as `GRCh37`.
    "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `NC_000001.11`.
      "A String",
    ],
    "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string `reference.md5checksum` (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format.
    "id": "A String", # The server-generated reference set ID, unique across all reference sets.
    "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome.
  }
search(body, x__xgafv=None) 
Searches for reference sets which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "md5checksums": [ # If present, return reference sets for which the md5checksum matches exactly.
      "A String",
    ],
    "assemblyId": "A String", # If present, return reference sets for which a substring of their `assemblyId` matches this string (case insensitive).
    "accessions": [ # If present, return reference sets for which a prefix of any of sourceAccessions match any of these strings. Accession numbers typically have a main number and a version, for example `NC_000001.11`.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
    "pageToken": "A 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.
  }

  x__xgafv: string, V1 error format.

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. This field will be empty if there aren't any additional results.
    "referenceSets": [ # The matching references sets.
      { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "description": "A String", # Free text description of this reference set.
        "sourceUri": "A String", # The URI from which the references were obtained.
        "referenceIds": [ # The IDs of the reference objects that are part of this set. `Reference.md5checksum` must be unique within this set.
          "A String",
        ],
        "assemblyId": "A String", # Public id of this reference set, such as `GRCh37`.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `NC_000001.11`.
          "A String",
        ],
        "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string `reference.md5checksum` (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format.
        "id": "A String", # The server-generated reference set ID, unique across all reference sets.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.variants.html000066400000000000000000001617471300622755700250370ustar00rootroot00000000000000

Genomics API . variants

Instance Methods

create(body, x__xgafv=None)

Creates a new variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

delete(variantId, x__xgafv=None)

Deletes a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(variantId, x__xgafv=None)

Gets a variant by ID. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

import_(body, x__xgafv=None)

Creates variant data by asynchronously importing the provided information. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The variants for import will be merged with any existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created. When variants are merged, the call information from the new variant is added to the existing variant, and Variant info fields are merged as specified in infoMergeConfig. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.

merge(body, x__xgafv=None)

Merges the given variants with existing variants. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created. When variants are merged, the call information from the new variant is added to the existing variant. Variant info fields are merged as specified in the infoMergeConfig field of the MergeVariantsRequest. Please exercise caution when using this method! It is easy to introduce mistakes in existing variants and difficult to back out of them. For example, suppose you were trying to merge a new variant with an existing one and both variants contain calls that belong to callsets with the same callset ID. // Existing variant - irrelevant fields trimmed for clarity { "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ { "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 0, 1 ], } ] } // New variant with conflicting call information { "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ { "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 1, 1 ], } ] } The resulting merged variant would overwrite the existing calls with those from the new variant: { "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ { "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 1, 1 ], } ] } This may be the desired outcome, but it is up to the user to determine if if that is indeed the case.

patch(variantId, body, x__xgafv=None, updateMask=None)

Updates a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics. Returns the modified variant without its calls.

search(body, x__xgafv=None)

Gets a list of variants matching the criteria. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).

stream(body, x__xgafv=None)

Returns a stream of all the variants matching the search request, ordered by reference name, position, and ID.

Method Details

create(body, x__xgafv=None) 
Creates a new variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
  "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "variantSetId": "A String", # The ID of the variant set this variant belongs to.
  "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
  "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
    { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
      "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
        "a_key": [
          "",
        ],
      },
      "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
        42,
      ],
      "callSetId": "A String", # The ID of the call set this variant call belongs to.
      "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
      "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
        3.14,
      ],
      "callSetName": "A String", # The name of the call set this variant call belongs to.
    },
  ],
  "created": "A String", # The date this variant was created, in milliseconds from the epoch.
  "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
  "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
    "A String",
  ],
  "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
  "names": [ # Names for the variant, for example a RefSNP ID.
    "A String",
  ],
  "alternateBases": [ # The bases that appear instead of the reference bases.
    "A String",
  ],
  "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
  "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
  "id": "A String", # The server-generated variant ID, unique across all variants.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
    "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "variantSetId": "A String", # The ID of the variant set this variant belongs to.
    "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
    "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
      { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
        "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
          42,
        ],
        "callSetId": "A String", # The ID of the call set this variant call belongs to.
        "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
        "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
          3.14,
        ],
        "callSetName": "A String", # The name of the call set this variant call belongs to.
      },
    ],
    "created": "A String", # The date this variant was created, in milliseconds from the epoch.
    "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
    "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
      "A String",
    ],
    "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
    "names": [ # Names for the variant, for example a RefSNP ID.
      "A String",
    ],
    "alternateBases": [ # The bases that appear instead of the reference bases.
      "A String",
    ],
    "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
    "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
    "id": "A String", # The server-generated variant ID, unique across all variants.
  }
delete(variantId, x__xgafv=None) 
Deletes a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  variantId: string, The ID of the variant to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(variantId, x__xgafv=None) 
Gets a variant by ID. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  variantId: string, The ID of the variant. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
    "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "variantSetId": "A String", # The ID of the variant set this variant belongs to.
    "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
    "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
      { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
        "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
          42,
        ],
        "callSetId": "A String", # The ID of the call set this variant call belongs to.
        "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
        "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
          3.14,
        ],
        "callSetName": "A String", # The name of the call set this variant call belongs to.
      },
    ],
    "created": "A String", # The date this variant was created, in milliseconds from the epoch.
    "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
    "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
      "A String",
    ],
    "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
    "names": [ # Names for the variant, for example a RefSNP ID.
      "A String",
    ],
    "alternateBases": [ # The bases that appear instead of the reference bases.
      "A String",
    ],
    "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
    "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
    "id": "A String", # The server-generated variant ID, unique across all variants.
  }
import_(body, x__xgafv=None) 
Creates variant data by asynchronously importing the provided information. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The variants for import will be merged with any existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created. When variants are merged, the call information from the new variant is added to the existing variant, and Variant info fields are merged as specified in infoMergeConfig. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The variant data import request.
    "variantSetId": "A String", # Required. The variant set to which variant data should be imported.
    "normalizeReferenceNames": True or False, # Convert reference names to the canonical representation. hg19 haploytypes (those reference names containing "_hap") are not modified in any way. All other reference names are modified according to the following rules: The reference name is capitalized. The "chr" prefix is dropped for all autosomes and sex chromsomes. For example "chr17" becomes "17" and "chrX" becomes "X". All mitochondrial chromosomes ("chrM", "chrMT", etc) become "MT".
    "sourceUris": [ # A list of URIs referencing variant files in Google Cloud Storage. URIs can include wildcards [as described here](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note that recursive wildcards ('**') are not supported.
      "A String",
    ],
    "infoMergeConfig": { # A mapping between info field keys and the InfoMergeOperations to be performed on them. This is plumbed down to the MergeVariantRequests generated by the resulting import job.
      "a_key": "A String",
    },
    "format": "A String", # The format of the variant data being imported. If unspecified, defaults to to `VCF`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
merge(body, x__xgafv=None) 
Merges the given variants with existing variants. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created. When variants are merged, the call information from the new variant is added to the existing variant. Variant info fields are merged as specified in the infoMergeConfig field of the MergeVariantsRequest. Please exercise caution when using this method! It is easy to introduce mistakes in existing variants and difficult to back out of them. For example, suppose you were trying to merge a new variant with an existing one and both variants contain calls that belong to callsets with the same callset ID. // Existing variant - irrelevant fields trimmed for clarity { "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ { "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 0, 1 ], } ] } // New variant with conflicting call information { "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ { "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 1, 1 ], } ] } The resulting merged variant would overwrite the existing calls with those from the new variant: { "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ { "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 1, 1 ], } ] } This may be the desired outcome, but it is up to the user to determine if if that is indeed the case.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "variantSetId": "A String", # The destination variant set.
    "variants": [ # The variants to be merged with existing variants.
      { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
        "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "variantSetId": "A String", # The ID of the variant set this variant belongs to.
        "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
        "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
          { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
            "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
              "a_key": [
                "",
              ],
            },
            "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
              42,
            ],
            "callSetId": "A String", # The ID of the call set this variant call belongs to.
            "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
            "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
              3.14,
            ],
            "callSetName": "A String", # The name of the call set this variant call belongs to.
          },
        ],
        "created": "A String", # The date this variant was created, in milliseconds from the epoch.
        "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
        "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
          "A String",
        ],
        "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
        "names": [ # Names for the variant, for example a RefSNP ID.
          "A String",
        ],
        "alternateBases": [ # The bases that appear instead of the reference bases.
          "A String",
        ],
        "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
        "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
        "id": "A String", # The server-generated variant ID, unique across all variants.
      },
    ],
    "infoMergeConfig": { # A mapping between info field keys and the InfoMergeOperations to be performed on them.
      "a_key": "A String",
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
patch(variantId, body, x__xgafv=None, updateMask=None) 
Updates a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics. Returns the modified variant without its calls.

Args:
  variantId: string, The ID of the variant to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
  "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
    "a_key": [
      "",
    ],
  },
  "variantSetId": "A String", # The ID of the variant set this variant belongs to.
  "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
  "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
    { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
      "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
        "a_key": [
          "",
        ],
      },
      "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
        42,
      ],
      "callSetId": "A String", # The ID of the call set this variant call belongs to.
      "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
      "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
        3.14,
      ],
      "callSetName": "A String", # The name of the call set this variant call belongs to.
    },
  ],
  "created": "A String", # The date this variant was created, in milliseconds from the epoch.
  "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
  "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
    "A String",
  ],
  "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
  "names": [ # Names for the variant, for example a RefSNP ID.
    "A String",
  ],
  "alternateBases": [ # The bases that appear instead of the reference bases.
    "A String",
  ],
  "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
  "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
  "id": "A String", # The server-generated variant ID, unique across all variants.
}

  x__xgafv: string, V1 error format.
  updateMask: string, An optional mask specifying which fields to update. At this time, mutable fields are names and info. Acceptable values are "names" and "info". If unspecified, all mutable fields will be updated.

Returns:
  An object of the form:

    { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
    "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
      "a_key": [
        "",
      ],
    },
    "variantSetId": "A String", # The ID of the variant set this variant belongs to.
    "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
    "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
      { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
        "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
          42,
        ],
        "callSetId": "A String", # The ID of the call set this variant call belongs to.
        "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
        "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
          3.14,
        ],
        "callSetName": "A String", # The name of the call set this variant call belongs to.
      },
    ],
    "created": "A String", # The date this variant was created, in milliseconds from the epoch.
    "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
    "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
      "A String",
    ],
    "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
    "names": [ # Names for the variant, for example a RefSNP ID.
      "A String",
    ],
    "alternateBases": [ # The bases that appear instead of the reference bases.
      "A String",
    ],
    "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
    "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
    "id": "A String", # The server-generated variant ID, unique across all variants.
  }
search(body, x__xgafv=None) 
Gets a list of variants matching the criteria. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The variant search request.
    "end": "A String", # The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference.
    "pageSize": 42, # The maximum number of variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000.
    "pageToken": "A 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.
    "maxCalls": 42, # The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000.
    "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0.
    "callSetIds": [ # Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all.
      "A String",
    ],
    "variantName": "A String", # Only return variants which have exactly this name.
    "referenceName": "A String", # Required. Only return variants in this reference sequence.
    "variantSetIds": [ # At most one variant set ID must be provided. Only variants from this variant set will be returned. If omitted, a call set id must be included in the request.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The variant search response.
    "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. This field will be empty if there aren't any additional results.
    "variants": [ # The list of matching Variants.
      { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
        "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "variantSetId": "A String", # The ID of the variant set this variant belongs to.
        "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
        "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
          { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
            "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
              "a_key": [
                "",
              ],
            },
            "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
              42,
            ],
            "callSetId": "A String", # The ID of the call set this variant call belongs to.
            "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
            "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
              3.14,
            ],
            "callSetName": "A String", # The name of the call set this variant call belongs to.
          },
        ],
        "created": "A String", # The date this variant was created, in milliseconds from the epoch.
        "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
        "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
          "A String",
        ],
        "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
        "names": [ # Names for the variant, for example a RefSNP ID.
          "A String",
        ],
        "alternateBases": [ # The bases that appear instead of the reference bases.
          "A String",
        ],
        "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
        "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
        "id": "A String", # The server-generated variant ID, unique across all variants.
      },
    ],
  }
stream(body, x__xgafv=None) 
Returns a stream of all the variants matching the search request, ordered by reference name, position, and ID.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The stream variants request.
    "variantSetId": "A String", # The variant set ID from which to stream variants.
    "end": "A String", # The end of the window (0-based, exclusive) for which overlapping variants should be returned.
    "projectId": "A String", # The Google Cloud project ID which will be billed for this access. The caller must have WRITE access to this project. Required.
    "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned.
    "callSetIds": [ # Only return variant calls which belong to call sets with these IDs. Leaving this blank returns all variant calls.
      "A String",
    ],
    "referenceName": "A String", # Required. Only return variants in this reference sequence.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "variants": [
      { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
        "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "variantSetId": "A String", # The ID of the variant set this variant belongs to.
        "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
        "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
          { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
            "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values).
              "a_key": [
                "",
              ],
            },
            "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned.
              42,
            ],
            "callSetId": "A String", # The ID of the call set this variant call belongs to.
            "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`.
            "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`.
              3.14,
            ],
            "callSetName": "A String", # The name of the call set this variant call belongs to.
          },
        ],
        "created": "A String", # The date this variant was created, in milliseconds from the epoch.
        "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
        "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters.
          "A String",
        ],
        "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
        "names": [ # Names for the variant, for example a RefSNP ID.
          "A String",
        ],
        "alternateBases": [ # The bases that appear instead of the reference bases.
          "A String",
        ],
        "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`)
        "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
        "id": "A String", # The server-generated variant ID, unique across all variants.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1.variantsets.html000066400000000000000000000734251300622755700255460ustar00rootroot00000000000000

Genomics API . variantsets

Instance Methods

create(body, x__xgafv=None)

Creates a new variant set. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.

delete(variantSetId, x__xgafv=None)

Deletes a variant set including all variants, call sets, and calls within. This is not reversible. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

export(variantSetId, body, x__xgafv=None)

Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(variantSetId, x__xgafv=None)

Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

patch(variantSetId, body, updateMask=None, x__xgafv=None)

Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

search(body, x__xgafv=None)

Returns a list of all variant sets matching search criteria. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).

Method Details

create(body, x__xgafv=None) 
Creates a new variant set. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "name": "A String", # User-specified, mutable name.
  "description": "A String", # A textual description of this variant set.
  "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
    { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
      "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
      "referenceName": "A String", # The name of the reference associated with this reference bound.
    },
  ],
  "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
  "id": "A String", # The server-generated variant set ID, unique across all variant sets.
  "datasetId": "A String", # The dataset to which this variant set belongs.
  "metadata": [ # The metadata associated with this variant set.
    { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
      "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
        "a_key": [
          "",
        ],
      },
      "description": "A String", # A textual description of this metadata.
      "number": "A String", # The number of values that can be included in a field described by this metadata.
      "value": "A String", # The value field for simple metadata
      "key": "A String", # The top-level key.
      "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
      "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
    },
  ],
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The server-generated variant set ID, unique across all variant sets.
    "datasetId": "A String", # The dataset to which this variant set belongs.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
  }
delete(variantSetId, x__xgafv=None) 
Deletes a variant set including all variants, call sets, and calls within. This is not reversible. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  variantSetId: string, The ID of the variant set to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
export(variantSetId, body, x__xgafv=None) 
Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  variantSetId: string, Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ access to this variant set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The variant data export request.
    "projectId": "A String", # Required. The Google Cloud project ID that owns the destination BigQuery dataset. The caller must have WRITE access to this project. This project will also own the resulting export job.
    "bigqueryTable": "A String", # Required. The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it will be overwritten.
    "bigqueryDataset": "A String", # Required. The BigQuery dataset to export data to. This dataset must already exist. Note that this is distinct from the Genomics concept of "dataset".
    "callSetIds": [ # If provided, only variant call information from the specified call sets will be exported. By default all variant calls are exported.
      "A String",
    ],
    "format": "A String", # The format for the exported data.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(variantSetId, x__xgafv=None) 
Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  variantSetId: string, Required. The ID of the variant set. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The server-generated variant set ID, unique across all variant sets.
    "datasetId": "A String", # The dataset to which this variant set belongs.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
  }
patch(variantSetId, body, updateMask=None, x__xgafv=None) 
Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

Args:
  variantSetId: string, The ID of the variant to be updated (must already exist). (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
  "name": "A String", # User-specified, mutable name.
  "description": "A String", # A textual description of this variant set.
  "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
    { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
      "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
      "referenceName": "A String", # The name of the reference associated with this reference bound.
    },
  ],
  "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
  "id": "A String", # The server-generated variant set ID, unique across all variant sets.
  "datasetId": "A String", # The dataset to which this variant set belongs.
  "metadata": [ # The metadata associated with this variant set.
    { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
      "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
        "a_key": [
          "",
        ],
      },
      "description": "A String", # A textual description of this metadata.
      "number": "A String", # The number of values that can be included in a field described by this metadata.
      "value": "A String", # The value field for simple metadata
      "key": "A String", # The top-level key.
      "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
      "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
    },
  ],
}

  updateMask: string, An optional mask specifying which fields to update. Supported fields: * metadata. * name. * description. Leaving `updateMask` unset is equivalent to specifying all mutable fields.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The server-generated variant set ID, unique across all variant sets.
    "datasetId": "A String", # The dataset to which this variant set belongs.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
          "a_key": [
            "",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
  }
search(body, x__xgafv=None) 
Returns a list of all variant sets matching search criteria. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The search variant sets request.
    "pageToken": "A 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.
    "datasetIds": [ # Exactly one dataset ID must be provided here. Only variant sets which belong to this dataset will be returned.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The search variant sets response.
    "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. This field will be empty if there aren't any additional results.
    "variantSets": [ # The variant sets belonging to the requested dataset.
      { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "name": "A String", # User-specified, mutable name.
        "description": "A String", # A textual description of this variant set.
        "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
          { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
            "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
            "referenceName": "A String", # The name of the reference associated with this reference bound.
          },
        ],
        "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
        "id": "A String", # The server-generated variant set ID, unique across all variant sets.
        "datasetId": "A String", # The dataset to which this variant set belongs.
        "metadata": [ # The metadata associated with this variant set.
          { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
            "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
              "a_key": [
                "",
              ],
            },
            "description": "A String", # A textual description of this metadata.
            "number": "A String", # The number of values that can be included in a field described by this metadata.
            "value": "A String", # The value field for simple metadata
            "key": "A String", # The top-level key.
            "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
            "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
          },
        ],
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1alpha2.html000066400000000000000000000044001300622755700242570ustar00rootroot00000000000000

Genomics API

Instance Methods

operations()

Returns the operations Resource.

pipelines()

Returns the pipelines Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/genomics_v1alpha2.operations.html000066400000000000000000000322311300622755700264440ustar00rootroot00000000000000

Genomics API . operations

Instance Methods

cancel(name, body, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, body, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for Operations.CancelOperation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.
  filter: string, A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
        "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
google-api-python-client-1.5.5/docs/dyn/genomics_v1alpha2.pipelines.html000066400000000000000000002443741300622755700262660ustar00rootroot00000000000000

Genomics API . pipelines

Instance Methods

create(body, x__xgafv=None)

Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.

delete(pipelineId, x__xgafv=None)

Deletes a pipeline based on ID. Caller must have WRITE permission to the project.

get(pipelineId, x__xgafv=None)

Retrieves a pipeline based on ID. Caller must have READ permission to the project.

getControllerConfig(validationToken=None, x__xgafv=None, operationId=None)

Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.

list(pageSize=None, projectId=None, namePrefix=None, pageToken=None, x__xgafv=None)

Lists pipelines. Caller must have READ permission to the project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

run(body, x__xgafv=None)

Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.

setOperationStatus(body, x__xgafv=None)

Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.

Method Details

create(body, x__xgafv=None) 
Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
  "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
  "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
  "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
  "outputParameters": [ # Output parameters of the pipeline.
    { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
      "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
      "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
        "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
        "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
      },
      "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
      "description": "A String", # Human-readable description.
    },
  ],
  "inputParameters": [ # Input parameters of the pipeline.
    { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
      "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
      "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
        "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
        "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
      },
      "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
      "description": "A String", # Human-readable description.
    },
  ],
  "docker": { # The Docker execuctor specification. # Specifies the docker run information.
    "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
    "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
  },
  "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
    "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
    "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
    "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
    "disks": [ # Disks to attach.
      { # A Google Compute Engine disk resource specification.
        "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
        "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
        "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
        "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
        "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
        "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
        "type": "A String", # Required. The type of the disk to create.
      },
    ],
    "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
    "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
      "A String",
    ],
    "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
  },
  "description": "A String", # User-specified description.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
    "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
    "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
    "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
    "outputParameters": [ # Output parameters of the pipeline.
      { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
        "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
        "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
          "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
          "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
        },
        "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
        "description": "A String", # Human-readable description.
      },
    ],
    "inputParameters": [ # Input parameters of the pipeline.
      { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
        "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
        "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
          "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
          "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
        },
        "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
        "description": "A String", # Human-readable description.
      },
    ],
    "docker": { # The Docker execuctor specification. # Specifies the docker run information.
      "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
      "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
    },
    "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
      "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
      "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
      "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
      "disks": [ # Disks to attach.
        { # A Google Compute Engine disk resource specification.
          "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
          "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
          "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
          "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
          "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
          "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
          "type": "A String", # Required. The type of the disk to create.
        },
      ],
      "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
      "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
        "A String",
      ],
      "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
    },
    "description": "A String", # User-specified description.
  }
delete(pipelineId, x__xgafv=None) 
Deletes a pipeline based on ID. Caller must have WRITE permission to the project.

Args:
  pipelineId: string, Caller must have WRITE access to the project in which this pipeline is defined. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(pipelineId, x__xgafv=None) 
Retrieves a pipeline based on ID. Caller must have READ permission to the project.

Args:
  pipelineId: string, Caller must have READ access to the project in which this pipeline is defined. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
    "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
    "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
    "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
    "outputParameters": [ # Output parameters of the pipeline.
      { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
        "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
        "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
          "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
          "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
        },
        "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
        "description": "A String", # Human-readable description.
      },
    ],
    "inputParameters": [ # Input parameters of the pipeline.
      { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
        "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
        "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
          "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
          "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
        },
        "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
        "description": "A String", # Human-readable description.
      },
    ],
    "docker": { # The Docker execuctor specification. # Specifies the docker run information.
      "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
      "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
    },
    "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
      "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
      "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
      "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
      "disks": [ # Disks to attach.
        { # A Google Compute Engine disk resource specification.
          "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
          "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
          "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
          "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
          "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
          "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
          "type": "A String", # Required. The type of the disk to create.
        },
      ],
      "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
      "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
        "A String",
      ],
      "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
    },
    "description": "A String", # User-specified description.
  }
getControllerConfig(validationToken=None, x__xgafv=None, operationId=None) 
Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.

Args:
  validationToken: string, A parameter
  x__xgafv: string, V1 error format.
  operationId: string, The operation to retrieve controller configuration for.

Returns:
  An object of the form:

    { # Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.
    "cmd": "A String",
    "machineType": "A String",
    "gcsLogPath": "A String",
    "vars": {
      "a_key": "A String",
    },
    "gcsSinks": {
      "a_key": {
        "values": [
          "A String",
        ],
      },
    },
    "image": "A String",
    "disks": {
      "a_key": "A String",
    },
    "gcsSources": {
      "a_key": {
        "values": [
          "A String",
        ],
      },
    },
  }
list(pageSize=None, projectId=None, namePrefix=None, pageToken=None, x__xgafv=None) 
Lists pipelines. Caller must have READ permission to the project.

Args:
  pageSize: integer, Number of pipelines to return at once. Defaults to 256, and max is 2048.
  projectId: string, Required. The name of the project to search for pipelines. Caller must have READ access to this project.
  namePrefix: string, Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.
  pageToken: string, Token to use to indicate where to start getting results. If unspecified, returns the first page of results.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.
    "nextPageToken": "A String", # The token to use to get the next page of results.
    "pipelines": [ # The matched pipelines.
      { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
        "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
        "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
        "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
        "outputParameters": [ # Output parameters of the pipeline.
          { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
            "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
            "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
              "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
              "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
            },
            "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
            "description": "A String", # Human-readable description.
          },
        ],
        "inputParameters": [ # Input parameters of the pipeline.
          { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
            "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
            "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
              "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
              "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
            },
            "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
            "description": "A String", # Human-readable description.
          },
        ],
        "docker": { # The Docker execuctor specification. # Specifies the docker run information.
          "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
          "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
        },
        "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
          "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
          "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
          "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
          "disks": [ # Disks to attach.
            { # A Google Compute Engine disk resource specification.
              "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
              "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
              "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
              "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
              "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
              "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
              "type": "A String", # Required. The type of the disk to create.
            },
          ],
          "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
          "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
            "A String",
          ],
          "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
        },
        "description": "A String", # User-specified description.
      },
    ],
  }
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.
run(body, x__xgafv=None) 
Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.
    "pipelineArgs": { # The pipeline run arguments. # The arguments to use when running this pipeline.
      "inputs": { # Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.
        "a_key": "A String",
      },
      "logging": { # The logging options for the pipeline run. # Required. Logging options. Used by the service to communicate results to the user.
        "gcsPath": "A String", # The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`.
      },
      "projectId": "A String", # Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used.
      "serviceAccount": { # A Google Cloud Service Account. # The Google Cloud Service Account that will be used to access data and services. By default, the compute service account associated with `projectId` is used.
        "scopes": [ # List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write
          "A String",
        ],
        "email": "A String", # Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project.
      },
      "clientId": "A String", # Client-specified pipeline operation identifier.
      "outputs": { # Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.
        "a_key": "A String",
      },
      "keepVmAliveOnFailureDuration": "A String", # How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
      "resources": { # The system resources for the pipeline run. # Specifies resource requirements/overrides for the pipeline run.
        "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
        "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
        "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
        "disks": [ # Disks to attach.
          { # A Google Compute Engine disk resource specification.
            "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
            "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
            "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
            "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
            "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
            "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
            "type": "A String", # Required. The type of the disk to create.
          },
        ],
        "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
        "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
          "A String",
        ],
        "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
      },
    },
    "ephemeralPipeline": { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method. # A new pipeline object to run once and then delete.
      "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
      "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
      "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
      "outputParameters": [ # Output parameters of the pipeline.
        { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
          "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
          "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
            "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
            "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
          },
          "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
          "description": "A String", # Human-readable description.
        },
      ],
      "inputParameters": [ # Input parameters of the pipeline.
        { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:   Google Cloud storage pathLocal path   filefile globdirectory   For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are:   Local pathGoogle Cloud Storage path   filefile  file directory - directory must already exist   glob directory - directory will be created if it doesn't exist   One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
          "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
          "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
            "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
            "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
          },
          "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
          "description": "A String", # Human-readable description.
        },
      ],
      "docker": { # The Docker execuctor specification. # Specifies the docker run information.
        "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
        "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
      },
      "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
        "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
        "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
        "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
        "disks": [ # Disks to attach.
          { # A Google Compute Engine disk resource specification.
            "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
            "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
            "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
            "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
            "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
            "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
            "type": "A String", # Required. The type of the disk to create.
          },
        ],
        "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
        "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
          "A String",
        ],
        "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
      },
      "description": "A String", # User-specified description.
    },
    "pipelineId": "A String", # The already created pipeline to run.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
    "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
setOperationStatus(body, x__xgafv=None) 
Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.
    "errorCode": "A String",
    "errorMessage": "A String",
    "timestampEvents": [
      { # Stores the list of events and times they occured for major events in job execution.
        "timestamp": "A String", # The time this event occured.
        "description": "A String", # String indicating the type of event
      },
    ],
    "validationToken": "A String",
    "operationId": "A String",
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.annotationSets.html000066400000000000000000000342501300622755700271230ustar00rootroot00000000000000

Genomics API . annotationSets

Instance Methods

create(body)

Creates a new annotation set. Caller must have WRITE permission for the associated dataset.

delete(annotationSetId)

Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

get(annotationSetId)

Gets an annotation set. Caller must have READ permission for the associated dataset.

patch(annotationSetId, body)

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

search(body)

Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

update(annotationSetId, body)

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

Method Details

create(body) 
Creates a new annotation set. Caller must have WRITE permission for the associated dataset.

The following fields must be provided when creating an annotation set:  
- datasetId 
- referenceSetId  
All other fields may be optionally specified, unless documented as being server-generated (for example, the id field).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The display name for this annotation set.
  "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
  "type": "A String", # The type of annotations contained within this set.
  "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
  "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
  "datasetId": "A String", # The dataset to which this annotation set belongs.
}


Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "type": "A String", # The type of annotations contained within this set.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
delete(annotationSetId) 
Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

Args:
  annotationSetId: string, The ID of the annotation set to be deleted. (required)
get(annotationSetId) 
Gets an annotation set. Caller must have READ permission for the associated dataset.

Args:
  annotationSetId: string, The ID of the annotation set to be retrieved. (required)

Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "type": "A String", # The type of annotations contained within this set.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
patch(annotationSetId, body) 
Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

Args:
  annotationSetId: string, The ID of the annotation set to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The display name for this annotation set.
  "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
  "type": "A String", # The type of annotations contained within this set.
  "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
  "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
  "datasetId": "A String", # The dataset to which this annotation set belongs.
}


Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "type": "A String", # The type of annotations contained within this set.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
search(body) 
Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive).
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.
    "datasetIds": [ # The dataset IDs to search within. Caller must have READ access to these datasets.
      "A String",
    ],
    "pageToken": "A 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.
    "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
    "types": [ # If specified, only annotation sets that have any of these types are returned.
      "A String",
    ],
  }


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. This field will be empty if there aren't any additional results.
    "annotationSets": [ # The matching annotation sets.
      { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name for this annotation set.
        "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
        "type": "A String", # The type of annotations contained within this set.
        "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
        "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
        "datasetId": "A String", # The dataset to which this annotation set belongs.
      },
    ],
  }
update(annotationSetId, body) 
Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

Args:
  annotationSetId: string, The ID of the annotation set to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The display name for this annotation set.
  "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
  "type": "A String", # The type of annotations contained within this set.
  "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
  "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
  "datasetId": "A String", # The dataset to which this annotation set belongs.
}


Returns:
  An object of the form:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name for this annotation set.
    "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
    "type": "A String", # The type of annotations contained within this set.
    "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
    "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
    "datasetId": "A String", # The dataset to which this annotation set belongs.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.annotations.html000066400000000000000000002440341300622755700264520ustar00rootroot00000000000000

Genomics API . annotations

Instance Methods

batchCreate(body)

Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together.

create(body)

Creates a new annotation. Caller must have WRITE permission for the associated annotation set.

delete(annotationId)

Deletes an annotation. Caller must have WRITE permission for the associated annotation set.

get(annotationId)

Gets an annotation. Caller must have READ permission for the associated annotation set.

patch(annotationId, body)

Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

search(body)

Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.

update(annotationId, body)

Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset.

Method Details

batchCreate(body) 
Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together.


If the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will fail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed annotations will be created normally.


For details on the requirements for each individual annotation resource, see annotations.create.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "annotations": [ # The annotations to be created. At most 4096 can be specified in a single request.
      { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name of this annotation.
        "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
        "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
          "type": "A String", # Type has been adapted from ClinVar's list of variant types.
          "effect": "A String", # Effect of the variant on the coding sequence.
          "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
            "A String",
          ],
          "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
          "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
          "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
            {
              "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
              "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
              "externalIds": [ # The set of external IDs for this condition.
                {
                  "sourceName": "A String", # The name of the source of this data.
                  "id": "A String", # The id used by the source of this data.
                },
              ],
              "names": [ # A set of names for the condition.
                "A String",
              ],
            },
          ],
          "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
        },
        "annotationSetId": "A String", # The annotation set to which this annotation belongs.
        "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
          "start": "A String", # The start position of the range on the reference, 0-based inclusive.
          "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
          "end": "A String", # The end position of the range on the reference, 0-based exclusive.
          "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
          "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
        },
        "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
          "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
              #
              # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
            "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
            "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
          },
          "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
          "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
              #
              #
              # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
              #
              #
              # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
              #
              #
              # Exons are ordered by start position and may not overlap.
            {
              "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
              "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
                  #
                  # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
                  #
                  # The JSON representation for `Int32Value` is JSON number.
                "value": 42, # The int32 value.
              },
              "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
            },
          ],
        },
        "id": "A String", # The server-generated annotation ID, unique across all annotations.
      },
    ],
  }


Returns:
  An object of the form:

    {
    "entries": [ # The resulting per-annotation entries, ordered consistently with the original request.
      {
        "status": { # The resulting status for this annotation operation.
          "message": "A String", # Error message for this status, if any.
          "code": 42, # The HTTP status code for this operation.
        },
        "annotation": { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT. # The annotation, if any.
          "info": { # A string which maps to an array of values.
            "a_key": [ # A string which maps to an array of values.
              "A String",
            ],
          },
          "name": "A String", # The display name of this annotation.
          "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
          "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
            "type": "A String", # Type has been adapted from ClinVar's list of variant types.
            "effect": "A String", # Effect of the variant on the coding sequence.
            "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
              "A String",
            ],
            "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
            "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
            "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
              {
                "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
                "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
                "externalIds": [ # The set of external IDs for this condition.
                  {
                    "sourceName": "A String", # The name of the source of this data.
                    "id": "A String", # The id used by the source of this data.
                  },
                ],
                "names": [ # A set of names for the condition.
                  "A String",
                ],
              },
            ],
            "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
          },
          "annotationSetId": "A String", # The annotation set to which this annotation belongs.
          "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
            "start": "A String", # The start position of the range on the reference, 0-based inclusive.
            "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
            "end": "A String", # The end position of the range on the reference, 0-based exclusive.
            "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
            "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
          },
          "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
            "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
                #
                # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
              "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
              "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
            },
            "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
            "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
                #
                #
                # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
                #
                #
                # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
                #
                #
                # Exons are ordered by start position and may not overlap.
              {
                "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
                "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
                    #
                    # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
                    #
                    # The JSON representation for `Int32Value` is JSON number.
                  "value": 42, # The int32 value.
                },
                "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
              },
            ],
          },
          "id": "A String", # The server-generated annotation ID, unique across all annotations.
        },
      },
    ],
  }
create(body) 
Creates a new annotation. Caller must have WRITE permission for the associated annotation set.


The following fields must be provided when creating an annotation:  
- annotationSetId 
- position.referenceName or  position.referenceId  Transcripts 
For annotations of type TRANSCRIPT, the following fields of annotation.transcript must be provided:  
- exons.start 
- exons.end  
All other fields may be optionally specified, unless documented as being server-generated (for example, the id field). The annotated range must be no longer than 100Mbp (mega base pairs). See the annotation resource for additional restrictions on each field.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The display name of this annotation.
  "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
  "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
    "type": "A String", # Type has been adapted from ClinVar's list of variant types.
    "effect": "A String", # Effect of the variant on the coding sequence.
    "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
      "A String",
    ],
    "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
    "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
    "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
      {
        "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
        "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
        "externalIds": [ # The set of external IDs for this condition.
          {
            "sourceName": "A String", # The name of the source of this data.
            "id": "A String", # The id used by the source of this data.
          },
        ],
        "names": [ # A set of names for the condition.
          "A String",
        ],
      },
    ],
    "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
  },
  "annotationSetId": "A String", # The annotation set to which this annotation belongs.
  "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
    "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
    "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
  },
  "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
    "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
        #
        # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
      "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
    },
    "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
    "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
        #
        #
        # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
        #
        #
        # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
        #
        #
        # Exons are ordered by start position and may not overlap.
      {
        "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
        "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
            #
            # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
            #
            # The JSON representation for `Int32Value` is JSON number.
          "value": 42, # The int32 value.
        },
        "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
      },
    ],
  },
  "id": "A String", # The server-generated annotation ID, unique across all annotations.
}


Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name of this annotation.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
      "start": "A String", # The start position of the range on the reference, 0-based inclusive.
      "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
      "end": "A String", # The end position of the range on the reference, 0-based exclusive.
      "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
      "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
    },
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
          #
          # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      },
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
          #
          #
          # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
          #
          #
          # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
          #
          #
          # Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
          "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
              #
              # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
              #
              # The JSON representation for `Int32Value` is JSON number.
            "value": 42, # The int32 value.
          },
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
        },
      ],
    },
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
delete(annotationId) 
Deletes an annotation. Caller must have WRITE permission for the associated annotation set.

Args:
  annotationId: string, The ID of the annotation to be deleted. (required)
get(annotationId) 
Gets an annotation. Caller must have READ permission for the associated annotation set.

Args:
  annotationId: string, The ID of the annotation to be retrieved. (required)

Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name of this annotation.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
      "start": "A String", # The start position of the range on the reference, 0-based inclusive.
      "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
      "end": "A String", # The end position of the range on the reference, 0-based exclusive.
      "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
      "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
    },
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
          #
          # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      },
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
          #
          #
          # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
          #
          #
          # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
          #
          #
          # Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
          "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
              #
              # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
              #
              # The JSON representation for `Int32Value` is JSON number.
            "value": 42, # The int32 value.
          },
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
        },
      ],
    },
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
patch(annotationId, body) 
Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

Args:
  annotationId: string, The ID of the annotation to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The display name of this annotation.
  "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
  "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
    "type": "A String", # Type has been adapted from ClinVar's list of variant types.
    "effect": "A String", # Effect of the variant on the coding sequence.
    "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
      "A String",
    ],
    "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
    "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
    "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
      {
        "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
        "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
        "externalIds": [ # The set of external IDs for this condition.
          {
            "sourceName": "A String", # The name of the source of this data.
            "id": "A String", # The id used by the source of this data.
          },
        ],
        "names": [ # A set of names for the condition.
          "A String",
        ],
      },
    ],
    "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
  },
  "annotationSetId": "A String", # The annotation set to which this annotation belongs.
  "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
    "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
    "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
  },
  "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
    "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
        #
        # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
      "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
    },
    "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
    "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
        #
        #
        # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
        #
        #
        # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
        #
        #
        # Exons are ordered by start position and may not overlap.
      {
        "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
        "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
            #
            # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
            #
            # The JSON representation for `Int32Value` is JSON number.
          "value": 42, # The int32 value.
        },
        "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
      },
    ],
  },
  "id": "A String", # The server-generated annotation ID, unique across all annotations.
}


Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name of this annotation.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
      "start": "A String", # The start position of the range on the reference, 0-based inclusive.
      "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
      "end": "A String", # The end position of the range on the reference, 0-based exclusive.
      "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
      "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
    },
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
          #
          # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      },
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
          #
          #
          # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
          #
          #
          # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
          #
          #
          # Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
          "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
              #
              # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
              #
              # The JSON representation for `Int32Value` is JSON number.
            "value": 42, # The int32 value.
          },
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
        },
      ],
    },
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
search(body) 
Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "pageToken": "A 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.
    "range": { # A 0-based half-open genomic coordinate range for search requests. reference_id or reference_name must be set. # If specified, this query matches only annotations that overlap this range.
      "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, referenceId or referenceName must also be specified. Defaults to 0.
      "referenceId": "A String", # The ID of the reference to query.
      "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, referenceId or referenceName must also be specified. If unset or 0, defaults to the length of the reference.
      "referenceName": "A String", # The name of the reference to query, within the reference set associated with this query.
    },
    "annotationSetIds": [ # The annotation sets to search within. The caller must have READ access to these annotation sets. Required. All queried annotation sets must have the same type.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.
  }


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. This field will be empty if there aren't any additional results.
    "annotations": [ # The matching annotations.
      { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name of this annotation.
        "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
        "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
          "type": "A String", # Type has been adapted from ClinVar's list of variant types.
          "effect": "A String", # Effect of the variant on the coding sequence.
          "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
            "A String",
          ],
          "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
          "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
          "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
            {
              "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
              "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
              "externalIds": [ # The set of external IDs for this condition.
                {
                  "sourceName": "A String", # The name of the source of this data.
                  "id": "A String", # The id used by the source of this data.
                },
              ],
              "names": [ # A set of names for the condition.
                "A String",
              ],
            },
          ],
          "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
        },
        "annotationSetId": "A String", # The annotation set to which this annotation belongs.
        "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
          "start": "A String", # The start position of the range on the reference, 0-based inclusive.
          "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
          "end": "A String", # The end position of the range on the reference, 0-based exclusive.
          "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
          "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
        },
        "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
          "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
              #
              # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
            "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
            "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
          },
          "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
          "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
              #
              #
              # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
              #
              #
              # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
              #
              #
              # Exons are ordered by start position and may not overlap.
            {
              "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
              "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
                  #
                  # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
                  #
                  # The JSON representation for `Int32Value` is JSON number.
                "value": 42, # The int32 value.
              },
              "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
            },
          ],
        },
        "id": "A String", # The server-generated annotation ID, unique across all annotations.
      },
    ],
  }
update(annotationId, body) 
Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset.

Args:
  annotationId: string, The ID of the annotation to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The display name of this annotation.
  "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
  "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
    "type": "A String", # Type has been adapted from ClinVar's list of variant types.
    "effect": "A String", # Effect of the variant on the coding sequence.
    "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
      "A String",
    ],
    "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
    "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
    "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
      {
        "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
        "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
        "externalIds": [ # The set of external IDs for this condition.
          {
            "sourceName": "A String", # The name of the source of this data.
            "id": "A String", # The id used by the source of this data.
          },
        ],
        "names": [ # A set of names for the condition.
          "A String",
        ],
      },
    ],
    "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
  },
  "annotationSetId": "A String", # The annotation set to which this annotation belongs.
  "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
    "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
    "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
  },
  "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
    "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
        #
        # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
      "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
    },
    "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
    "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
        #
        #
        # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
        #
        #
        # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
        #
        #
        # Exons are ordered by start position and may not overlap.
      {
        "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
        "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
            #
            # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
            #
            # The JSON representation for `Int32Value` is JSON number.
          "value": 42, # The int32 value.
        },
        "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
      },
    ],
  },
  "id": "A String", # The server-generated annotation ID, unique across all annotations.
}


Returns:
  An object of the form:

    { # An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are GENE and VARIANT.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The display name of this annotation.
    "type": "A String", # The data type for this annotation. Must match the containing annotation set's type.
    "variant": { # A Variant annotation. # A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type VARIANT.
      "type": "A String", # Type has been adapted from ClinVar's list of variant types.
      "effect": "A String", # Effect of the variant on the coding sequence.
      "transcriptIds": [ # Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.
        "A String",
      ],
      "alternateBases": "A String", # The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions.
      "clinicalSignificance": "A String", # Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/
      "conditions": [ # The set of conditions associated with this variant. A condition describes the way a variant influences human health.
        {
          "conceptId": "A String", # The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
          "omimId": "A String", # The OMIM id for this condition. Search for these IDs at http://omim.org/
          "externalIds": [ # The set of external IDs for this condition.
            {
              "sourceName": "A String", # The name of the source of this data.
              "id": "A String", # The id used by the source of this data.
            },
          ],
          "names": [ # A set of names for the condition.
            "A String",
          ],
        },
      ],
      "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.
    },
    "annotationSetId": "A String", # The annotation set to which this annotation belongs.
    "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence.
      "start": "A String", # The start position of the range on the reference, 0-based inclusive.
      "referenceId": "A String", # The ID of the Google Genomics reference associated with this range.
      "end": "A String", # The end position of the range on the reference, 0-based exclusive.
      "reverseStrand": True or False, # Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand.
      "referenceName": "A String", # The display name corresponding to the reference specified by referenceId, for example chr1, 1, or chrX.
    },
    "transcript": { # A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. # A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type TRANSCRIPT.
      "codingSequence": { # The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the exons, if any. If there are any exons, the codingSequence must start and end within them.
          #
          # Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, exon.frame will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA.
        "start": "A String", # The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and not the containing annotation start.
        "end": "A String", # The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and not the containing annotation start.
      },
      "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
      "exons": [ # The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.
          #
          #
          # Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns.
          #
          #
          # Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.
          #
          #
          # Exons are ordered by start position and may not overlap.
        {
          "start": "A String", # The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.
          "frame": { # Wrapper message for `int32`. # The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. For reverse strand annotations, this offset is relative to the exon.end-1.
              #
              # Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.
              #
              # The JSON representation for `Int32Value` is JSON number.
            "value": 42, # The int32 value.
          },
          "end": "A String", # The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and not the containing annotation start.
        },
      ],
    },
    "id": "A String", # The server-generated annotation ID, unique across all annotations.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.callsets.html000066400000000000000000000232431300622755700257240ustar00rootroot00000000000000

Genomics API . callsets

Instance Methods

create(body)

Creates a new call set.

delete(callSetId)

Deletes a call set.

get(callSetId)

Gets a call set by ID.

patch(callSetId, body)

Updates a call set. This method supports patch semantics.

search(body)

Gets a list of call sets matching the criteria.

update(callSetId, body)

Updates a call set.

Method Details

create(body) 
Creates a new call set.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The call set name.
  "created": "A String", # The date this call set was created in milliseconds from the epoch.
  "sampleId": "A String", # The sample ID this call set corresponds to.
  "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
    "A String",
  ],
  "id": "A String", # The Google generated ID of the call set, immutable.
}


Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
      "A String",
    ],
    "id": "A String", # The Google generated ID of the call set, immutable.
  }
delete(callSetId) 
Deletes a call set.

Args:
  callSetId: string, The ID of the call set to be deleted. (required)
get(callSetId) 
Gets a call set by ID.

Args:
  callSetId: string, The ID of the call set. (required)

Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
      "A String",
    ],
    "id": "A String", # The Google generated ID of the call set, immutable.
  }
patch(callSetId, body) 
Updates a call set. This method supports patch semantics.

Args:
  callSetId: string, Required. The ID of the call set to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The call set name.
  "created": "A String", # The date this call set was created in milliseconds from the epoch.
  "sampleId": "A String", # The sample ID this call set corresponds to.
  "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
    "A String",
  ],
  "id": "A String", # The Google generated ID of the call set, immutable.
}


Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
      "A String",
    ],
    "id": "A String", # The Google generated ID of the call set, immutable.
  }
search(body) 
Gets a list of call sets matching the criteria.

Implements GlobalAllianceApi.searchCallSets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The call set search request.
    "pageToken": "A 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.
    "variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one ID must be provided.
      "A String",
    ],
    "name": "A String", # Only return call sets for which a substring of the name matches this string.
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024.
  }


Returns:
  An object of the form:

    { # The call set search response.
    "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. This field will be empty if there aren't any additional results.
    "callSets": [ # The list of matching call sets.
      { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The call set name.
        "created": "A String", # The date this call set was created in milliseconds from the epoch.
        "sampleId": "A String", # The sample ID this call set corresponds to.
        "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
          "A String",
        ],
        "id": "A String", # The Google generated ID of the call set, immutable.
      },
    ],
  }
update(callSetId, body) 
Updates a call set.

Args:
  callSetId: string, Required. The ID of the call set to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The call set name.
  "created": "A String", # The date this call set was created in milliseconds from the epoch.
  "sampleId": "A String", # The sample ID this call set corresponds to.
  "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
    "A String",
  ],
  "id": "A String", # The Google generated ID of the call set, immutable.
}


Returns:
  An object of the form:

    { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The call set name.
    "created": "A String", # The date this call set was created in milliseconds from the epoch.
    "sampleId": "A String", # The sample ID this call set corresponds to.
    "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
      "A String",
    ],
    "id": "A String", # The Google generated ID of the call set, immutable.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.datasets.html000066400000000000000000000252641300622755700257270ustar00rootroot00000000000000

Genomics API . datasets

Instance Methods

create(body)

Creates a new dataset.

delete(datasetId)

Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the UndeleteDataset operation.

get(datasetId)

Gets a dataset by ID.

list(pageToken=None, projectNumber=None, pageSize=None)

Lists datasets within a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(datasetId, body)

Updates a dataset. This method supports patch semantics.

undelete(datasetId)

Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.

update(datasetId, body)

Updates a dataset.

Method Details

create(body) 
Creates a new dataset.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A Dataset is a collection of genomic data.
  "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
  "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
  "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
  "name": "A String", # The dataset name.
  "id": "A String", # The Google generated ID of the dataset, immutable.
}


Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data.
    "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
    "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
    "id": "A String", # The Google generated ID of the dataset, immutable.
  }
delete(datasetId) 
Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the UndeleteDataset operation.

Args:
  datasetId: string, The ID of the dataset to be deleted. (required)
get(datasetId) 
Gets a dataset by ID.

Args:
  datasetId: string, The ID of the dataset. (required)

Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data.
    "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
    "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
    "id": "A String", # The Google generated ID of the dataset, immutable.
  }
list(pageToken=None, projectNumber=None, pageSize=None) 
Lists datasets within a project.

Args:
  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.
  projectNumber: string, Required. The project to list datasets for.
  pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.

Returns:
  An object of the form:

    { # The dataset list response.
    "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. This field will be empty if there aren't any additional results.
    "datasets": [ # The list of matching Datasets.
      { # A Dataset is a collection of genomic data.
        "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
        "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
        "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
        "name": "A String", # The dataset name.
        "id": "A String", # The Google generated ID of the dataset, immutable.
      },
    ],
  }
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(datasetId, body) 
Updates a dataset. This method supports patch semantics.

Args:
  datasetId: string, The ID of the dataset to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Dataset is a collection of genomic data.
  "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
  "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
  "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
  "name": "A String", # The dataset name.
  "id": "A String", # The Google generated ID of the dataset, immutable.
}


Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data.
    "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
    "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
    "id": "A String", # The Google generated ID of the dataset, immutable.
  }
undelete(datasetId) 
Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.

Args:
  datasetId: string, The ID of the dataset to be undeleted. (required)

Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data.
    "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
    "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
    "id": "A String", # The Google generated ID of the dataset, immutable.
  }
update(datasetId, body) 
Updates a dataset.

Args:
  datasetId: string, The ID of the dataset to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Dataset is a collection of genomic data.
  "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
  "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
  "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
  "name": "A String", # The dataset name.
  "id": "A String", # The Google generated ID of the dataset, immutable.
}


Returns:
  An object of the form:

    { # A Dataset is a collection of genomic data.
    "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
    "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
    "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
    "name": "A String", # The dataset name.
    "id": "A String", # The Google generated ID of the dataset, immutable.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.experimental.html000066400000000000000000000023511300622755700266040ustar00rootroot00000000000000

Genomics API . experimental

Instance Methods

jobs()

Returns the jobs Resource.

google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.experimental.jobs.html000066400000000000000000000057131300622755700275450ustar00rootroot00000000000000

Genomics API . experimental . jobs

Instance Methods

create(body)

Creates and asynchronously runs an ad-hoc job. This is an experimental call and may be removed or changed at any time.

Method Details

create(body) 
Creates and asynchronously runs an ad-hoc job. This is an experimental call and may be removed or changed at any time.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The job creation request.
    "pairedSourceUris": [ # A list of Google Cloud Storage URIs of paired end .fastq files to operate upon. If specified, this represents the second file of each paired .fastq file. The first file of each pair should be specified in sourceUris.
      "A String",
    ],
    "align": True or False, # Specifies whether or not to run the alignment pipeline. Either align or callVariants must be set.
    "callVariants": True or False, # Specifies whether or not to run the variant calling pipeline. Either align or callVariants must be set.
    "sourceUris": [ # A list of Google Cloud Storage URIs of data files to operate upon. These can be .bam, interleaved .fastq, or paired .fastq. If specifying paired .fastq files, the first of each pair of files should be listed here, and the second of each pair should be listed in pairedSourceUris.
      "A String",
    ],
    "gcsOutputPath": "A String", # Specifies where to copy the results of certain pipelines. This should be in the form of gs://bucket/path.
    "projectNumber": "A String", # Required. The Google Cloud Project ID with which to associate the request.
  }


Returns:
  An object of the form:

    { # The job creation response.
    "jobId": "A String", # A job ID that can be used to get status information.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.html000066400000000000000000000075251300622755700241200ustar00rootroot00000000000000

Genomics API

Instance Methods

annotationSets()

Returns the annotationSets Resource.

annotations()

Returns the annotations Resource.

callsets()

Returns the callsets Resource.

datasets()

Returns the datasets Resource.

experimental()

Returns the experimental Resource.

jobs()

Returns the jobs Resource.

readgroupsets()

Returns the readgroupsets Resource.

reads()

Returns the reads Resource.

references()

Returns the references Resource.

referencesets()

Returns the referencesets Resource.

variants()

Returns the variants Resource.

variantsets()

Returns the variantsets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.jobs.html000066400000000000000000000142561300622755700250530ustar00rootroot00000000000000

Genomics API . jobs

Instance Methods

cancel(jobId)

Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.

get(jobId)

Gets a job by ID.

search(body)

Gets a list of jobs matching the criteria.

Method Details

cancel(jobId) 
Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.

Args:
  jobId: string, Required. The ID of the job. (required)
get(jobId) 
Gets a job by ID.

Args:
  jobId: string, Required. The ID of the job. (required)

Returns:
  An object of the form:

    { # A Job represents an ongoing process that can be monitored for status information.
    "detailedStatus": "A String", # A more detailed description of this job's current status.
    "status": "A String", # The status of this job.
    "errors": [ # Any errors that occurred during processing.
      "A String",
    ],
    "created": "A String", # The date this job was created, in milliseconds from the epoch.
    "warnings": [ # Any warnings that occurred during processing.
      "A String",
    ],
    "request": { # A summary representation of the service request that spawned the job. # A summarized representation of the original service request.
      "source": [ # The data source of the request, for example, a Google Cloud Storage object path or Readset ID.
        "A String",
      ],
      "destination": [ # The data destination of the request, for example, a Google BigQuery Table or Dataset ID.
        "A String",
      ],
      "type": "A String", # The original request type.
    },
    "projectNumber": "A String", # The Google Developers Console project number to which this job belongs.
    "importedIds": [ # If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.
      "A String",
    ],
    "id": "A String", # The job ID.
  }
search(body) 
Gets a list of jobs matching the criteria.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The jobs search request.
    "status": [ # Only return jobs which have a matching status.
      "A String",
    ],
    "createdAfter": "A String", # If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 256.
    "pageToken": "A 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 the nextPageToken from the previous response.
    "createdBefore": "A String", # If specified, only jobs created prior to this date, given in milliseconds since Unix epoch, will be returned.
    "projectNumber": "A String", # Required. Only return jobs which belong to this Google Developers Console project.
  }


Returns:
  An object of the form:

    { # The job search response.
    "nextPageToken": "A String", # The continuation token which is used to page through large result sets. Provide this value is a subsequent request to return the next page of results. This field will be empty if there are no more results.
    "jobs": [ # The list of jobs results, ordered newest to oldest.
      { # A Job represents an ongoing process that can be monitored for status information.
        "detailedStatus": "A String", # A more detailed description of this job's current status.
        "status": "A String", # The status of this job.
        "errors": [ # Any errors that occurred during processing.
          "A String",
        ],
        "created": "A String", # The date this job was created, in milliseconds from the epoch.
        "warnings": [ # Any warnings that occurred during processing.
          "A String",
        ],
        "request": { # A summary representation of the service request that spawned the job. # A summarized representation of the original service request.
          "source": [ # The data source of the request, for example, a Google Cloud Storage object path or Readset ID.
            "A String",
          ],
          "destination": [ # The data destination of the request, for example, a Google BigQuery Table or Dataset ID.
            "A String",
          ],
          "type": "A String", # The original request type.
        },
        "projectNumber": "A String", # The Google Developers Console project number to which this job belongs.
        "importedIds": [ # If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.
          "A String",
        ],
        "id": "A String", # The job ID.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.readgroupsets.coveragebuckets.html000066400000000000000000000135231300622755700321540ustar00rootroot00000000000000

Genomics API . readgroupsets . coveragebuckets

Instance Methods

list(readGroupSetId, range_end=None, range_start=None, range_referenceName=None, pageSize=None, pageToken=None, targetBucketWidth=None)

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(readGroupSetId, range_end=None, range_start=None, range_referenceName=None, pageSize=None, pageToken=None, targetBucketWidth=None) 
Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range.

Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

Args:
  readGroupSetId: string, Required. The ID of the read group set over which coverage is requested. (required)
  range_end: string, The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified.
  range_start: string, The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified.
  range_referenceName: string, The reference sequence name, for example chr1, 1, or chrX.
  pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.
  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.
  targetBucketWidth: string, The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change.

Returns:
  An object of the form:

    {
    "coverageBuckets": [ # The coverage buckets. The list of buckets is sparse; a bucket with 0 overlapping reads is not returned. A bucket never crosses more than one reference sequence. Each bucket has width bucketWidth, unless its end is the end of the reference sequence.
      { # A bucket over which read coverage has been precomputed. A bucket corresponds to a specific range of the reference sequence.
        "meanCoverage": 3.14, # The average number of reads which are aligned to each individual reference base in this bucket.
        "range": { # A 0-based half-open genomic coordinate range over a reference sequence. # The genomic coordinate range spanned by this bucket.
          "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified.
          "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified.
          "referenceName": "A String", # The reference sequence name, for example chr1, 1, or chrX.
        },
      },
    ],
    "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. This field will be empty if there aren't any additional results.
    "bucketWidth": "A String", # The length of each coverage bucket in base pairs. Note that buckets at the end of a reference sequence may be shorter. This value is omitted if the bucket width is infinity (the default behaviour, with no range or targetBucketWidth).
  }
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.
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.readgroupsets.html000066400000000000000000000756771300622755700270230ustar00rootroot00000000000000

Genomics API . readgroupsets

Instance Methods

coveragebuckets()

Returns the coveragebuckets Resource.

delete(readGroupSetId)

Deletes a read group set.

export(body)

Exports read group sets to a BAM file in Google Cloud Storage.

get(readGroupSetId)

Gets a read group set by ID.

import_(body)

Creates read group sets by asynchronously importing the provided information. The caller must have WRITE permissions to the dataset.

patch(readGroupSetId, body)

Updates a read group set. This method supports patch semantics.

search(body)

Searches for read group sets matching the criteria.

update(readGroupSetId, body)

Updates a read group set.

Method Details

delete(readGroupSetId) 
Deletes a read group set.

Args:
  readGroupSetId: string, The ID of the read group set to be deleted. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
export(body) 
Exports read group sets to a BAM file in Google Cloud Storage.

Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See ImportReadGroupSets for details.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read group set export request.
    "exportUri": "A String", # Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated user must have write access to the new file. An error will be returned if the URI already contains data.
    "referenceNames": [ # The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use * to export only unmapped reads.
      "A String",
    ],
    "readGroupSetIds": [ # Required. The IDs of the read group sets to export. The caller must have READ access to these read group sets.
      "A String",
    ],
    "projectNumber": "A String", # Required. The Google Developers Console project number that owns this export. The caller must have WRITE access to this project.
  }


Returns:
  An object of the form:

    { # The read group set export response.
    "jobId": "A String", # A job ID that can be used to get status information.
  }
get(readGroupSetId) 
Gets a read group set by ID.

Args:
  readGroupSetId: string, The ID of the read group set. (required)

Returns:
  An object of the form:

    { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.
      # - A read group set belongs to one dataset.
      # - A read group belongs to one read group set.
      # - A read belongs to one read group.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
    "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
      { # A read group is all the data that's processed the same way by the sequencer.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
        "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
        "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
          {
            "commandLine": "A String", # The command line used to run this program.
            "prevProgramId": "A String", # The ID of the program run before this one.
            "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.
            "version": "A String", # The version of the program run.
            "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
          },
        ],
        "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system.
        "experiment": { # The experiment used to generate this read group.
          "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
          "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.
          "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM.
          "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the
        },
        "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned.
        "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field.
        "datasetId": "A String", # The ID of the dataset this read group belongs to.
        "description": "A String", # A free-form text description of this read group.
      },
    ],
    "filename": "A String", # The filename of the original source file for this read group set, if any.
    "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to.
    "id": "A String", # The read group set ID.
    "datasetId": "A String", # The dataset ID.
  }
import_(body) 
Creates read group sets by asynchronously importing the provided information. The caller must have WRITE permissions to the dataset.

Notes on BAM import:  
- Tags will be converted to strings - tag types are not preserved
- Comments (@CO) in the input file header are not imported
- Original order of reference headers is not preserved
- Any reverse stranded unmapped reads will be reverse complemented, and their qualities (also the "BQ" and "OQ" tags, if any) will be reversed
- Unmapped reads will be stripped of positional information (referenceName and position)

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read group set import request.
    "referenceSetId": "A String", # The reference set to which the imported read group sets are aligned to, if any. The reference names of this reference set must be a superset of those found in the imported file headers. If no reference set id is provided, a best effort is made to associate with a matching reference set.
    "sourceUris": [ # A list of URIs pointing at BAM files in Google Cloud Storage.
      "A String",
    ],
    "partitionStrategy": "A String", # The partition strategy describes how read groups are partitioned into read group sets.
    "datasetId": "A String", # Required. The ID of the dataset these read group sets will belong to. The caller must have WRITE permissions to this dataset.
  }


Returns:
  An object of the form:

    { # The read group set import response.
    "jobId": "A String", # A job ID that can be used to get status information.
  }
patch(readGroupSetId, body) 
Updates a read group set. This method supports patch semantics.

Args:
  readGroupSetId: string, The ID of the read group set to be updated. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.
    # - A read group set belongs to one dataset.
    # - A read group belongs to one read group set.
    # - A read belongs to one read group.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
  "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
    { # A read group is all the data that's processed the same way by the sequencer.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
      "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
      "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
        {
          "commandLine": "A String", # The command line used to run this program.
          "prevProgramId": "A String", # The ID of the program run before this one.
          "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.
          "version": "A String", # The version of the program run.
          "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
        },
      ],
      "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system.
      "experiment": { # The experiment used to generate this read group.
        "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
        "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.
        "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM.
        "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the
      },
      "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned.
      "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field.
      "datasetId": "A String", # The ID of the dataset this read group belongs to.
      "description": "A String", # A free-form text description of this read group.
    },
  ],
  "filename": "A String", # The filename of the original source file for this read group set, if any.
  "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to.
  "id": "A String", # The read group set ID.
  "datasetId": "A String", # The dataset ID.
}


Returns:
  An object of the form:

    { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.
      # - A read group set belongs to one dataset.
      # - A read group belongs to one read group set.
      # - A read belongs to one read group.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
    "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
      { # A read group is all the data that's processed the same way by the sequencer.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
        "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
        "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
          {
            "commandLine": "A String", # The command line used to run this program.
            "prevProgramId": "A String", # The ID of the program run before this one.
            "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.
            "version": "A String", # The version of the program run.
            "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
          },
        ],
        "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system.
        "experiment": { # The experiment used to generate this read group.
          "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
          "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.
          "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM.
          "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the
        },
        "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned.
        "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field.
        "datasetId": "A String", # The ID of the dataset this read group belongs to.
        "description": "A String", # A free-form text description of this read group.
      },
    ],
    "filename": "A String", # The filename of the original source file for this read group set, if any.
    "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to.
    "id": "A String", # The read group set ID.
    "datasetId": "A String", # The dataset ID.
  }
search(body) 
Searches for read group sets matching the criteria.

Implements GlobalAllianceApi.searchReadGroupSets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read group set search request.
    "pageToken": "A 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.
    "datasetIds": [ # Restricts this query to read group sets within the given datasets. At least one ID must be provided.
      "A String",
    ],
    "name": "A String", # Only return read group sets for which a substring of the name matches this string.
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 1024.
  }


Returns:
  An object of the form:

    { # The read group set search response.
    "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. This field will be empty if there aren't any additional results.
    "readGroupSets": [ # The list of matching read group sets.
      { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.
          # - A read group set belongs to one dataset.
          # - A read group belongs to one read group set.
          # - A read belongs to one read group.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
        "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
          { # A read group is all the data that's processed the same way by the sequencer.
            "info": { # A string which maps to an array of values.
              "a_key": [ # A string which maps to an array of values.
                "A String",
              ],
            },
            "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
            "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
            "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
              {
                "commandLine": "A String", # The command line used to run this program.
                "prevProgramId": "A String", # The ID of the program run before this one.
                "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.
                "version": "A String", # The version of the program run.
                "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
              },
            ],
            "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system.
            "experiment": { # The experiment used to generate this read group.
              "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
              "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.
              "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM.
              "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the
            },
            "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned.
            "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field.
            "datasetId": "A String", # The ID of the dataset this read group belongs to.
            "description": "A String", # A free-form text description of this read group.
          },
        ],
        "filename": "A String", # The filename of the original source file for this read group set, if any.
        "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to.
        "id": "A String", # The read group set ID.
        "datasetId": "A String", # The dataset ID.
      },
    ],
  }
update(readGroupSetId, body) 
Updates a read group set.

Args:
  readGroupSetId: string, The ID of the read group set to be updated. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.
    # - A read group set belongs to one dataset.
    # - A read group belongs to one read group set.
    # - A read belongs to one read group.
  "info": { # A string which maps to an array of values.
    "a_key": [ # A string which maps to an array of values.
      "A String",
    ],
  },
  "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
  "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
    { # A read group is all the data that's processed the same way by the sequencer.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
      "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
      "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
        {
          "commandLine": "A String", # The command line used to run this program.
          "prevProgramId": "A String", # The ID of the program run before this one.
          "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.
          "version": "A String", # The version of the program run.
          "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
        },
      ],
      "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system.
      "experiment": { # The experiment used to generate this read group.
        "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
        "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.
        "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM.
        "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the
      },
      "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned.
      "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field.
      "datasetId": "A String", # The ID of the dataset this read group belongs to.
      "description": "A String", # A free-form text description of this read group.
    },
  ],
  "filename": "A String", # The filename of the original source file for this read group set, if any.
  "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to.
  "id": "A String", # The read group set ID.
  "datasetId": "A String", # The dataset ID.
}


Returns:
  An object of the form:

    { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.
      # - A read group set belongs to one dataset.
      # - A read group belongs to one read group set.
      # - A read belongs to one read group.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "name": "A String", # The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set.
    "readGroups": [ # The read groups in this set. There are typically 1-10 read groups in a read group set.
      { # A read group is all the data that's processed the same way by the sequencer.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "predictedInsertSize": 42, # The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.
        "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec.
        "programs": [ # The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated.
          {
            "commandLine": "A String", # The command line used to run this program.
            "prevProgramId": "A String", # The ID of the program run before this one.
            "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.
            "version": "A String", # The version of the program run.
            "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'.
          },
        ],
        "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system.
        "experiment": { # The experiment used to generate this read group.
          "sequencingCenter": "A String", # The sequencing center used as part of this experiment.
          "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.
          "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM.
          "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the
        },
        "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned.
        "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field.
        "datasetId": "A String", # The ID of the dataset this read group belongs to.
        "description": "A String", # A free-form text description of this read group.
      },
    ],
    "filename": "A String", # The filename of the original source file for this read group set, if any.
    "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to.
    "id": "A String", # The read group set ID.
    "datasetId": "A String", # The dataset ID.
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.reads.html000066400000000000000000000303741300622755700252130ustar00rootroot00000000000000

Genomics API . reads

Instance Methods

search(body)

Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned.

Method Details

search(body) 
Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned.

If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads.

All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield reads in the same order across their respective streams of paginated responses.

Implements GlobalAllianceApi.searchReads.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The read search request.
    "readGroupSetIds": [ # The IDs of the read groups sets within which to search for reads. All specified read group sets must be aligned against a common set of reference sequences; this defines the genomic coordinates for the query. Must specify one of readGroupSetIds or readGroupIds.
      "A String",
    ],
    "readGroupIds": [ # The IDs of the read groups within which to search for reads. All specified read groups must belong to the same read group sets. Must specify one of readGroupSetIds or readGroupIds.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.
    "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified.
    "pageToken": "A 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.
    "referenceName": "A String", # The reference sequence name, for example chr1, 1, or chrX. If set to *, only unmapped reads are returned. If unspecified, all reads (mapped and unmapped) returned.
    "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified.
  }


Returns:
  An object of the form:

    { # The read search response.
    "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. This field will be empty if there aren't any additional results.
    "alignments": [ # The list of matching alignments sorted by mapped genomic coordinate, if any, ascending in position within the same reference. Unmapped reads, which have no position, are returned contiguously and are sorted in ascending lexicographic order by fragment name.
      { # A read alignment describes a linear alignment of a string of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one read group set. Generating a reference-aligned sequence string When interacting with mapped reads, it's often useful to produce a string representing the local alignment of the read to reference. The following pseudocode demonstrates one way of doing this:
          # out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out
          # Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the cigar field. Note that this is a lossy conversion (cigar.referenceSequence is lost).
          # cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400).
        "readGroupSetId": "A String", # The ID of the read group set this read belongs to. A read belongs to exactly one read group set.
        "alignedQuality": [ # The quality of the read sequence contained in this alignment record. (equivalent to QUAL in SAM). alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
          42,
        ],
        "failedVendorQualityChecks": True or False, # Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200).
        "fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM.
        "readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80.
        "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2).
        "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of the primary alignment of the (readNumber+1)%numberReads read in the fragment. It replaces mate position and mate strand in SAM. This field will be unset if that read is unmapped or if the fragment only has a single read.
          "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
          "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
          "referenceName": "A String", # The name of the reference in whatever reference set is being used.
        },
        "supplementaryAlignment": True or False, # Whether this alignment is supplementary. Equivalent to SAM flag 0x800. Supplementary alignments are used in the representation of a chimeric alignment. In a chimeric alignment, a read is split into multiple linear alignments that map to different reference contigs. The first linear alignment in the read will be designated as the representative alignment; the remaining linear alignments will be designated as supplementary alignments. These alignments may have different mapping quality scores. In each linear alignment in a chimeric alignment, the read will be hard clipped. The alignedSequence and alignedQuality fields in the alignment record will only represent the bases for its respective linear alignment.
        "numberReads": 42, # The number of reads in the fragment (extension to SAM flag 0x1).
        "fragmentLength": 42, # The observed length of the fragment, equivalent to TLEN in SAM.
        "secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both secondaryAlignment and supplementaryAlignment are false.
        "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, without CIGAR operations applied (equivalent to SEQ in SAM). alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
        "id": "A String", # The unique ID for this read. This is a generated unique ID, not to be confused with fragmentName.
        "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field is null for unmapped reads.
          "position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment.
            "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
            "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
            "referenceName": "A String", # The name of the reference in whatever reference set is being used.
          },
          "cigar": [ # Represents the local alignment of this sequence (alignment matches, indels, etc) against the reference.
            { # A single CIGAR operation.
              "referenceSequence": "A String", # referenceSequence is only used at mismatches (SEQUENCE_MISMATCH) and deletions (DELETE). Filling this field replaces SAM's MD tag. If the relevant information is not available, this field is unset.
              "operation": "A String",
              "operationLength": "A String", # The number of bases that the operation runs for. Required.
            },
          ],
          "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations.
              #
              # Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer.
        },
        "readGroupId": "A String", # The ID of the read group this read belongs to. A read belongs to exactly one read group. This is a server-generated ID (not SAM's RG tag).
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.references.bases.html000066400000000000000000000067071300622755700273350ustar00rootroot00000000000000

Genomics API . references . bases

Instance Methods

list(referenceId, end=None, pageSize=None, pageToken=None, start=None)

Lists the bases in a reference, optionally restricted to a range.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(referenceId, end=None, pageSize=None, pageToken=None, start=None) 
Lists the bases in a reference, optionally restricted to a range.

Implements GlobalAllianceApi.getReferenceBases.

Args:
  referenceId: string, The ID of the reference. (required)
  end: string, The end position (0-based, exclusive) of this query. Defaults to the length of this reference.
  pageSize: integer, The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base pairs).
  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.
  start: string, The start position (0-based) of this query. Defaults to 0.

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. This field will be empty if there aren't any additional results.
    "sequence": "A String", # A substring of the bases that make up this reference.
    "offset": "A String", # The offset position (0-based) of the given sequence from the start of this Reference. This value will differ for each page in a paginated 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.
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.references.html000066400000000000000000000131121300622755700262250ustar00rootroot00000000000000

Genomics API . references

Instance Methods

bases()

Returns the bases Resource.

get(referenceId)

Gets a reference.

search(body)

Searches for references which match the given criteria.

Method Details

get(referenceId) 
Gets a reference.

Implements GlobalAllianceApi.getReference.

Args:
  referenceId: string, The ID of the reference. (required)

Returns:
  An object of the form:

    { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets.
    "name": "A String", # The name of this reference, for example 22.
    "sourceURI": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file.
    "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.26.
      "A String",
    ],
    "length": "A String", # The length of this reference's sequence.
    "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
    "id": "A String", # The Google generated immutable ID of the reference.
    "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
  }
search(body) 
Searches for references which match the given criteria.

Implements GlobalAllianceApi.searchReferences.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "md5checksums": [ # If present, return references for which the md5checksum matches. See Reference.md5checksum for construction details.
      "A String",
    ],
    "pageToken": "A 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.
    "referenceSetId": "A String", # If present, return only references which belong to this reference set.
    "accessions": [ # If present, return references for which the accession matches this string. Best to give a version number, for example GCF_000001405.26. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
  }


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. This field will be empty if there aren't any additional results.
    "references": [ # The matching references.
      { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets.
        "name": "A String", # The name of this reference, for example 22.
        "sourceURI": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.26.
          "A String",
        ],
        "length": "A String", # The length of this reference's sequence.
        "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
        "id": "A String", # The Google generated immutable ID of the reference.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.referencesets.html000066400000000000000000000153741300622755700267550ustar00rootroot00000000000000

Genomics API . referencesets

Instance Methods

get(referenceSetId)

Gets a reference set.

search(body)

Searches for reference sets which match the given criteria.

Method Details

get(referenceSetId) 
Gets a reference set.

Implements GlobalAllianceApi.getReferenceSet.

Args:
  referenceSetId: string, The ID of the reference set. (required)

Returns:
  An object of the form:

    { # A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
    "description": "A String", # Free text description of this reference set.
    "sourceURI": "A String", # The URI from which the references were obtained.
    "referenceIds": [ # The IDs of the reference objects that are part of this set. Reference.md5checksum must be unique within this set.
      "A String",
    ],
    "assemblyId": "A String", # Public id of this reference set, such as GRCh37.
    "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example NC_000001.11.
      "A String",
    ],
    "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string reference.md5checksum (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format.
    "id": "A String", # The Google generated immutable ID of the reference set.
    "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different ncbiTaxonId, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome.
  }
search(body) 
Searches for reference sets which match the given criteria.

Implements GlobalAllianceApi.searchReferenceSets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "md5checksums": [ # If present, return references for which the md5checksum matches. See ReferenceSet.md5checksum for details.
      "A String",
    ],
    "assemblyId": "A String", # If present, return reference sets for which a substring of their assemblyId matches this string (case insensitive).
    "accessions": [ # If present, return references for which the accession matches any of these strings. Best to give a version number, for example GCF_000001405.26. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
    "pageToken": "A 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.
  }


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. This field will be empty if there aren't any additional results.
    "referenceSets": [ # The matching references sets.
      { # A reference set is a set of references which typically comprise a reference assembly for a species, such as GRCh38 which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
        "description": "A String", # Free text description of this reference set.
        "sourceURI": "A String", # The URI from which the references were obtained.
        "referenceIds": [ # The IDs of the reference objects that are part of this set. Reference.md5checksum must be unique within this set.
          "A String",
        ],
        "assemblyId": "A String", # Public id of this reference set, such as GRCh37.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example NC_000001.11.
          "A String",
        ],
        "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string reference.md5checksum (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format.
        "id": "A String", # The Google generated immutable ID of the reference set.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different ncbiTaxonId, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.variants.html000066400000000000000000000753371300622755700257540ustar00rootroot00000000000000

Genomics API . variants

Instance Methods

create(body)

Creates a new variant.

delete(variantId)

Deletes a variant.

get(variantId)

Gets a variant by ID.

search(body)

Gets a list of variants matching the criteria.

update(variantId, body)

Updates a variant's names and info fields. All other modifications are silently ignored. Returns the modified variant without its calls.

Method Details

create(body) 
Creates a new variant.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "variantSetId": "A String", # The ID of the variant set this variant belongs to.
    "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
    "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
      { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
          42,
        ],
        "callSetId": "A String", # The ID of the call set this variant call belongs to.
        "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
        "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
          3.14,
        ],
        "callSetName": "A String", # The name of the call set this variant call belongs to.
      },
    ],
    "created": "A String", # The date this variant was created, in milliseconds from the epoch.
    "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
    "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
      "A String",
    ],
    "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
    "names": [ # Names for the variant, for example a RefSNP ID.
      "A String",
    ],
    "alternateBases": [ # The bases that appear instead of the reference bases.
      "A String",
    ],
    "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
    "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
    "id": "A String", # The Google generated ID of the variant, immutable.
  }


Returns:
  An object of the form:

    { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "variantSetId": "A String", # The ID of the variant set this variant belongs to.
      "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
      "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
        { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
          "info": { # A string which maps to an array of values.
            "a_key": [ # A string which maps to an array of values.
              "A String",
            ],
          },
          "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
            42,
          ],
          "callSetId": "A String", # The ID of the call set this variant call belongs to.
          "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
          "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
            3.14,
          ],
          "callSetName": "A String", # The name of the call set this variant call belongs to.
        },
      ],
      "created": "A String", # The date this variant was created, in milliseconds from the epoch.
      "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
      "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
        "A String",
      ],
      "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
      "names": [ # Names for the variant, for example a RefSNP ID.
        "A String",
      ],
      "alternateBases": [ # The bases that appear instead of the reference bases.
        "A String",
      ],
      "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
      "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
      "id": "A String", # The Google generated ID of the variant, immutable.
    }
delete(variantId) 
Deletes a variant.

Args:
  variantId: string, The ID of the variant to be deleted. (required)
get(variantId) 
Gets a variant by ID.

Args:
  variantId: string, Required. (required)

Returns:
  An object of the form:

    { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "variantSetId": "A String", # The ID of the variant set this variant belongs to.
      "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
      "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
        { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
          "info": { # A string which maps to an array of values.
            "a_key": [ # A string which maps to an array of values.
              "A String",
            ],
          },
          "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
            42,
          ],
          "callSetId": "A String", # The ID of the call set this variant call belongs to.
          "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
          "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
            3.14,
          ],
          "callSetName": "A String", # The name of the call set this variant call belongs to.
        },
      ],
      "created": "A String", # The date this variant was created, in milliseconds from the epoch.
      "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
      "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
        "A String",
      ],
      "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
      "names": [ # Names for the variant, for example a RefSNP ID.
        "A String",
      ],
      "alternateBases": [ # The bases that appear instead of the reference bases.
        "A String",
      ],
      "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
      "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
      "id": "A String", # The Google generated ID of the variant, immutable.
    }
search(body) 
Gets a list of variants matching the criteria.

Implements GlobalAllianceApi.searchVariants.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The variant search request.
    "end": "A String", # The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference.
    "pageSize": 42, # The maximum number of variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000.
    "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0.
    "maxCalls": 42, # The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000.
    "pageToken": "A 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.
    "callSetIds": [ # Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all.
      "A String",
    ],
    "variantName": "A String", # Only return variants which have exactly this name.
    "referenceName": "A String", # Required. Only return variants in this reference sequence.
    "variantSetIds": [ # At most one variant set ID must be provided. Only variants from this variant set will be returned. If omitted, a call set id must be included in the request. Both this and call_set_ids may be set.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # The variant search response.
    "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. This field will be empty if there aren't any additional results.
    "variants": [ # The list of matching Variants.
      { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
          "info": { # A string which maps to an array of values.
            "a_key": [ # A string which maps to an array of values.
              "A String",
            ],
          },
          "variantSetId": "A String", # The ID of the variant set this variant belongs to.
          "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
          "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
            { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
              "info": { # A string which maps to an array of values.
                "a_key": [ # A string which maps to an array of values.
                  "A String",
                ],
              },
              "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
                42,
              ],
              "callSetId": "A String", # The ID of the call set this variant call belongs to.
              "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
              "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
                3.14,
              ],
              "callSetName": "A String", # The name of the call set this variant call belongs to.
            },
          ],
          "created": "A String", # The date this variant was created, in milliseconds from the epoch.
          "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
          "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
            "A String",
          ],
          "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
          "names": [ # Names for the variant, for example a RefSNP ID.
            "A String",
          ],
          "alternateBases": [ # The bases that appear instead of the reference bases.
            "A String",
          ],
          "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
          "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
          "id": "A String", # The Google generated ID of the variant, immutable.
        },
    ],
  }
update(variantId, body) 
Updates a variant's names and info fields. All other modifications are silently ignored. Returns the modified variant without its calls.

Args:
  variantId: string, The ID of the variant to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
    "info": { # A string which maps to an array of values.
      "a_key": [ # A string which maps to an array of values.
        "A String",
      ],
    },
    "variantSetId": "A String", # The ID of the variant set this variant belongs to.
    "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
    "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
      { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
          42,
        ],
        "callSetId": "A String", # The ID of the call set this variant call belongs to.
        "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
        "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
          3.14,
        ],
        "callSetName": "A String", # The name of the call set this variant call belongs to.
      },
    ],
    "created": "A String", # The date this variant was created, in milliseconds from the epoch.
    "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
    "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
      "A String",
    ],
    "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
    "names": [ # Names for the variant, for example a RefSNP ID.
      "A String",
    ],
    "alternateBases": [ # The bases that appear instead of the reference bases.
      "A String",
    ],
    "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
    "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
    "id": "A String", # The Google generated ID of the variant, immutable.
  }


Returns:
  An object of the form:

    { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "variantSetId": "A String", # The ID of the variant set this variant belongs to.
      "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
      "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
        { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
          "info": { # A string which maps to an array of values.
            "a_key": [ # A string which maps to an array of values.
              "A String",
            ],
          },
          "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
            42,
          ],
          "callSetId": "A String", # The ID of the call set this variant call belongs to.
          "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
          "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
            3.14,
          ],
          "callSetName": "A String", # The name of the call set this variant call belongs to.
        },
      ],
      "created": "A String", # The date this variant was created, in milliseconds from the epoch.
      "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
      "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
        "A String",
      ],
      "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
      "names": [ # Names for the variant, for example a RefSNP ID.
        "A String",
      ],
      "alternateBases": [ # The bases that appear instead of the reference bases.
        "A String",
      ],
      "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
      "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
      "id": "A String", # The Google generated ID of the variant, immutable.
    }
google-api-python-client-1.5.5/docs/dyn/genomics_v1beta2.variantsets.html000066400000000000000000001065241300622755700264610ustar00rootroot00000000000000

Genomics API . variantsets

Instance Methods

create(body)

Creates a new variant set (only necessary in v1).

delete(variantSetId)

Deletes a variant set including all variants, call sets, and calls within. This is not reversible.

export(variantSetId, body)

Exports variant set data to an external destination.

get(variantSetId)

Gets a variant set by ID.

importVariants(variantSetId, body)

Creates variant data by asynchronously importing the provided information.

mergeVariants(variantSetId, body)

Merges the given variants with existing variants. Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created.

patch(variantSetId, body)

Updates a variant set's metadata. All other modifications are silently ignored. This method supports patch semantics.

search(body)

Returns a list of all variant sets matching search criteria.

update(variantSetId, body)

Updates a variant set's metadata. All other modifications are silently ignored.

Method Details

create(body) 
Creates a new variant set (only necessary in v1).

The provided variant set must have a valid datasetId set - all other fields are optional. Note that the id field will be ignored, as this is assigned by the server.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
  "name": "A String", # User-specified, mutable name.
  "description": "A String", # A textual description of this variant set.
  "metadata": [ # The metadata associated with this variant set.
    { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "description": "A String", # A textual description of this metadata.
      "number": "A String", # The number of values that can be included in a field described by this metadata.
      "value": "A String", # The value field for simple metadata
      "key": "A String", # The top-level key.
      "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
      "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
    },
  ],
  "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
      # 
      # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
  "id": "A String", # The Google-generated ID of the variant set. Immutable.
  "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
  "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
    { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
      "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
      "referenceName": "A String", # The name of the reference associated with this reference bound.
    },
  ],
}


Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
        #
        # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The Google-generated ID of the variant set. Immutable.
    "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
  }
delete(variantSetId) 
Deletes a variant set including all variants, call sets, and calls within. This is not reversible.

Args:
  variantSetId: string, The ID of the variant set to be deleted. Required. (required)
export(variantSetId, body) 
Exports variant set data to an external destination.

Args:
  variantSetId: string, The ID of the variant set that contains variant data which should be exported. Required. The caller must have READ access to this variant set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The variant data export request.
    "bigqueryDataset": "A String", # Required. The BigQuery dataset to export data to. This dataset must already exist. Note that this is distinct from the Genomics concept of "dataset".
    "format": "A String", # The format for the exported data.
    "callSetIds": [ # If provided, only variant call information from the specified call sets will be exported. By default all variant calls are exported.
      "A String",
    ],
    "projectNumber": "A String", # Required. The Google Cloud project number that owns the destination BigQuery dataset. The caller must have WRITE access to this project. This project will also own the resulting export job.
    "bigqueryTable": "A String", # Required. The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it will be overwritten.
  }


Returns:
  An object of the form:

    { # The variant data export response.
    "jobId": "A String", # A job ID that can be used to get status information.
  }
get(variantSetId) 
Gets a variant set by ID.

Args:
  variantSetId: string, The ID of the variant set. Required. (required)

Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
        #
        # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The Google-generated ID of the variant set. Immutable.
    "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
  }
importVariants(variantSetId, body) 
Creates variant data by asynchronously importing the provided information.

The variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting info fields, some data will be arbitrarily discarded unless otherwise specified in the InfoMergeConfig field of ImportVariantsRequest. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.

Args:
  variantSetId: string, Required. The variant set to which variant data should be imported. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The variant data import request.
    "normalizeReferenceNames": True or False, # Convert reference names to the canonical representation. hg19 haploytypes (those reference names containing "_hap") are not modified in any way. All other reference names are modified according to the following rules: The reference name is capitalized. The "chr" prefix is dropped for all autosomes and sex chromsomes. For example "chr17" becomes "17" and "chrX" becomes "X". All mitochondrial chromosomes ("chrM", "chrMT", etc) become "MT".
    "sourceUris": [ # A list of URIs referencing variant files in Google Cloud Storage. URIs can include wildcards as described here. Note that recursive wildcards ('**') are not supported.
      "A String",
    ],
    "format": "A String", # The format of the variant data being imported. If unspecified, defaults to "VCF".
  }


Returns:
  An object of the form:

    { # The variant data import response.
    "jobId": "A String", # A job ID that can be used to get status information.
  }
mergeVariants(variantSetId, body) 
Merges the given variants with existing variants. Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created.

When variants are merged, the call information from the new variant is added to the existing variant. Variant info fields are merged as specified in the InfoMergeConfig field of the MergeVariantsRequest.

Args:
  variantSetId: string, The destination variant set. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "variants": [ # The variants to be merged with existing variants.
      { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
          "info": { # A string which maps to an array of values.
            "a_key": [ # A string which maps to an array of values.
              "A String",
            ],
          },
          "variantSetId": "A String", # The ID of the variant set this variant belongs to.
          "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
          "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
            { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
              "info": { # A string which maps to an array of values.
                "a_key": [ # A string which maps to an array of values.
                  "A String",
                ],
              },
              "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
                42,
              ],
              "callSetId": "A String", # The ID of the call set this variant call belongs to.
              "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
              "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.
                3.14,
              ],
              "callSetName": "A String", # The name of the call set this variant call belongs to.
            },
          ],
          "created": "A String", # The date this variant was created, in milliseconds from the epoch.
          "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
          "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
            "A String",
          ],
          "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
          "names": [ # Names for the variant, for example a RefSNP ID.
            "A String",
          ],
          "alternateBases": [ # The bases that appear instead of the reference bases.
            "A String",
          ],
          "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
          "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
          "id": "A String", # The Google generated ID of the variant, immutable.
        },
    ],
  }
patch(variantSetId, body) 
Updates a variant set's metadata. All other modifications are silently ignored. This method supports patch semantics.

Args:
  variantSetId: string, The ID of the variant set to be updated (must already exist). (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
  "name": "A String", # User-specified, mutable name.
  "description": "A String", # A textual description of this variant set.
  "metadata": [ # The metadata associated with this variant set.
    { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "description": "A String", # A textual description of this metadata.
      "number": "A String", # The number of values that can be included in a field described by this metadata.
      "value": "A String", # The value field for simple metadata
      "key": "A String", # The top-level key.
      "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
      "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
    },
  ],
  "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
      # 
      # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
  "id": "A String", # The Google-generated ID of the variant set. Immutable.
  "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
  "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
    { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
      "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
      "referenceName": "A String", # The name of the reference associated with this reference bound.
    },
  ],
}


Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
        #
        # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The Google-generated ID of the variant set. Immutable.
    "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
  }
search(body) 
Returns a list of all variant sets matching search criteria.

Implements GlobalAllianceApi.searchVariantSets.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The search variant sets request.
    "pageToken": "A 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.
    "datasetIds": [ # Exactly one dataset ID must be provided here. Only variant sets which belong to this dataset will be returned.
      "A String",
    ],
    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024.
  }


Returns:
  An object of the form:

    { # The search variant sets response.
    "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. This field will be empty if there aren't any additional results.
    "variantSets": [ # The variant sets belonging to the requested dataset.
      { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
        "name": "A String", # User-specified, mutable name.
        "description": "A String", # A textual description of this variant set.
        "metadata": [ # The metadata associated with this variant set.
          { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
            "info": { # A string which maps to an array of values.
              "a_key": [ # A string which maps to an array of values.
                "A String",
              ],
            },
            "description": "A String", # A textual description of this metadata.
            "number": "A String", # The number of values that can be included in a field described by this metadata.
            "value": "A String", # The value field for simple metadata
            "key": "A String", # The top-level key.
            "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
            "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
          },
        ],
        "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
            #
            # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
        "id": "A String", # The Google-generated ID of the variant set. Immutable.
        "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
        "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
          { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
            "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
            "referenceName": "A String", # The name of the reference associated with this reference bound.
          },
        ],
      },
    ],
  }
update(variantSetId, body) 
Updates a variant set's metadata. All other modifications are silently ignored.

Args:
  variantSetId: string, The ID of the variant set to be updated (must already exist). (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
  "name": "A String", # User-specified, mutable name.
  "description": "A String", # A textual description of this variant set.
  "metadata": [ # The metadata associated with this variant set.
    { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "description": "A String", # A textual description of this metadata.
      "number": "A String", # The number of values that can be included in a field described by this metadata.
      "value": "A String", # The value field for simple metadata
      "key": "A String", # The top-level key.
      "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
      "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
    },
  ],
  "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
      # 
      # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
  "id": "A String", # The Google-generated ID of the variant set. Immutable.
  "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
  "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
    { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
      "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
      "referenceName": "A String", # The name of the reference associated with this reference bound.
    },
  ],
}


Returns:
  An object of the form:

    { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
    "name": "A String", # User-specified, mutable name.
    "description": "A String", # A textual description of this variant set.
    "metadata": [ # The metadata associated with this variant set.
      { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "description": "A String", # A textual description of this metadata.
        "number": "A String", # The number of values that can be included in a field described by this metadata.
        "value": "A String", # The value field for simple metadata
        "key": "A String", # The top-level key.
        "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
        "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
      },
    ],
    "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds.
        #
        # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
    "id": "A String", # The Google-generated ID of the variant set. Immutable.
    "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
    "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
      { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
        "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
        "referenceName": "A String", # The name of the reference associated with this reference bound.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.html000066400000000000000000000040731300622755700224620ustar00rootroot00000000000000

Gmail API

Instance Methods

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.drafts.html000066400000000000000000001024621300622755700251050ustar00rootroot00000000000000

Gmail API . users . drafts

Instance Methods

create(userId, body=None, media_body=None)

Creates a new draft with the DRAFT label.

delete(userId, id)

Immediately and permanently deletes the specified draft. Does not simply trash it.

get(userId, id, format=None)

Gets the specified draft.

list(userId, q=None, pageToken=None, maxResults=None, includeSpamTrash=None)

Lists the drafts in the user's mailbox.

list_next(previous_request, previous_response)

Retrieves the next page of results.

send(userId, body=None, media_body=None)

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

update(userId, id, body=None, media_body=None)

Replaces a draft's content.

Method Details

create(userId, body=None, media_body=None) 
Creates a new draft with the DRAFT label.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # A draft email in the user's mailbox.
  "message": { # An email message. # The message content of the draft.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  },
  "id": "A String", # The immutable ID of the draft.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # A draft email in the user's mailbox.
    "message": { # An email message. # The message content of the draft.
      "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
      "historyId": "A String", # The ID of the last history record that modified this message.
      "payload": { # A single MIME message part. # The parsed email structure in the message parts.
        "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
          "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
          "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
          "size": 42, # Total number of bytes in the body of the message part.
        },
        "mimeType": "A String", # The MIME type of the message part.
        "partId": "A String", # The immutable ID of the message part.
        "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
        "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
          {
            "name": "A String", # The name of the header before the : separator. For example, To.
            "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
          },
        ],
        "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
          # Object with schema name: MessagePart
        ],
      },
      "snippet": "A String", # A short part of the message text.
      "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
      "sizeEstimate": 42, # Estimated size in bytes of the message.
      "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
          # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
          # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
          # - The Subject headers must match.
      "labelIds": [ # List of IDs of labels applied to this message.
        "A String",
      ],
      "id": "A String", # The immutable ID of the message.
    },
    "id": "A String", # The immutable ID of the draft.
  }
delete(userId, id) 
Immediately and permanently deletes the specified draft. Does not simply trash it.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the draft to delete. (required)
get(userId, id, format=None) 
Gets the specified draft.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the draft to retrieve. (required)
  format: string, The format to return the draft in.
    Allowed values
      full - 
      metadata - 
      minimal - 
      raw - 

Returns:
  An object of the form:

    { # A draft email in the user's mailbox.
    "message": { # An email message. # The message content of the draft.
      "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
      "historyId": "A String", # The ID of the last history record that modified this message.
      "payload": { # A single MIME message part. # The parsed email structure in the message parts.
        "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
          "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
          "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
          "size": 42, # Total number of bytes in the body of the message part.
        },
        "mimeType": "A String", # The MIME type of the message part.
        "partId": "A String", # The immutable ID of the message part.
        "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
        "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
          {
            "name": "A String", # The name of the header before the : separator. For example, To.
            "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
          },
        ],
        "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
          # Object with schema name: MessagePart
        ],
      },
      "snippet": "A String", # A short part of the message text.
      "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
      "sizeEstimate": 42, # Estimated size in bytes of the message.
      "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
          # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
          # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
          # - The Subject headers must match.
      "labelIds": [ # List of IDs of labels applied to this message.
        "A String",
      ],
      "id": "A String", # The immutable ID of the message.
    },
    "id": "A String", # The immutable ID of the draft.
  }
list(userId, q=None, pageToken=None, maxResults=None, includeSpamTrash=None) 
Lists the drafts in the user's mailbox.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  q: string, Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
  pageToken: string, Page token to retrieve a specific page of results in the list.
  maxResults: integer, Maximum number of drafts to return.
  includeSpamTrash: boolean, Include drafts from SPAM and TRASH in the results.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
    "resultSizeEstimate": 42, # Estimated total number of results.
    "drafts": [ # List of drafts.
      { # A draft email in the user's mailbox.
        "message": { # An email message. # The message content of the draft.
          "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
          "historyId": "A String", # The ID of the last history record that modified this message.
          "payload": { # A single MIME message part. # The parsed email structure in the message parts.
            "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
              "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
              "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
              "size": 42, # Total number of bytes in the body of the message part.
            },
            "mimeType": "A String", # The MIME type of the message part.
            "partId": "A String", # The immutable ID of the message part.
            "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
            "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
              {
                "name": "A String", # The name of the header before the : separator. For example, To.
                "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
              },
            ],
            "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
              # Object with schema name: MessagePart
            ],
          },
          "snippet": "A String", # A short part of the message text.
          "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
          "sizeEstimate": 42, # Estimated size in bytes of the message.
          "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
              # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
              # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
              # - The Subject headers must match.
          "labelIds": [ # List of IDs of labels applied to this message.
            "A String",
          ],
          "id": "A String", # The immutable ID of the message.
        },
        "id": "A String", # The immutable ID of the draft.
      },
    ],
  }
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.
send(userId, body=None, media_body=None) 
Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # A draft email in the user's mailbox.
  "message": { # An email message. # The message content of the draft.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  },
  "id": "A String", # The immutable ID of the draft.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
update(userId, id, body=None, media_body=None) 
Replaces a draft's content.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the draft to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # A draft email in the user's mailbox.
  "message": { # An email message. # The message content of the draft.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  },
  "id": "A String", # The immutable ID of the draft.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # A draft email in the user's mailbox.
    "message": { # An email message. # The message content of the draft.
      "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
      "historyId": "A String", # The ID of the last history record that modified this message.
      "payload": { # A single MIME message part. # The parsed email structure in the message parts.
        "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
          "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
          "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
          "size": 42, # Total number of bytes in the body of the message part.
        },
        "mimeType": "A String", # The MIME type of the message part.
        "partId": "A String", # The immutable ID of the message part.
        "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
        "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
          {
            "name": "A String", # The name of the header before the : separator. For example, To.
            "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
          },
        ],
        "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
          # Object with schema name: MessagePart
        ],
      },
      "snippet": "A String", # A short part of the message text.
      "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
      "sizeEstimate": 42, # Estimated size in bytes of the message.
      "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
          # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
          # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
          # - The Subject headers must match.
      "labelIds": [ # List of IDs of labels applied to this message.
        "A String",
      ],
      "id": "A String", # The immutable ID of the message.
    },
    "id": "A String", # The immutable ID of the draft.
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.history.html000066400000000000000000000550731300622755700253300ustar00rootroot00000000000000

Gmail API . users . history

Instance Methods

list(userId, pageToken=None, maxResults=None, startHistoryId=None, labelId=None)

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(userId, pageToken=None, maxResults=None, startHistoryId=None, labelId=None) 
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  pageToken: string, Page token to retrieve a specific page of results in the list.
  maxResults: integer, The maximum number of history records to return.
  startHistoryId: string, Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.
  labelId: string, Only return messages with a label matching the ID.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
    "historyId": "A String", # The ID of the mailbox's current history record.
    "history": [ # List of history records. Any messages contained in the response will typically only have id and threadId fields populated.
      { # A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.
        "labelsAdded": [ # Labels added to messages in this history record.
          {
            "labelIds": [ # Label IDs added to the message.
              "A String",
            ],
            "message": { # An email message.
              "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
              "historyId": "A String", # The ID of the last history record that modified this message.
              "payload": { # A single MIME message part. # The parsed email structure in the message parts.
                "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
                  "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
                  "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
                  "size": 42, # Total number of bytes in the body of the message part.
                },
                "mimeType": "A String", # The MIME type of the message part.
                "partId": "A String", # The immutable ID of the message part.
                "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
                "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
                  {
                    "name": "A String", # The name of the header before the : separator. For example, To.
                    "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
                  },
                ],
                "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
                  # Object with schema name: MessagePart
                ],
              },
              "snippet": "A String", # A short part of the message text.
              "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
              "sizeEstimate": 42, # Estimated size in bytes of the message.
              "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
                  # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
                  # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
                  # - The Subject headers must match.
              "labelIds": [ # List of IDs of labels applied to this message.
                "A String",
              ],
              "id": "A String", # The immutable ID of the message.
            },
          },
        ],
        "messages": [ # List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this.
          { # An email message.
            "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
            "historyId": "A String", # The ID of the last history record that modified this message.
            "payload": { # A single MIME message part. # The parsed email structure in the message parts.
              "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
                "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
                "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
                "size": 42, # Total number of bytes in the body of the message part.
              },
              "mimeType": "A String", # The MIME type of the message part.
              "partId": "A String", # The immutable ID of the message part.
              "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
              "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
                {
                  "name": "A String", # The name of the header before the : separator. For example, To.
                  "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
                },
              ],
              "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
                # Object with schema name: MessagePart
              ],
            },
            "snippet": "A String", # A short part of the message text.
            "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
            "sizeEstimate": 42, # Estimated size in bytes of the message.
            "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
                # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
                # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
                # - The Subject headers must match.
            "labelIds": [ # List of IDs of labels applied to this message.
              "A String",
            ],
            "id": "A String", # The immutable ID of the message.
          },
        ],
        "messagesAdded": [ # Messages added to the mailbox in this history record.
          {
            "message": { # An email message.
              "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
              "historyId": "A String", # The ID of the last history record that modified this message.
              "payload": { # A single MIME message part. # The parsed email structure in the message parts.
                "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
                  "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
                  "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
                  "size": 42, # Total number of bytes in the body of the message part.
                },
                "mimeType": "A String", # The MIME type of the message part.
                "partId": "A String", # The immutable ID of the message part.
                "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
                "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
                  {
                    "name": "A String", # The name of the header before the : separator. For example, To.
                    "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
                  },
                ],
                "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
                  # Object with schema name: MessagePart
                ],
              },
              "snippet": "A String", # A short part of the message text.
              "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
              "sizeEstimate": 42, # Estimated size in bytes of the message.
              "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
                  # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
                  # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
                  # - The Subject headers must match.
              "labelIds": [ # List of IDs of labels applied to this message.
                "A String",
              ],
              "id": "A String", # The immutable ID of the message.
            },
          },
        ],
        "labelsRemoved": [ # Labels removed from messages in this history record.
          {
            "labelIds": [ # Label IDs removed from the message.
              "A String",
            ],
            "message": { # An email message.
              "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
              "historyId": "A String", # The ID of the last history record that modified this message.
              "payload": { # A single MIME message part. # The parsed email structure in the message parts.
                "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
                  "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
                  "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
                  "size": 42, # Total number of bytes in the body of the message part.
                },
                "mimeType": "A String", # The MIME type of the message part.
                "partId": "A String", # The immutable ID of the message part.
                "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
                "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
                  {
                    "name": "A String", # The name of the header before the : separator. For example, To.
                    "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
                  },
                ],
                "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
                  # Object with schema name: MessagePart
                ],
              },
              "snippet": "A String", # A short part of the message text.
              "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
              "sizeEstimate": 42, # Estimated size in bytes of the message.
              "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
                  # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
                  # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
                  # - The Subject headers must match.
              "labelIds": [ # List of IDs of labels applied to this message.
                "A String",
              ],
              "id": "A String", # The immutable ID of the message.
            },
          },
        ],
        "messagesDeleted": [ # Messages deleted (not Trashed) from the mailbox in this history record.
          {
            "message": { # An email message.
              "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
              "historyId": "A String", # The ID of the last history record that modified this message.
              "payload": { # A single MIME message part. # The parsed email structure in the message parts.
                "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
                  "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
                  "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
                  "size": 42, # Total number of bytes in the body of the message part.
                },
                "mimeType": "A String", # The MIME type of the message part.
                "partId": "A String", # The immutable ID of the message part.
                "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
                "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
                  {
                    "name": "A String", # The name of the header before the : separator. For example, To.
                    "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
                  },
                ],
                "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
                  # Object with schema name: MessagePart
                ],
              },
              "snippet": "A String", # A short part of the message text.
              "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
              "sizeEstimate": 42, # Estimated size in bytes of the message.
              "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
                  # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
                  # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
                  # - The Subject headers must match.
              "labelIds": [ # List of IDs of labels applied to this message.
                "A String",
              ],
              "id": "A String", # The immutable ID of the message.
            },
          },
        ],
        "id": "A String", # The mailbox sequence ID.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.html000066400000000000000000000117111300622755700236170ustar00rootroot00000000000000

Gmail API . users

Instance Methods

drafts()

Returns the drafts Resource.

history()

Returns the history Resource.

labels()

Returns the labels Resource.

messages()

Returns the messages Resource.

settings()

Returns the settings Resource.

threads()

Returns the threads Resource.

getProfile(userId)

Gets the current user's Gmail profile.

stop(userId)

Stop receiving push notifications for the given user mailbox.

watch(userId, body)

Set up or update a push notification watch on the given user mailbox.

Method Details

getProfile(userId) 
Gets the current user's Gmail profile.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # Profile for a Gmail user.
    "threadsTotal": 42, # The total number of threads in the mailbox.
    "emailAddress": "A String", # The user's email address.
    "historyId": "A String", # The ID of the mailbox's current history record.
    "messagesTotal": 42, # The total number of messages in the mailbox.
  }
stop(userId) 
Stop receiving push notifications for the given user mailbox.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
watch(userId, body) 
Set up or update a push notification watch on the given user mailbox.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Set up or update a new push notification watch on this user's mailbox.
    "labelIds": [ # List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
      "A String",
    ],
    "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format).
        # 
        # Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).
    "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
  }


Returns:
  An object of the form:

    { # Push notification watch response.
    "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.
    "historyId": "A String", # The ID of the mailbox's current history record.
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.labels.html000066400000000000000000000347621300622755700250730ustar00rootroot00000000000000

Gmail API . users . labels

Instance Methods

create(userId, body)

Creates a new label.

delete(userId, id)

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

get(userId, id)

Gets the specified label.

list(userId)

Lists all labels in the user's mailbox.

patch(userId, id, body)

Updates the specified label. This method supports patch semantics.

update(userId, id, body)

Updates the specified label.

Method Details

create(userId, body) 
Creates a new label.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Labels are used to categorize messages and threads within the user's mailbox.
  "name": "A String", # The display name of the label.
  "messagesTotal": 42, # The total number of messages with the label.
  "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
  "threadsUnread": 42, # The number of unread threads with the label.
  "messagesUnread": 42, # The number of unread messages with the label.
  "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
  "threadsTotal": 42, # The total number of threads with the label.
  "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
  "id": "A String", # The immutable ID of the label.
}


Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the user's mailbox.
    "name": "A String", # The display name of the label.
    "messagesTotal": 42, # The total number of messages with the label.
    "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
    "threadsUnread": 42, # The number of unread threads with the label.
    "messagesUnread": 42, # The number of unread messages with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
    "threadsTotal": 42, # The total number of threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
    "id": "A String", # The immutable ID of the label.
  }
delete(userId, id) 
Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to delete. (required)
get(userId, id) 
Gets the specified label.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to retrieve. (required)

Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the user's mailbox.
    "name": "A String", # The display name of the label.
    "messagesTotal": 42, # The total number of messages with the label.
    "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
    "threadsUnread": 42, # The number of unread threads with the label.
    "messagesUnread": 42, # The number of unread messages with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
    "threadsTotal": 42, # The total number of threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
    "id": "A String", # The immutable ID of the label.
  }
list(userId) 
Lists all labels in the user's mailbox.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    {
    "labels": [ # List of labels.
      { # Labels are used to categorize messages and threads within the user's mailbox.
        "name": "A String", # The display name of the label.
        "messagesTotal": 42, # The total number of messages with the label.
        "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
        "threadsUnread": 42, # The number of unread threads with the label.
        "messagesUnread": 42, # The number of unread messages with the label.
        "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
        "threadsTotal": 42, # The total number of threads with the label.
        "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
        "id": "A String", # The immutable ID of the label.
      },
    ],
  }
patch(userId, id, body) 
Updates the specified label. This method supports patch semantics.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Labels are used to categorize messages and threads within the user's mailbox.
  "name": "A String", # The display name of the label.
  "messagesTotal": 42, # The total number of messages with the label.
  "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
  "threadsUnread": 42, # The number of unread threads with the label.
  "messagesUnread": 42, # The number of unread messages with the label.
  "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
  "threadsTotal": 42, # The total number of threads with the label.
  "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
  "id": "A String", # The immutable ID of the label.
}


Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the user's mailbox.
    "name": "A String", # The display name of the label.
    "messagesTotal": 42, # The total number of messages with the label.
    "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
    "threadsUnread": 42, # The number of unread threads with the label.
    "messagesUnread": 42, # The number of unread messages with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
    "threadsTotal": 42, # The total number of threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
    "id": "A String", # The immutable ID of the label.
  }
update(userId, id, body) 
Updates the specified label.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the label to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Labels are used to categorize messages and threads within the user's mailbox.
  "name": "A String", # The display name of the label.
  "messagesTotal": 42, # The total number of messages with the label.
  "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
  "threadsUnread": 42, # The number of unread threads with the label.
  "messagesUnread": 42, # The number of unread messages with the label.
  "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
  "threadsTotal": 42, # The total number of threads with the label.
  "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
  "id": "A String", # The immutable ID of the label.
}


Returns:
  An object of the form:

    { # Labels are used to categorize messages and threads within the user's mailbox.
    "name": "A String", # The display name of the label.
    "messagesTotal": 42, # The total number of messages with the label.
    "type": "A String", # The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
    "threadsUnread": 42, # The number of unread threads with the label.
    "messagesUnread": 42, # The number of unread messages with the label.
    "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
    "threadsTotal": 42, # The total number of threads with the label.
    "messageListVisibility": "A String", # The visibility of the label in the message list in the Gmail web interface.
    "id": "A String", # The immutable ID of the label.
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.messages.attachments.html000066400000000000000000000046361300622755700277470ustar00rootroot00000000000000

Gmail API . users . messages . attachments

Instance Methods

get(userId, messageId, id)

Gets the specified message attachment.

Method Details

get(userId, messageId, id) 
Gets the specified message attachment.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  messageId: string, The ID of the message containing the attachment. (required)
  id: string, The ID of the attachment. (required)

Returns:
  An object of the form:

    { # The body of a single MIME message part.
    "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
    "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
    "size": 42, # Total number of bytes in the body of the message part.
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.messages.html000066400000000000000000001341521300622755700254320ustar00rootroot00000000000000

Gmail API . users . messages

Instance Methods

attachments()

Returns the attachments Resource.

batchDelete(userId, body)

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

delete(userId, id)

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.

get(userId, id, format=None, metadataHeaders=None)

Gets the specified message.

import_(userId, body=None, media_body=None, internalDateSource=None, neverMarkSpam=None, processForCalendar=None, deleted=None)

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.

insert(userId, body=None, media_body=None, internalDateSource=None, deleted=None)

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None)

Lists the messages in the user's mailbox.

list_next(previous_request, previous_response)

Retrieves the next page of results.

modify(userId, id, body)

Modifies the labels on the specified message.

send(userId, body=None, media_body=None)

Sends the specified message to the recipients in the To, Cc, and Bcc headers.

trash(userId, id)

Moves the specified message to the trash.

untrash(userId, id)

Removes the specified message from the trash.

Method Details

batchDelete(userId, body) 
Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "ids": [ # The IDs of the messages to delete.
      "A String",
    ],
  }
delete(userId, id) 
Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the message to delete. (required)
get(userId, id, format=None, metadataHeaders=None) 
Gets the specified message.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the message to retrieve. (required)
  format: string, The format to return the message in.
    Allowed values
      full - 
      metadata - 
      minimal - 
      raw - 
  metadataHeaders: string, When given and format is METADATA, only include headers specified. (repeated)

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
import_(userId, body=None, media_body=None, internalDateSource=None, neverMarkSpam=None, processForCalendar=None, deleted=None) 
Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # An email message.
  "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
  "historyId": "A String", # The ID of the last history record that modified this message.
  "payload": { # A single MIME message part. # The parsed email structure in the message parts.
    "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
      "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
      "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
      "size": 42, # Total number of bytes in the body of the message part.
    },
    "mimeType": "A String", # The MIME type of the message part.
    "partId": "A String", # The immutable ID of the message part.
    "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
    "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
      {
        "name": "A String", # The name of the header before the : separator. For example, To.
        "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
      },
    ],
    "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
      # Object with schema name: MessagePart
    ],
  },
  "snippet": "A String", # A short part of the message text.
  "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
  "sizeEstimate": 42, # Estimated size in bytes of the message.
  "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
      # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
      # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
      # - The Subject headers must match.
  "labelIds": [ # List of IDs of labels applied to this message.
    "A String",
  ],
  "id": "A String", # The immutable ID of the message.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  internalDateSource: string, Source for Gmail's internal date of the message.
    Allowed values
      dateHeader - 
      receivedTime - 
  neverMarkSpam: boolean, Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
  processForCalendar: boolean, Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
  deleted: boolean, Mark the email as permanently deleted (not TRASH) and only visible in Google Apps Vault to a Vault administrator. Only used for Google Apps for Work accounts.

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
insert(userId, body=None, media_body=None, internalDateSource=None, deleted=None) 
Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # An email message.
  "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
  "historyId": "A String", # The ID of the last history record that modified this message.
  "payload": { # A single MIME message part. # The parsed email structure in the message parts.
    "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
      "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
      "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
      "size": 42, # Total number of bytes in the body of the message part.
    },
    "mimeType": "A String", # The MIME type of the message part.
    "partId": "A String", # The immutable ID of the message part.
    "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
    "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
      {
        "name": "A String", # The name of the header before the : separator. For example, To.
        "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
      },
    ],
    "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
      # Object with schema name: MessagePart
    ],
  },
  "snippet": "A String", # A short part of the message text.
  "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
  "sizeEstimate": 42, # Estimated size in bytes of the message.
  "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
      # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
      # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
      # - The Subject headers must match.
  "labelIds": [ # List of IDs of labels applied to this message.
    "A String",
  ],
  "id": "A String", # The immutable ID of the message.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  internalDateSource: string, Source for Gmail's internal date of the message.
    Allowed values
      dateHeader - 
      receivedTime - 
  deleted: boolean, Mark the email as permanently deleted (not TRASH) and only visible in Google Apps Vault to a Vault administrator. Only used for Google Apps for Work accounts.

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None) 
Lists the messages in the user's mailbox.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  labelIds: string, Only return messages with labels that match all of the specified label IDs. (repeated)
  q: string, Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
  pageToken: string, Page token to retrieve a specific page of results in the list.
  maxResults: integer, Maximum number of messages to return.
  includeSpamTrash: boolean, Include messages from SPAM and TRASH in the results.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
    "resultSizeEstimate": 42, # Estimated total number of results.
    "messages": [ # List of messages.
      { # An email message.
        "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
        "historyId": "A String", # The ID of the last history record that modified this message.
        "payload": { # A single MIME message part. # The parsed email structure in the message parts.
          "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
            "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
            "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
            "size": 42, # Total number of bytes in the body of the message part.
          },
          "mimeType": "A String", # The MIME type of the message part.
          "partId": "A String", # The immutable ID of the message part.
          "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
          "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
            {
              "name": "A String", # The name of the header before the : separator. For example, To.
              "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
            },
          ],
          "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
            # Object with schema name: MessagePart
          ],
        },
        "snippet": "A String", # A short part of the message text.
        "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
        "sizeEstimate": 42, # Estimated size in bytes of the message.
        "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
            # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
            # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
            # - The Subject headers must match.
        "labelIds": [ # List of IDs of labels applied to this message.
          "A String",
        ],
        "id": "A String", # The immutable ID of the message.
      },
    ],
  }
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.
modify(userId, id, body) 
Modifies the labels on the specified message.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the message to modify. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "removeLabelIds": [ # A list IDs of labels to remove from this message.
      "A String",
    ],
    "addLabelIds": [ # A list of IDs of labels to add to this message.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
send(userId, body=None, media_body=None) 
Sends the specified message to the recipients in the To, Cc, and Bcc headers.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # An email message.
  "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
  "historyId": "A String", # The ID of the last history record that modified this message.
  "payload": { # A single MIME message part. # The parsed email structure in the message parts.
    "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
      "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
      "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
      "size": 42, # Total number of bytes in the body of the message part.
    },
    "mimeType": "A String", # The MIME type of the message part.
    "partId": "A String", # The immutable ID of the message part.
    "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
    "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
      {
        "name": "A String", # The name of the header before the : separator. For example, To.
        "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
      },
    ],
    "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
      # Object with schema name: MessagePart
    ],
  },
  "snippet": "A String", # A short part of the message text.
  "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
  "sizeEstimate": 42, # Estimated size in bytes of the message.
  "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
      # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
      # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
      # - The Subject headers must match.
  "labelIds": [ # List of IDs of labels applied to this message.
    "A String",
  ],
  "id": "A String", # The immutable ID of the message.
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
trash(userId, id) 
Moves the specified message to the trash.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the message to Trash. (required)

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
untrash(userId, id) 
Removes the specified message from the trash.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the message to remove from Trash. (required)

Returns:
  An object of the form:

    { # An email message.
    "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
    "historyId": "A String", # The ID of the last history record that modified this message.
    "payload": { # A single MIME message part. # The parsed email structure in the message parts.
      "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
        "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
        "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
        "size": 42, # Total number of bytes in the body of the message part.
      },
      "mimeType": "A String", # The MIME type of the message part.
      "partId": "A String", # The immutable ID of the message part.
      "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
      "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
        {
          "name": "A String", # The name of the header before the : separator. For example, To.
          "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
        },
      ],
      "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
        # Object with schema name: MessagePart
      ],
    },
    "snippet": "A String", # A short part of the message text.
    "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
    "sizeEstimate": 42, # Estimated size in bytes of the message.
    "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
        # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
        # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
        # - The Subject headers must match.
    "labelIds": [ # List of IDs of labels applied to this message.
      "A String",
    ],
    "id": "A String", # The immutable ID of the message.
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.settings.filters.html000066400000000000000000000260401300622755700271260ustar00rootroot00000000000000

Gmail API . users . settings . filters

Instance Methods

create(userId, body)

Creates a filter.

delete(userId, id)

Deletes a filter.

get(userId, id)

Gets a filter.

list(userId)

Lists the message filters of a Gmail user.

Method Details

create(userId, body) 
Creates a filter.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
    "action": { # A set of actions to perform on a message. # Action that the filter performs.
      "forward": "A String", # Email address that the message should be forwarded to.
      "removeLabelIds": [ # List of labels to remove from the message.
        "A String",
      ],
      "addLabelIds": [ # List of labels to add to the message.
        "A String",
      ],
    },
    "id": "A String", # The server assigned ID of the filter.
    "criteria": { # Message matching criteria. # Matching criteria for the filter.
      "from": "A String", # The sender's display name or email address.
      "hasAttachment": True or False, # Whether the message has any attachment.
      "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
      "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
      "to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
      "query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
      "excludeChats": True or False, # Whether the response should exclude chats.
      "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
      "size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
    },
  }


Returns:
  An object of the form:

    { # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
      "action": { # A set of actions to perform on a message. # Action that the filter performs.
        "forward": "A String", # Email address that the message should be forwarded to.
        "removeLabelIds": [ # List of labels to remove from the message.
          "A String",
        ],
        "addLabelIds": [ # List of labels to add to the message.
          "A String",
        ],
      },
      "id": "A String", # The server assigned ID of the filter.
      "criteria": { # Message matching criteria. # Matching criteria for the filter.
        "from": "A String", # The sender's display name or email address.
        "hasAttachment": True or False, # Whether the message has any attachment.
        "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
        "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
        "to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
        "query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
        "excludeChats": True or False, # Whether the response should exclude chats.
        "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
        "size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
      },
    }
delete(userId, id) 
Deletes a filter.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  id: string, The ID of the filter to be deleted. (required)
get(userId, id) 
Gets a filter.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  id: string, The ID of the filter to be fetched. (required)

Returns:
  An object of the form:

    { # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
      "action": { # A set of actions to perform on a message. # Action that the filter performs.
        "forward": "A String", # Email address that the message should be forwarded to.
        "removeLabelIds": [ # List of labels to remove from the message.
          "A String",
        ],
        "addLabelIds": [ # List of labels to add to the message.
          "A String",
        ],
      },
      "id": "A String", # The server assigned ID of the filter.
      "criteria": { # Message matching criteria. # Matching criteria for the filter.
        "from": "A String", # The sender's display name or email address.
        "hasAttachment": True or False, # Whether the message has any attachment.
        "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
        "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
        "to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
        "query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
        "excludeChats": True or False, # Whether the response should exclude chats.
        "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
        "size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
      },
    }
list(userId) 
Lists the message filters of a Gmail user.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # Response for the ListFilters method.
    "filter": [ # List of a user's filters.
      { # Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
          "action": { # A set of actions to perform on a message. # Action that the filter performs.
            "forward": "A String", # Email address that the message should be forwarded to.
            "removeLabelIds": [ # List of labels to remove from the message.
              "A String",
            ],
            "addLabelIds": [ # List of labels to add to the message.
              "A String",
            ],
          },
          "id": "A String", # The server assigned ID of the filter.
          "criteria": { # Message matching criteria. # Matching criteria for the filter.
            "from": "A String", # The sender's display name or email address.
            "hasAttachment": True or False, # Whether the message has any attachment.
            "subject": "A String", # Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
            "sizeComparison": "A String", # How the message size in bytes should be in relation to the size field.
            "to": "A String", # The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.
            "query": "A String", # Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
            "excludeChats": True or False, # Whether the response should exclude chats.
            "negatedQuery": "A String", # Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
            "size": 42, # The size of the entire RFC822 message in bytes, including all headers and attachments.
          },
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.settings.forwardingAddresses.html000066400000000000000000000120041300622755700314510ustar00rootroot00000000000000

Gmail API . users . settings . forwardingAddresses

Instance Methods

create(userId, body)

Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted.

delete(userId, forwardingEmail)

Deletes the specified forwarding address and revokes any verification that may have been required.

get(userId, forwardingEmail)

Gets the specified forwarding address.

list(userId)

Lists the forwarding addresses for the specified account.

Method Details

create(userId, body) 
Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Settings for a forwarding address.
    "forwardingEmail": "A String", # An email address to which messages can be forwarded.
    "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
  }


Returns:
  An object of the form:

    { # Settings for a forwarding address.
      "forwardingEmail": "A String", # An email address to which messages can be forwarded.
      "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
    }
delete(userId, forwardingEmail) 
Deletes the specified forwarding address and revokes any verification that may have been required.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  forwardingEmail: string, The forwarding address to be deleted. (required)
get(userId, forwardingEmail) 
Gets the specified forwarding address.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  forwardingEmail: string, The forwarding address to be retrieved. (required)

Returns:
  An object of the form:

    { # Settings for a forwarding address.
      "forwardingEmail": "A String", # An email address to which messages can be forwarded.
      "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
    }
list(userId) 
Lists the forwarding addresses for the specified account.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # Response for the ListForwardingAddresses method.
    "forwardingAddresses": [ # List of addresses that may be used for forwarding.
      { # Settings for a forwarding address.
          "forwardingEmail": "A String", # An email address to which messages can be forwarded.
          "verificationStatus": "A String", # Indicates whether this address has been verified and is usable for forwarding. Read-only.
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.settings.html000066400000000000000000000347761300622755700254760ustar00rootroot00000000000000

Gmail API . users . settings

Instance Methods

filters()

Returns the filters Resource.

forwardingAddresses()

Returns the forwardingAddresses Resource.

sendAs()

Returns the sendAs Resource.

getAutoForwarding(userId)

Gets the auto-forwarding setting for the specified account.

getImap(userId)

Gets IMAP settings.

getPop(userId)

Gets POP settings.

getVacation(userId)

Gets vacation responder settings.

updateAutoForwarding(userId, body)

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.

updateImap(userId, body)

Updates IMAP settings.

updatePop(userId, body)

Updates POP settings.

updateVacation(userId, body)

Updates vacation responder settings.

Method Details

getAutoForwarding(userId) 
Gets the auto-forwarding setting for the specified account.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # Auto-forwarding settings for an account.
    "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
    "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
    "disposition": "A String", # The state that a message should be left in after it has been forwarded.
  }
getImap(userId) 
Gets IMAP settings.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # IMAP settings for an account.
      "autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
      "expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
      "enabled": True or False, # Whether IMAP is enabled for the account.
      "maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
    }
getPop(userId) 
Gets POP settings.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # POP settings for an account.
    "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
    "accessWindow": "A String", # The range of messages which are accessible via POP.
  }
getVacation(userId) 
Gets vacation responder settings.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. See  for more details.
      "responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
      "responseBodyPlainText": "A String", # Response body in plain text format.
      "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
      "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
      "startTime": "A String", # An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
      "endTime": "A String", # An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
      "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
      "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
    }
updateAutoForwarding(userId, body) 
Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Auto-forwarding settings for an account.
  "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
  "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
  "disposition": "A String", # The state that a message should be left in after it has been forwarded.
}


Returns:
  An object of the form:

    { # Auto-forwarding settings for an account.
    "enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.
    "emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
    "disposition": "A String", # The state that a message should be left in after it has been forwarded.
  }
updateImap(userId, body) 
Updates IMAP settings.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # IMAP settings for an account.
    "autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
    "expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
    "enabled": True or False, # Whether IMAP is enabled for the account.
    "maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
  }


Returns:
  An object of the form:

    { # IMAP settings for an account.
      "autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
      "expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
      "enabled": True or False, # Whether IMAP is enabled for the account.
      "maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
    }
updatePop(userId, body) 
Updates POP settings.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # POP settings for an account.
  "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
  "accessWindow": "A String", # The range of messages which are accessible via POP.
}


Returns:
  An object of the form:

    { # POP settings for an account.
    "disposition": "A String", # The action that will be executed on a message after it has been fetched via POP.
    "accessWindow": "A String", # The range of messages which are accessible via POP.
  }
updateVacation(userId, body) 
Updates vacation responder settings.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. See  for more details.
    "responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
    "responseBodyPlainText": "A String", # Response body in plain text format.
    "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
    "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
    "startTime": "A String", # An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
    "endTime": "A String", # An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
    "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
    "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
  }


Returns:
  An object of the form:

    { # Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. See  for more details.
      "responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
      "responseBodyPlainText": "A String", # Response body in plain text format.
      "restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
      "enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.
      "startTime": "A String", # An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
      "endTime": "A String", # An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
      "responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before storing it.
      "restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.
    }
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.settings.sendAs.html000066400000000000000000000773571300622755700267140ustar00rootroot00000000000000

Gmail API . users . settings . sendAs

Instance Methods

create(userId, body)

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

delete(userId, sendAsEmail)

Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

get(userId, sendAsEmail)

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

list(userId)

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

patch(userId, sendAsEmail, body)

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.

update(userId, sendAsEmail, body)

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

verify(userId, sendAsEmail)

Sends a verification email to the specified send-as alias address. The verification status must be pending.

Method Details

create(userId, body) 
Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
  "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
    "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
    "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    "host": "A String", # The hostname of the SMTP service. Required.
    "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    "port": 42, # The port of the SMTP service. Required.
  },
  "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
  "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
  "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
  "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
  "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
  "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
  "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
  "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
}


Returns:
  An object of the form:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
    "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
      "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
      "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "host": "A String", # The hostname of the SMTP service. Required.
      "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "port": 42, # The port of the SMTP service. Required.
    },
    "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
    "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
    "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
    "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
    "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
    "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
    "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
    "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
  }
delete(userId, sendAsEmail) 
Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The send-as alias to be deleted. (required)
get(userId, sendAsEmail) 
Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The send-as alias to be retrieved. (required)

Returns:
  An object of the form:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
    "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
      "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
      "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "host": "A String", # The hostname of the SMTP service. Required.
      "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "port": 42, # The port of the SMTP service. Required.
    },
    "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
    "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
    "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
    "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
    "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
    "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
    "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
    "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
  }
list(userId) 
Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

Returns:
  An object of the form:

    { # Response for the ListSendAs method.
    "sendAs": [ # List of send-as aliases.
      { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
        "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
          "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
          "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
          "host": "A String", # The hostname of the SMTP service. Required.
          "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
          "port": 42, # The port of the SMTP service. Required.
        },
        "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
        "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
        "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
        "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
        "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
        "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
        "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
        "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
      },
    ],
  }
patch(userId, sendAsEmail, body) 
Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The send-as alias to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
  "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
    "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
    "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    "host": "A String", # The hostname of the SMTP service. Required.
    "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    "port": 42, # The port of the SMTP service. Required.
  },
  "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
  "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
  "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
  "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
  "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
  "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
  "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
  "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
}


Returns:
  An object of the form:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
    "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
      "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
      "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "host": "A String", # The hostname of the SMTP service. Required.
      "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "port": 42, # The port of the SMTP service. Required.
    },
    "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
    "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
    "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
    "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
    "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
    "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
    "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
    "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
  }
update(userId, sendAsEmail, body) 
Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The send-as alias to be updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
  "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
    "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
    "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    "host": "A String", # The hostname of the SMTP service. Required.
    "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    "port": 42, # The port of the SMTP service. Required.
  },
  "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
  "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
  "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
  "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
  "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
  "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
  "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
  "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
}


Returns:
  An object of the form:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. See  for more details.
    "smtpMsa": { # Configuration for communication with an SMTP service. # An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
      "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
      "username": "A String", # The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "host": "A String", # The hostname of the SMTP service. Required.
      "password": "A String", # The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
      "port": 42, # The port of the SMTP service. Required.
    },
    "displayName": "A String", # A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
    "replyToAddress": "A String", # An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
    "signature": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
    "treatAsAlias": True or False, # Whether Gmail should treat this address as an alias for the user's primary email address. See  for more details. This setting only applies to custom "from" aliases.
    "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
    "isPrimary": True or False, # Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
    "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
    "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
  }
verify(userId, sendAsEmail) 
Sends a verification email to the specified send-as alias address. The verification status must be pending.

Args:
  userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The send-as alias to be verified. (required)
google-api-python-client-1.5.5/docs/dyn/gmail_v1.users.threads.html000066400000000000000000000616051300622755700252570ustar00rootroot00000000000000

Gmail API . users . threads

Instance Methods

delete(userId, id)

Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.

get(userId, id, format=None, metadataHeaders=None)

Gets the specified thread.

list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None)

Lists the threads in the user's mailbox.

list_next(previous_request, previous_response)

Retrieves the next page of results.

modify(userId, id, body)

Modifies the labels applied to the thread. This applies to all messages in the thread.

trash(userId, id)

Moves the specified thread to the trash.

untrash(userId, id)

Removes the specified thread from the trash.

Method Details

delete(userId, id) 
Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, ID of the Thread to delete. (required)
get(userId, id, format=None, metadataHeaders=None) 
Gets the specified thread.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the thread to retrieve. (required)
  format: string, The format to return the messages in.
    Allowed values
      full - 
      metadata - 
      minimal - 
  metadataHeaders: string, When given and format is METADATA, only include headers specified. (repeated)

Returns:
  An object of the form:

    { # A collection of messages representing a conversation.
    "snippet": "A String", # A short part of the message text.
    "messages": [ # The list of messages in the thread.
      { # An email message.
        "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
        "historyId": "A String", # The ID of the last history record that modified this message.
        "payload": { # A single MIME message part. # The parsed email structure in the message parts.
          "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
            "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
            "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
            "size": 42, # Total number of bytes in the body of the message part.
          },
          "mimeType": "A String", # The MIME type of the message part.
          "partId": "A String", # The immutable ID of the message part.
          "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
          "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
            {
              "name": "A String", # The name of the header before the : separator. For example, To.
              "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
            },
          ],
          "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
            # Object with schema name: MessagePart
          ],
        },
        "snippet": "A String", # A short part of the message text.
        "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
        "sizeEstimate": 42, # Estimated size in bytes of the message.
        "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
            # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
            # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
            # - The Subject headers must match.
        "labelIds": [ # List of IDs of labels applied to this message.
          "A String",
        ],
        "id": "A String", # The immutable ID of the message.
      },
    ],
    "id": "A String", # The unique ID of the thread.
    "historyId": "A String", # The ID of the last history record that modified this thread.
  }
list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None) 
Lists the threads in the user's mailbox.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  labelIds: string, Only return threads with labels that match all of the specified label IDs. (repeated)
  q: string, Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
  pageToken: string, Page token to retrieve a specific page of results in the list.
  maxResults: integer, Maximum number of threads to return.
  includeSpamTrash: boolean, Include threads from SPAM and TRASH in the results.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
    "resultSizeEstimate": 42, # Estimated total number of results.
    "threads": [ # List of threads.
      { # A collection of messages representing a conversation.
        "snippet": "A String", # A short part of the message text.
        "messages": [ # The list of messages in the thread.
          { # An email message.
            "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
            "historyId": "A String", # The ID of the last history record that modified this message.
            "payload": { # A single MIME message part. # The parsed email structure in the message parts.
              "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
                "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
                "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
                "size": 42, # Total number of bytes in the body of the message part.
              },
              "mimeType": "A String", # The MIME type of the message part.
              "partId": "A String", # The immutable ID of the message part.
              "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
              "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
                {
                  "name": "A String", # The name of the header before the : separator. For example, To.
                  "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
                },
              ],
              "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
                # Object with schema name: MessagePart
              ],
            },
            "snippet": "A String", # A short part of the message text.
            "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
            "sizeEstimate": 42, # Estimated size in bytes of the message.
            "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
                # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
                # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
                # - The Subject headers must match.
            "labelIds": [ # List of IDs of labels applied to this message.
              "A String",
            ],
            "id": "A String", # The immutable ID of the message.
          },
        ],
        "id": "A String", # The unique ID of the thread.
        "historyId": "A String", # The ID of the last history record that modified this thread.
      },
    ],
  }
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.
modify(userId, id, body) 
Modifies the labels applied to the thread. This applies to all messages in the thread.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the thread to modify. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "removeLabelIds": [ # A list of IDs of labels to remove from this thread.
      "A String",
    ],
    "addLabelIds": [ # A list of IDs of labels to add to this thread.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # A collection of messages representing a conversation.
    "snippet": "A String", # A short part of the message text.
    "messages": [ # The list of messages in the thread.
      { # An email message.
        "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
        "historyId": "A String", # The ID of the last history record that modified this message.
        "payload": { # A single MIME message part. # The parsed email structure in the message parts.
          "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
            "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
            "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
            "size": 42, # Total number of bytes in the body of the message part.
          },
          "mimeType": "A String", # The MIME type of the message part.
          "partId": "A String", # The immutable ID of the message part.
          "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
          "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
            {
              "name": "A String", # The name of the header before the : separator. For example, To.
              "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
            },
          ],
          "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
            # Object with schema name: MessagePart
          ],
        },
        "snippet": "A String", # A short part of the message text.
        "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
        "sizeEstimate": 42, # Estimated size in bytes of the message.
        "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
            # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
            # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
            # - The Subject headers must match.
        "labelIds": [ # List of IDs of labels applied to this message.
          "A String",
        ],
        "id": "A String", # The immutable ID of the message.
      },
    ],
    "id": "A String", # The unique ID of the thread.
    "historyId": "A String", # The ID of the last history record that modified this thread.
  }
trash(userId, id) 
Moves the specified thread to the trash.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the thread to Trash. (required)

Returns:
  An object of the form:

    { # A collection of messages representing a conversation.
    "snippet": "A String", # A short part of the message text.
    "messages": [ # The list of messages in the thread.
      { # An email message.
        "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
        "historyId": "A String", # The ID of the last history record that modified this message.
        "payload": { # A single MIME message part. # The parsed email structure in the message parts.
          "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
            "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
            "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
            "size": 42, # Total number of bytes in the body of the message part.
          },
          "mimeType": "A String", # The MIME type of the message part.
          "partId": "A String", # The immutable ID of the message part.
          "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
          "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
            {
              "name": "A String", # The name of the header before the : separator. For example, To.
              "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
            },
          ],
          "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
            # Object with schema name: MessagePart
          ],
        },
        "snippet": "A String", # A short part of the message text.
        "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
        "sizeEstimate": 42, # Estimated size in bytes of the message.
        "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
            # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
            # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
            # - The Subject headers must match.
        "labelIds": [ # List of IDs of labels applied to this message.
          "A String",
        ],
        "id": "A String", # The immutable ID of the message.
      },
    ],
    "id": "A String", # The unique ID of the thread.
    "historyId": "A String", # The ID of the last history record that modified this thread.
  }
untrash(userId, id) 
Removes the specified thread from the trash.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  id: string, The ID of the thread to remove from Trash. (required)

Returns:
  An object of the form:

    { # A collection of messages representing a conversation.
    "snippet": "A String", # A short part of the message text.
    "messages": [ # The list of messages in the thread.
      { # An email message.
        "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.
        "historyId": "A String", # The ID of the last history record that modified this message.
        "payload": { # A single MIME message part. # The parsed email structure in the message parts.
          "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
            "data": "A String", # The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
            "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
            "size": 42, # Total number of bytes in the body of the message part.
          },
          "mimeType": "A String", # The MIME type of the message part.
          "partId": "A String", # The immutable ID of the message part.
          "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
          "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.
            {
              "name": "A String", # The name of the header before the : separator. For example, To.
              "value": "A String", # The value of the header after the : separator. For example, someuser@example.com.
            },
          ],
          "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.
            # Object with schema name: MessagePart
          ],
        },
        "snippet": "A String", # A short part of the message text.
        "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.
        "sizeEstimate": 42, # Estimated size in bytes of the message.
        "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:
            # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
            # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
            # - The Subject headers must match.
        "labelIds": [ # List of IDs of labels applied to this message.
          "A String",
        ],
        "id": "A String", # The immutable ID of the message.
      },
    ],
    "id": "A String", # The unique ID of the thread.
    "historyId": "A String", # The ID of the last history record that modified this thread.
  }
google-api-python-client-1.5.5/docs/dyn/groupsmigration_v1.archive.html000066400000000000000000000035241300622755700262420ustar00rootroot00000000000000

Groups Migration API . archive

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.
  }
google-api-python-client-1.5.5/docs/dyn/groupsmigration_v1.html000066400000000000000000000041401300622755700246150ustar00rootroot00000000000000

Groups Migration API

Instance Methods

archive()

Returns the archive Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/groupssettings_v1.groups.html000066400000000000000000000470051300622755700260110ustar00rootroot00000000000000

Groups Settings API . groups

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. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
      "includeCustomFooter": "A String", # Whether to include custom footer.
      "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
      "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
      "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.
      "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
      "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
      "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
      "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
      "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
      "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
      "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
      "kind": "groupsSettings#groups", # The type of the resource.
      "name": "A String", # Name of the Group
      "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. Possible 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.
      "customFooterText": "A String", # Custom footer text.
      "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. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
    "includeCustomFooter": "A String", # Whether to include custom footer.
    "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
    "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
    "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.
    "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
    "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
    "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
    "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
    "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
    "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
    "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
    "kind": "groupsSettings#groups", # The type of the resource.
    "name": "A String", # Name of the Group
    "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. Possible 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.
    "customFooterText": "A String", # Custom footer text.
    "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. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
      "includeCustomFooter": "A String", # Whether to include custom footer.
      "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
      "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
      "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.
      "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
      "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
      "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
      "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
      "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
      "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
      "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
      "kind": "groupsSettings#groups", # The type of the resource.
      "name": "A String", # Name of the Group
      "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. Possible 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.
      "customFooterText": "A String", # Custom footer text.
      "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. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
    "includeCustomFooter": "A String", # Whether to include custom footer.
    "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
    "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
    "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.
    "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
    "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
    "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
    "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
    "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
    "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
    "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
    "kind": "groupsSettings#groups", # The type of the resource.
    "name": "A String", # Name of the Group
    "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. Possible 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.
    "customFooterText": "A String", # Custom footer text.
    "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. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
      "includeCustomFooter": "A String", # Whether to include custom footer.
      "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
      "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
      "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.
      "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
      "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
      "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
      "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
      "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
      "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
      "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
      "kind": "groupsSettings#groups", # The type of the resource.
      "name": "A String", # Name of the Group
      "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. Possible 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.
      "customFooterText": "A String", # Custom footer text.
      "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
    }
google-api-python-client-1.5.5/docs/dyn/groupssettings_v1.html000066400000000000000000000041321300622755700244650ustar00rootroot00000000000000

Groups Settings API

Instance Methods

groups()

Returns the groups Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/iam_v1.html000066400000000000000000000043601300622755700221360ustar00rootroot00000000000000

Google Identity and Access Management (IAM) API

Instance Methods

projects()

Returns the projects Resource.

roles()

Returns the roles Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/iam_v1.projects.html000066400000000000000000000024031300622755700237620ustar00rootroot00000000000000

Google Identity and Access Management (IAM) API . projects

Instance Methods

serviceAccounts()

Returns the serviceAccounts Resource.

google-api-python-client-1.5.5/docs/dyn/iam_v1.projects.serviceAccounts.html000066400000000000000000000754001300622755700271300ustar00rootroot00000000000000

Google Identity and Access Management (IAM) API . projects . serviceAccounts

Instance Methods

keys()

Returns the keys Resource.

create(name, body, x__xgafv=None)

Creates a ServiceAccount and returns it.

delete(name, x__xgafv=None)

Deletes a ServiceAccount.

get(name, x__xgafv=None)

Gets a ServiceAccount.

getIamPolicy(resource, x__xgafv=None)

Returns the IAM access control policy for a ServiceAccount.

list(name, pageToken=None, x__xgafv=None, pageSize=None)

Lists ServiceAccounts for a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource, body, x__xgafv=None)

Sets the IAM access control policy for a ServiceAccount.

signBlob(name, body, x__xgafv=None)

Signs a blob using a service account's system-managed private key.

testIamPermissions(resource, body, x__xgafv=None)

Tests the specified permissions against the IAM access control policy for a ServiceAccount.

update(name, body, x__xgafv=None)

Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` . The `etag` is mandatory.

Method Details

create(name, body, x__xgafv=None) 
Creates a ServiceAccount and returns it.

Args:
  name: string, Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The service account create request.
    "serviceAccount": { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. # The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` .
      "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
      "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
      "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
      "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
      "etag": "A String", # Used to perform a consistent read-modify-write.
      "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
      "email": "A String", # @OutputOnly The email address of the service account.
    },
    "accountId": "A String", # Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
    "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
    "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
    "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
    "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
    "etag": "A String", # Used to perform a consistent read-modify-write.
    "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
    "email": "A String", # @OutputOnly The email address of the service account.
  }
delete(name, x__xgafv=None) 
Deletes a ServiceAccount.

Args:
  name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets a ServiceAccount.

Args:
  name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
    "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
    "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
    "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
    "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
    "etag": "A String", # Used to perform a consistent read-modify-write.
    "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
    "email": "A String", # @OutputOnly The email address of the service account.
  }
getIamPolicy(resource, x__xgafv=None) 
Returns the IAM access control policy for a ServiceAccount.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(name, pageToken=None, x__xgafv=None, pageSize=None) 
Lists ServiceAccounts for a project.

Args:
  name: string, Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. (required)
  pageToken: string, Optional pagination token returned in an earlier ListServiceAccountsResponse.next_page_token.
  x__xgafv: string, V1 error format.
  pageSize: integer, Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the ListServiceAccountsResponse.next_page_token in a subsequent request.

Returns:
  An object of the form:

    { # The service account list response.
    "nextPageToken": "A String", # To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value.
    "accounts": [ # The list of matching service accounts.
      { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
        "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
        "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
        "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
        "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
        "etag": "A String", # Used to perform a consistent read-modify-write.
        "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
        "email": "A String", # @OutputOnly The email address of the service account.
      },
    ],
  }
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.
setIamPolicy(resource, body, x__xgafv=None) 
Sets the IAM access control policy for a ServiceAccount.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
signBlob(name, body, x__xgafv=None) 
Signs a blob using a service account's system-managed private key.

Args:
  name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The service account sign blob request.
    "bytesToSign": "A String", # The bytes to sign.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The service account sign blob response.
    "keyId": "A String", # The id of the key used to sign the blob.
    "signature": "A String", # The signed blob.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Tests the specified permissions against the IAM access control policy for a ServiceAccount.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
update(name, body, x__xgafv=None) 
Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` . The `etag` is mandatory.

Args:
  name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
  "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
  "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
  "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
  "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
  "etag": "A String", # Used to perform a consistent read-modify-write.
  "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
  "email": "A String", # @OutputOnly The email address of the service account.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in util::Status's ResourceInfo.resource_name in the format of projects/{project}/serviceAccounts/{email}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account.
    "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
    "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
    "name": "A String", # The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Requests using `-` as a wildcard for the project will infer the project from the `account` and the `account` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{project}/serviceAccounts/{email}`.
    "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
    "etag": "A String", # Used to perform a consistent read-modify-write.
    "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
    "email": "A String", # @OutputOnly The email address of the service account.
  }
google-api-python-client-1.5.5/docs/dyn/iam_v1.projects.serviceAccounts.keys.html000066400000000000000000000235041300622755700301000ustar00rootroot00000000000000

Google Identity and Access Management (IAM) API . projects . serviceAccounts . keys

Instance Methods

create(name, body, x__xgafv=None)

Creates a ServiceAccountKey and returns it.

delete(name, x__xgafv=None)

Deletes a ServiceAccountKey.

get(name, publicKeyType=None, x__xgafv=None)

Gets the ServiceAccountKey by key id.

list(name, keyTypes=None, x__xgafv=None)

Lists ServiceAccountKeys.

Method Details

create(name, body, x__xgafv=None) 
Creates a ServiceAccountKey and returns it.

Args:
  name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The service account key create request.
    "privateKeyType": "A String", # The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the default output format.
    "keyAlgorithm": "A String", # Which type of key and algorithm to use for the key. The default is currently a 4K RSA key. However this may change in the future.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
    "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
    "validAfterTime": "A String", # The key can be used after this timestamp.
    "validBeforeTime": "A String", # The key can be used before this timestamp.
    "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
    "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
    "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
    "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
  }
delete(name, x__xgafv=None) 
Deletes a ServiceAccountKey.

Args:
  name: string, The resource name of the service account key in the following format: `projects/{project}/serviceAccounts/{account}/keys/{key}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, publicKeyType=None, x__xgafv=None) 
Gets the ServiceAccountKey by key id.

Args:
  name: string, The resource name of the service account key in the following format: `projects/{project}/serviceAccounts/{account}/keys/{key}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  publicKeyType: string, The output format of the public key requested. X509_PEM is the default output format.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
    "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
    "validAfterTime": "A String", # The key can be used after this timestamp.
    "validBeforeTime": "A String", # The key can be used before this timestamp.
    "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
    "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
    "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
    "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
  }
list(name, keyTypes=None, x__xgafv=None) 
Lists ServiceAccountKeys.

Args:
  name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project, will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
  keyTypes: string, Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned. (repeated)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The service account keys list response.
    "keys": [ # The public keys for the service account.
      { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
        "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
        "validAfterTime": "A String", # The key can be used after this timestamp.
        "validBeforeTime": "A String", # The key can be used before this timestamp.
        "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
        "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
        "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
        "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/iam_v1.roles.html000066400000000000000000000056041300622755700232630ustar00rootroot00000000000000

Google Identity and Access Management (IAM) API . roles

Instance Methods

queryGrantableRoles(body, x__xgafv=None)

Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.

Method Details

queryGrantableRoles(body, x__xgafv=None) 
Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The grantable role query request.
    "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The grantable role query response.
    "roles": [ # The list of matching roles.
      { # A role in the Identity and Access Management API.
        "description": "A String", # Optional. A human-readable description for the role.
        "name": "A String", # The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/{organization-id}/roles/logging.viewer for custom roles.
        "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/identitytoolkit_v3.html000066400000000000000000000041661300622755700246350ustar00rootroot00000000000000

Google Identity Toolkit API

Instance Methods

relyingparty()

Returns the relyingparty Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/identitytoolkit_v3.relyingparty.html000066400000000000000000001154451300622755700273700ustar00rootroot00000000000000

Google Identity Toolkit API . relyingparty

Instance Methods

createAuthUri(body)

Creates the URI used by the IdP to authenticate the user.

deleteAccount(body)

Delete user account.

downloadAccount(body)

Batch download user accounts.

getAccountInfo(body)

Returns the account info.

getOobConfirmationCode(body)

Get a code for user action confirmation.

getProjectConfig(delegatedProjectNumber=None, projectNumber=None)

Get project configuration.

getPublicKeys()

Get token signing public key.

getRecaptchaParam()

Get recaptcha secure param.

resetPassword(body)

Reset password for a user.

setAccountInfo(body)

Set account info for a user.

setProjectConfig(body)

Set project configuration.

signOutUser(body)

Sign out user.

signupNewUser(body)

Signup new user.

uploadAccount(body)

Batch upload existing user accounts.

verifyAssertion(body)

Verifies the assertion returned by the IdP.

verifyCustomToken(body)

Verifies the developer asserted ID token.

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.
    "sessionId": "A String", # The session_id passed by client.
    "hostedDomain": "A String", # The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
    "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.
    "oauthConsumerKey": "A String", # The developer's consumer key for OpenId OAuth Extension
    "clientId": "A String", # The relying party OAuth client ID.
    "oauthScope": "A String", # Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
    "otaApp": "A String", # The native app package for OTA installation.
    "authFlowType": "A String", # Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.
    "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.
    "appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
    "continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow.
    "customParameter": { # The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token.
      "a_key": "A String", # The customized query parameter.
    },
    "identifier": "A String", # The email or federated ID of the user.
  }


Returns:
  An object of the form:

    { # Response of creating the IDP authentication URL.
    "sessionId": "A String", # Session ID which should be passed in the following verifyAssertion request.
    "kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse".
    "captchaRequired": True or False, # True if captcha is required.
    "registered": True or False, # Whether the user is registered if the identifier is an email.
    "allProviders": [ # all providers the user has once used to do federated login
      "A String",
    ],
    "forExistingProvider": True or False, # True if the authUri is for user's existing provider.
    "providerId": "A String", # The provider ID of the auth URI.
    "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.
    "idToken": "A String", # The GITKit token or STS id token of the authenticated user.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "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".
  }
downloadAccount(body) 
Batch download user accounts.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to download user account in batch.
    "nextPageToken": "A String", # The token for the next page. This should be taken from the previous response.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "maxResults": 42, # The max number of results to return in the response.
  }


Returns:
  An object of the form:

    { # Respone of downloading accounts in batch.
    "nextPageToken": "A String", # The next page token. To be used in a subsequent request to return the next page of results.
    "kind": "identitytoolkit#DownloadAccountResponse", # The fixed string "identitytoolkit#DownloadAccountResponse".
    "users": [ # The user accounts data.
      { # Template for an individual account info.
        "passwordHash": "A String", # The user's hashed password.
        "displayName": "A String", # The name of the user.
        "localId": "A String", # The local ID of the user.
        "validSince": "A String", # Timestamp in seconds for valid login token.
        "photoUrl": "A String", # The URL of the user profile photo.
        "emailVerified": True or False, # Whether the email has been verified.
        "lastLoginAt": "A String", # last login timestamp.
        "customAuth": True or False, # Whether the user is authenticated by the developer.
        "disabled": True or False, # Whether the user is disabled.
        "version": 42, # Version of the user's password.
        "providerUserInfo": [ # The IDP of the user.
          {
            "federatedId": "A String", # User's identifier at IDP.
            "displayName": "A String", # The user's display name at the IDP.
            "photoUrl": "A String", # The user's photo url at the IDP.
            "rawUserInfo": "A String", # Raw IDP-returned user info.
            "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.
            "rawId": "A String", # User's raw identifier directly returned from IDP.
            "email": "A String", # User's email at IDP.
            "screenName": "A String", # User's screen name at Twitter or login name at Github.
          },
        ],
        "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
        "salt": "A String", # The user's password salt.
        "email": "A String", # The email of the user.
        "createdAt": "A String", # User creation timestamp.
        "screenName": "A String", # User's screen name at Twitter or login name at Github.
      },
    ],
  }
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.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "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.
      { # Template for an individual account info.
        "passwordHash": "A String", # The user's hashed password.
        "displayName": "A String", # The name of the user.
        "localId": "A String", # The local ID of the user.
        "validSince": "A String", # Timestamp in seconds for valid login token.
        "photoUrl": "A String", # The URL of the user profile photo.
        "emailVerified": True or False, # Whether the email has been verified.
        "lastLoginAt": "A String", # last login timestamp.
        "customAuth": True or False, # Whether the user is authenticated by the developer.
        "disabled": True or False, # Whether the user is disabled.
        "version": 42, # Version of the user's password.
        "providerUserInfo": [ # The IDP of the user.
          {
            "federatedId": "A String", # User's identifier at IDP.
            "displayName": "A String", # The user's display name at the IDP.
            "photoUrl": "A String", # The user's photo url at the IDP.
            "rawUserInfo": "A String", # Raw IDP-returned user info.
            "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.
            "rawId": "A String", # User's raw identifier directly returned from IDP.
            "email": "A String", # User's email at IDP.
            "screenName": "A String", # User's screen name at Twitter or login name at Github.
          },
        ],
        "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
        "salt": "A String", # The user's password salt.
        "email": "A String", # The email of the user.
        "createdAt": "A String", # User creation timestamp.
        "screenName": "A String", # User's screen name at Twitter or login name at Github.
      },
    ],
  }
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.
    "email": "A String", # The email address that the email is sent to.
  }
getProjectConfig(delegatedProjectNumber=None, projectNumber=None) 
Get project configuration.

Args:
  delegatedProjectNumber: string, Delegated GCP project number of the request.
  projectNumber: string, GCP project number of the request.

Returns:
  An object of the form:

    { # Response of getting the project configuration.
    "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
    "useEmailSending": True or False, # Whether to use email sending provided by Firebear.
    "projectId": "A String", # Project ID of the relying party.
    "enableAnonymousUser": True or False, # Whether anonymous user is enabled.
    "authorizedDomains": [ # Authorized domains.
      "A String",
    ],
    "resetPasswordTemplate": { # Template for an email template. # Reset password email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "verifyEmailTemplate": { # Template for an email template. # Verify email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
    "changeEmailTemplate": { # Template for an email template. # Change email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "idpConfig": [ # OAuth2 provider configuration.
      { # Template for a single idp configuration.
        "whitelistedAudiences": [ # Whitelisted client IDs for audience check.
          "A String",
        ],
        "enabled": True or False, # Whether this IDP is enabled.
        "clientId": "A String", # OAuth2 client ID.
        "secret": "A String", # OAuth2 client secret.
        "provider": "A String", # OAuth2 provider.
        "experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.
      },
    ],
  }
getPublicKeys() 
Get token signing public key.

Args:

Returns:
  An object of the form:

    { # Respone of getting public keys.
    "a_key": "A String",
  }
getRecaptchaParam() 
Get recaptcha secure param.

Args:

Returns:
  An object of the form:

    { # Response of getting recaptcha param.
    "kind": "identitytoolkit#GetRecaptchaParamResponse", # The fixed string "identitytoolkit#GetRecaptchaParamResponse".
    "recaptchaSiteKey": "A String", # Site key registered at recaptcha.
    "recaptchaStoken": "A String", # The stoken field for the recaptcha widget, used to request captcha challenge.
  }
resetPassword(body) 
Reset password 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.
    "requestType": "A String", # The request type.
    "kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".
    "email": "A String", # The user's email. If the out-of-band code is for email recovery, the user's original email.
    "newEmail": "A String", # If the out-of-band code is for email recovery, the user's new 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.
    "instanceId": "A String", # Instance id token of the app.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "deleteAttribute": [ # The attributes users request to delete.
      "A String",
    ],
    "localId": "A String", # The local ID of the user.
    "validSince": "A String", # Timestamp in seconds for valid login token.
    "photoUrl": "A String", # The photo url of the user.
    "captchaResponse": "A String", # Response to the captcha.
    "emailVerified": True or False, # Mark the email as verified or not.
    "lastLoginAt": "A String", # Last login timestamp.
    "provider": [ # The associated IDPs of the user.
      "A String",
    ],
    "disableUser": True or False, # Whether to disable the user.
    "deleteProvider": [ # The IDPs the user request to delete.
      "A String",
    ],
    "captchaChallenge": "A String", # The captcha challenge.
    "oobCode": "A String", # The out-of-band code of the change email request.
    "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
    "idToken": "A String", # The GITKit token of the authenticated user.
    "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
    "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.
    "createdAt": "A String", # The timestamp when the account is created.
  }


Returns:
  An object of the form:

    { # Respone of setting the account information.
    "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
    "kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".
    "displayName": "A String", # The name of the user.
    "localId": "A String", # The local ID of the user.
    "photoUrl": "A String", # The photo url of the user.
    "idToken": "A String", # The Gitkit id token to login the newly sign up user.
    "passwordHash": "A String", # The user's hashed password.
    "newEmail": "A String", # The new email the user attempts to change to.
    "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
    "providerUserInfo": [ # The user's profiles at the associated IdPs.
      {
        "federatedId": "A String", # User's identifier at IDP.
        "providerId": "A String", # The IdP ID. For whitelisted 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.
      },
    ],
    "email": "A String", # The email of the user.
  }
setProjectConfig(body) 
Set project configuration.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to set the project configuration.
    "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
    "useEmailSending": True or False, # Whether to use email sending provided by Firebear.
    "verifyEmailTemplate": { # Template for an email template. # Verify email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "enableAnonymousUser": True or False, # Whether to enable anonymous user.
    "authorizedDomains": [ # Authorized domains for widget redirect.
      "A String",
    ],
    "resetPasswordTemplate": { # Template for an email template. # Reset password email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
    "changeEmailTemplate": { # Template for an email template. # Change email template.
      "body": "A String", # Email body.
      "fromDisplayName": "A String", # From display name.
      "from": "A String", # From address of the email.
      "format": "A String", # Email body format.
      "replyTo": "A String", # Reply-to address.
      "subject": "A String", # Subject of the email.
    },
    "idpConfig": [ # Oauth2 provider configuration.
      { # Template for a single idp configuration.
        "whitelistedAudiences": [ # Whitelisted client IDs for audience check.
          "A String",
        ],
        "enabled": True or False, # Whether this IDP is enabled.
        "clientId": "A String", # OAuth2 client ID.
        "secret": "A String", # OAuth2 client secret.
        "provider": "A String", # OAuth2 provider.
        "experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.
      },
    ],
  }


Returns:
  An object of the form:

    { # Response of setting the project configuration.
    "projectId": "A String", # Project ID of the relying party.
  }
signOutUser(body) 
Sign out user.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to sign out user.
    "instanceId": "A String", # Instance id token of the app.
    "localId": "A String", # The local ID of the user.
  }


Returns:
  An object of the form:

    { # Response of signing out user.
    "localId": "A String", # The local ID of the user.
  }
signupNewUser(body) 
Signup new user.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to signup new user, create anonymous user or anonymous user reauth.
    "instanceId": "A String", # Instance id token of the app.
    "displayName": "A String", # The name of the user.
    "captchaResponse": "A String", # Response to the captcha.
    "idToken": "A String", # The GITKit token of the authenticated user.
    "captchaChallenge": "A String", # The captcha challenge.
    "password": "A String", # The new password of the user.
    "email": "A String", # The email of the user.
  }


Returns:
  An object of the form:

    { # Response of signing up new user, creating anonymous user or anonymous user reauth.
    "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
    "kind": "identitytoolkit#SignupNewUserResponse", # The fixed string "identitytoolkit#SignupNewUserResponse".
    "displayName": "A String", # The name of the user.
    "localId": "A String", # The RP local ID of the user.
    "idToken": "A String", # The Gitkit id token to login the newly sign up user.
    "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
    "email": "A String", # The email of the user.
  }
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", # The password hash algorithm.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "users": [ # The account info to be stored.
      { # Template for an individual account info.
        "passwordHash": "A String", # The user's hashed password.
        "displayName": "A String", # The name of the user.
        "localId": "A String", # The local ID of the user.
        "validSince": "A String", # Timestamp in seconds for valid login token.
        "photoUrl": "A String", # The URL of the user profile photo.
        "emailVerified": True or False, # Whether the email has been verified.
        "lastLoginAt": "A String", # last login timestamp.
        "customAuth": True or False, # Whether the user is authenticated by the developer.
        "disabled": True or False, # Whether the user is disabled.
        "version": 42, # Version of the user's password.
        "providerUserInfo": [ # The IDP of the user.
          {
            "federatedId": "A String", # User's identifier at IDP.
            "displayName": "A String", # The user's display name at the IDP.
            "photoUrl": "A String", # The user's photo url at the IDP.
            "rawUserInfo": "A String", # Raw IDP-returned user info.
            "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.
            "rawId": "A String", # User's raw identifier directly returned from IDP.
            "email": "A String", # User's email at IDP.
            "screenName": "A String", # User's screen name at Twitter or login name at Github.
          },
        ],
        "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
        "salt": "A String", # The user's password salt.
        "email": "A String", # The email of the user.
        "createdAt": "A String", # User creation timestamp.
        "screenName": "A String", # User's screen name at Twitter or login name at Github.
      },
    ],
    "sanityCheck": True or False, # If true, backend will do sanity check(including duplicate email and federated id) when uploading account.
    "signerKey": "A String", # The key for to hash the password.
    "memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.
    "saltSeparator": "A String", # The salt separator.
    "targetProjectId": "A String", # Specify which project (field value is actually project id) to operate. Only used when provided credential.
    "rounds": 42, # Rounds for hash calculation. Used by scrypt and similar algorithms.
  }


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.
    "postBody": "A String", # The post body if the request is a HTTP POST.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "instanceId": "A String", # Instance id token of the app.
    "idToken": "A String", # The GITKit token of the authenticated user.
    "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
    "sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request.
    "requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
    "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
    "returnRefreshToken": True or False, # Whether to return refresh tokens.
    "returnIdpCredential": True or False, # Whether return 200 and IDP credential rather than throw exception when federated id is already linked.
  }


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.
    "rawUserInfo": "A String", # Raw IDP-returned user info.
    "appScheme": "A String", # The custom scheme used by mobile app.
    "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
    "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
    "verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.
      "A String",
    ],
    "needEmail": True or False, # Whether need client to supply email to complete the federated login flow.
    "dateOfBirth": "A String", # The birth date of the IdP account.
    "oauthAccessToken": "A String", # The OAuth2 access token.
    "emailRecycled": True or False, # It's true if the email is recycled.
    "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
    "screenName": "A String", # The screen_name of a Twitter user or the login name at Github.
    "nickName": "A String", # The nick name of the user.
    "errorMessage": "A String", # Client error code.
    "oauthTokenSecret": "A String", # The OAuth1 access token secret.
    "language": "A String", # The language preference of the user.
    "needConfirmation": True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.
    "oauthIdToken": "A String", # The OIDC 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.
    "appInstallationUrl": "A String", # URL for OTA app installation.
    "firstName": "A String", # The first name of the user.
    "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
    "emailVerified": True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.
    "lastName": "A String", # The last name of the user.
    "oauthScope": "A String", # The scope for the OpenID OAuth extension.
    "oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.
    "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
    "originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.
    "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.
    "idToken": "A String", # The ID token.
    "action": "A String", # The action code.
    "timeZone": "A String", # The timezone of the user.
  }
verifyCustomToken(body) 
Verifies the developer asserted ID token.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to verify a custom token
    "instanceId": "A String", # Instance id token of the app.
    "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
    "token": "A String", # The custom token to verify
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
  }


Returns:
  An object of the form:

    { # Response from verifying a custom token
    "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
    "idToken": "A String", # The GITKit token for authenticated user.
    "kind": "identitytoolkit#VerifyCustomTokenResponse", # The fixed string "identitytoolkit#VerifyCustomTokenResponse".
    "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
  }
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.
    "instanceId": "A String", # Instance id token of the app.
    "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
    "captchaResponse": "A String", # Response to the captcha.
    "idToken": "A String", # The GITKit token of the authenticated user.
    "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.
    "captchaChallenge": "A String", # The captcha challenge.
    "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
    "password": "A String", # The password inputed by the user.
    "email": "A String", # The email of the user.
  }


Returns:
  An object of the form:

    { # Request of verifying the password.
    "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
    "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.
    "oauthAccessToken": "A String", # The OAuth2 access token.
    "photoUrl": "A String", # The URI of the user's photo at IdP
    "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
    "idToken": "A String", # The GITKit token for authenticated user.
    "registered": True or False, # Whether the email is registered.
    "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
    "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
    "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
  }
google-api-python-client-1.5.5/docs/dyn/kgsearch_v1.entities.html000066400000000000000000000056611300622755700250070ustar00rootroot00000000000000

Knowledge Graph Search API . entities

Instance Methods

search(prefix=None, query=None, x__xgafv=None, types=None, indent=None, languages=None, ids=None, limit=None)

Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

Method Details

search(prefix=None, query=None, x__xgafv=None, types=None, indent=None, languages=None, ids=None, limit=None) 
Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

Args:
  prefix: boolean, Enables prefix match against names and aliases of entities
  query: string, The literal query string for search.
  x__xgafv: string, V1 error format.
  types: string, Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). (repeated)
  indent: boolean, Enables indenting of json results.
  languages: string, The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. (repeated)
  ids: string, The list of entity id to be used for search instead of query string. (repeated)
  limit: integer, Limits the number of entities to be returned.

Returns:
  An object of the form:

    { # Response message includes the context and a list of matching results which contain the detail of associated entities.
    "itemListElement": [ # The item list of search results.
      "",
    ],
    "type": "", # The schema type of top-level JSON-LD object, e.g. ItemList.
    "context": "", # The local context applicable for the response. See more details at http://www.w3.org/TR/json-ld/#context-definitions.
  }
google-api-python-client-1.5.5/docs/dyn/kgsearch_v1.html000066400000000000000000000041331300622755700231550ustar00rootroot00000000000000

Knowledge Graph Search API

Instance Methods

entities()

Returns the entities Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/language_v1beta1.documents.html000066400000000000000000000352121300622755700260700ustar00rootroot00000000000000

Google Cloud Natural Language API . documents

Instance Methods

analyzeEntities(body, x__xgafv=None)

Finds named entities (currently finds proper names) in the text,

analyzeSentiment(body, x__xgafv=None)

Analyzes the sentiment of the provided text.

annotateText(body, x__xgafv=None)

A convenience method that provides all the features that analyzeSentiment,

Method Details

analyzeEntities(body, x__xgafv=None) 
Finds named entities (currently finds proper names) in the text,
entity types, salience, mentions for each entity, and other properties.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The entity analysis request message.
    "document": { # ################################################################ # # Input document.
        #
        # Represents the input to API methods.
      "content": "A String", # The content of the input in string format.
      "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
          # returns an `INVALID_ARGUMENT` error.
      "language": "A String", # The language of the document (if not specified, the language is
          # automatically detected). Both ISO and BCP-47 language codes are
          # accepted.

          # **Current Language Restrictions:**
          #
          #  * Only English, Spanish, and Japanese textual content
          #    are supported, with the following additional restriction:
          #    * `analyzeSentiment` only supports English text.
          # If the language (either specified by the caller or automatically detected)
          # is not supported by the called API method, an `INVALID_ARGUMENT` error
          # is returned.
      "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
    },
    "encodingType": "A String", # The encoding type used by the API to calculate offsets.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The entity analysis response message.
    "entities": [ # The recognized entities in the input document.
      { # Represents a phrase in the text that is a known entity, such as
          # a person, an organization, or location. The API associates information, such
          # as salience and mentions, with entities.
        "type": "A String", # The entity type.
        "mentions": [ # The mentions of this entity in the input document. The API currently
            # supports proper noun mentions.
          { # Represents a mention for an entity in the text. Currently, proper noun
              # mentions are supported.
            "text": { # Represents an output piece of text. # The mention text.
              "content": "A String", # The content of the output text.
              "beginOffset": 42, # The API calculates the beginning offset of the content in the original
                  # document according to the EncodingType specified in the API request.
            },
          },
        ],
        "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
            #
            # The salience score for an entity provides information about the
            # importance or centrality of that entity to the entire document text.
            # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
            # salient.
        "name": "A String", # The representative name for the entity.
        "metadata": { # Metadata associated with the entity.
            #
            # Currently, only Wikipedia URLs are provided, if available.
            # The associated key is "wikipedia_url".
          "a_key": "A String",
        },
      },
    ],
    "language": "A String", # The language of the text, which will be the same as the language specified
        # in the request or, if not specified, the automatically-detected language.
        # See Document.language field for more details.
  }
analyzeSentiment(body, x__xgafv=None) 
Analyzes the sentiment of the provided text.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The sentiment analysis request message.
    "document": { # ################################################################ # # Input document. Currently, `analyzeSentiment` only supports English text
        # (Document.language="EN").
        #
        # Represents the input to API methods.
      "content": "A String", # The content of the input in string format.
      "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
          # returns an `INVALID_ARGUMENT` error.
      "language": "A String", # The language of the document (if not specified, the language is
          # automatically detected). Both ISO and BCP-47 language codes are
          # accepted.

          # **Current Language Restrictions:**
          #
          #  * Only English, Spanish, and Japanese textual content
          #    are supported, with the following additional restriction:
          #    * `analyzeSentiment` only supports English text.
          # If the language (either specified by the caller or automatically detected)
          # is not supported by the called API method, an `INVALID_ARGUMENT` error
          # is returned.
      "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The sentiment analysis response message.
    "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
        # the text.
      "polarity": 3.14, # Polarity of the sentiment in the [-1.0, 1.0] range. Larger numbers
          # represent more positive sentiments.
      "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
          # the absolute magnitude of sentiment regardless of polarity (positive or
          # negative).
    },
    "language": "A String", # The language of the text, which will be the same as the language specified
        # in the request or, if not specified, the automatically-detected language.
  }
annotateText(body, x__xgafv=None) 
A convenience method that provides all the features that analyzeSentiment,
analyzeEntities, and analyzeSyntax provide in one call.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for the text annotation API, which can perform multiple
      # analysis types (sentiment, entities, and syntax) in one call.
    "document": { # ################################################################ # # Input document.
        #
        # Represents the input to API methods.
      "content": "A String", # The content of the input in string format.
      "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
          # returns an `INVALID_ARGUMENT` error.
      "language": "A String", # The language of the document (if not specified, the language is
          # automatically detected). Both ISO and BCP-47 language codes are
          # accepted.

          # **Current Language Restrictions:**
          #
          #  * Only English, Spanish, and Japanese textual content
          #    are supported, with the following additional restriction:
          #    * `analyzeSentiment` only supports English text.
          # If the language (either specified by the caller or automatically detected)
          # is not supported by the called API method, an `INVALID_ARGUMENT` error
          # is returned.
      "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
    },
    "encodingType": "A String", # The encoding type used by the API to calculate offsets.
    "features": { # All available features for sentiment, syntax, and semantic analysis. # The enabled features.
        # Setting each one to true will enable that specific analysis for the input.
      "extractSyntax": True or False, # Extract syntax information.
      "extractEntities": True or False, # Extract entities.
      "extractDocumentSentiment": True or False, # Extract document-level sentiment.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The text annotations response message.
    "tokens": [ # Tokens, along with their syntactic information, in the input document.
        # Populated if the user enables
        # AnnotateTextRequest.Features.extract_syntax.
      { # Represents the smallest syntactic building block of the text.
        "text": { # Represents an output piece of text. # The token text.
          "content": "A String", # The content of the output text.
          "beginOffset": 42, # The API calculates the beginning offset of the content in the original
              # document according to the EncodingType specified in the API request.
        },
        "dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
          "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
              # This is the index of the token which has an arc going to this token.
              # The index is the position of the token in the array of tokens returned
              # by the API method. If this token is a root token, then the
              # `head_token_index` is its own index.
          "label": "A String", # The parse label for the token.
        },
        "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
          "tag": "A String", # The part of speech tag.
        },
        "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_(morphology))
            # of the token.
      },
    ],
    "entities": [ # Entities, along with their semantic information, in the input document.
        # Populated if the user enables
        # AnnotateTextRequest.Features.extract_entities.
      { # Represents a phrase in the text that is a known entity, such as
          # a person, an organization, or location. The API associates information, such
          # as salience and mentions, with entities.
        "type": "A String", # The entity type.
        "mentions": [ # The mentions of this entity in the input document. The API currently
            # supports proper noun mentions.
          { # Represents a mention for an entity in the text. Currently, proper noun
              # mentions are supported.
            "text": { # Represents an output piece of text. # The mention text.
              "content": "A String", # The content of the output text.
              "beginOffset": 42, # The API calculates the beginning offset of the content in the original
                  # document according to the EncodingType specified in the API request.
            },
          },
        ],
        "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
            #
            # The salience score for an entity provides information about the
            # importance or centrality of that entity to the entire document text.
            # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
            # salient.
        "name": "A String", # The representative name for the entity.
        "metadata": { # Metadata associated with the entity.
            #
            # Currently, only Wikipedia URLs are provided, if available.
            # The associated key is "wikipedia_url".
          "a_key": "A String",
        },
      },
    ],
    "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment for the document. Populated if the user enables
        # AnnotateTextRequest.Features.extract_document_sentiment.
        # the text.
      "polarity": 3.14, # Polarity of the sentiment in the [-1.0, 1.0] range. Larger numbers
          # represent more positive sentiments.
      "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
          # the absolute magnitude of sentiment regardless of polarity (positive or
          # negative).
    },
    "language": "A String", # The language of the text, which will be the same as the language specified
        # in the request or, if not specified, the automatically-detected language.
        # See Document.language field for more details.
    "sentences": [ # Sentences in the input document. Populated if the user enables
        # AnnotateTextRequest.Features.extract_syntax.
      { # Represents a sentence in the input document.
        "text": { # Represents an output piece of text. # The sentence text.
          "content": "A String", # The content of the output text.
          "beginOffset": 42, # The API calculates the beginning offset of the content in the original
              # document according to the EncodingType specified in the API request.
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/language_v1beta1.html000066400000000000000000000041571300622755700240740ustar00rootroot00000000000000

Google Cloud Natural Language API

Instance Methods

documents()

Returns the documents Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/licensing_v1.html000066400000000000000000000041771300622755700233510ustar00rootroot00000000000000

Enterprise License Manager API

Instance Methods

licenseAssignments()

Returns the licenseAssignments Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/licensing_v1.licenseAssignments.html000066400000000000000000000263751300622755700272120ustar00rootroot00000000000000

Enterprise License Manager API . licenseAssignments

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.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2.billingAccounts.html000066400000000000000000000023531300622755700261360ustar00rootroot00000000000000

Stackdriver Logging API . billingAccounts

Instance Methods

logs()

Returns the logs Resource.

google-api-python-client-1.5.5/docs/dyn/logging_v2.billingAccounts.logs.html000066400000000000000000000043431300622755700271020ustar00rootroot00000000000000

Stackdriver Logging API . billingAccounts . logs

Instance Methods

delete(logName=None, x__xgafv=None)

Deletes a log and all its log entries.

Method Details

delete(logName=None, x__xgafv=None) 
Deletes a log and all its log entries.
The log will reappear if it receives new entries.

Args:
  logName: string, Required. The resource name of the log to delete.  Example:
`"projects/my-project/logs/syslog"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2.entries.html000066400000000000000000000552561300622755700245010ustar00rootroot00000000000000

Stackdriver Logging API . entries

Instance Methods

list(body, x__xgafv=None)

Lists log entries. Use this method to retrieve log entries from Cloud

write(body, x__xgafv=None)

Writes log entries to Stackdriver Logging. All log entries are

Method Details

list(body, x__xgafv=None) 
Lists log entries.  Use this method to retrieve log entries from Cloud
Logging.  For ways to export log entries, see
[Exporting Logs](/logging/docs/export).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The parameters to `ListLogEntries`.
    "orderBy": "A String", # Optional. How the results should be sorted.  Presently, the only permitted
        # values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
        # option returns entries in order of increasing values of
        # `LogEntry.timestamp` (oldest first), and the second option returns entries
        # in order of decreasing timestamps (newest first).  Entries with equal
        # timestamps are returned in order of `LogEntry.insertId`.
    "resourceNames": [ # Required. One or more cloud resources from which to retrieve log entries.
        # Example: `"projects/my-project-1A"`, `"projects/1234567890"`.  Projects
        # listed in `projectIds` are added to this list.
      "A String",
    ],
    "pageSize": 42, # Optional. The maximum number of results to return from this request.
        # Non-positive values are ignored.  The presence of `nextPageToken` in the
        # response indicates that more results might be available.
    "filter": "A String", # Optional. A filter that chooses which log entries to return.  See [Advanced
        # Logs Filters](/logging/docs/view/advanced_filters).  Only log entries that
        # match the filter are returned.  An empty filter matches all log entries.
    "pageToken": "A String", # Optional. If present, then retrieve the next batch of results from the
        # preceding call to this method.  `pageToken` must be the value of
        # `nextPageToken` from the previous response.  The values of other method
        # parameters should be identical to those in the previous call.
    "projectIds": [ # Deprecated. One or more project identifiers or project numbers from which
        # to retrieve log entries.  Examples: `"my-project-1A"`, `"1234567890"`. If
        # present, these project identifiers are converted to resource format and
        # added to the list of resources in `resourceNames`. Callers should use
        # `resourceNames` rather than this parameter.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Result returned from `ListLogEntries`.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call this
        # method again using the value of `nextPageToken` as `pageToken`.
    "entries": [ # A list of log entries.
      { # An individual entry in a log.
        "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
            # log entry, if applicable.
            # defined by the HTTP specification. Product-specific logging
            # information MUST be defined in a separate message.
          "status": 42, # The response code indicating the status of response.
              # Examples: 200, 404.
          "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
              # being served from cache. This field is only meaningful if `cache_hit` is
              # True.
          "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
          "latency": "A String", # The request processing latency on the server, from the time the request was
              # received until the response was sent.
          "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
              # cache fill was attempted.
          "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
              # portion of the URL that was requested.
              # Example: `"http://example.com/some/info?color=red"`.
          "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
              # sent to.
          "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
          "cacheHit": True or False, # Whether or not an entity was served from cache
              # (with or without validation).
          "referer": "A String", # The referer URL of the request, as defined in
              # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
          "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
              # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
          "userAgent": "A String", # The user agent sent by the client. Example:
              # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
          "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
              # headers and the request body.
          "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
              # including the response headers and the response body.
        },
        "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
            # Example: a log entry that reports a database error would be
            # associated with the monitored resource designating the particular
            # database that reported the error.
            # billing, or other purposes. Examples include virtual machine instances,
            # databases, and storage devices such as disks. The `type` field identifies a
            # MonitoredResourceDescriptor object that describes the resource's
            # schema. Information in the `labels` field identifies the actual resource and
            # its attributes according to the schema. For example, a particular Compute
            # Engine VM instance could be represented by the following object, because the
            # MonitoredResourceDescriptor for `"gce_instance"` has labels
            # `"instance_id"` and `"zone"`:
            #
            #     { "type": "gce_instance",
            #       "labels": { "instance_id": "12345678901234",
            #                   "zone": "us-central1-a" }}
          "labels": { # Required. Values for all of the labels listed in the associated monitored
              # resource descriptor. For example, Cloud SQL databases use the labels
              # `"database_id"` and `"zone"`.
            "a_key": "A String",
          },
          "type": "A String", # Required. The monitored resource type. This field must match
              # the `type` field of a MonitoredResourceDescriptor object. For
              # example, the type of a Cloud SQL database is `"cloudsql_database"`.
        },
        "severity": "A String", # Optional. The severity of the log entry. The default value is
            # `LogSeverity.DEFAULT`.
        "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
        "timestamp": "A String", # Optional. The time the event described by the log entry occurred.  If
            # omitted, Stackdriver Logging will use the time the log entry is received.
        "labels": { # Optional. A set of user-defined (key, value) data that provides additional
            # information about the log entry.
          "a_key": "A String",
        },
        "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
            # field, the logging service considers other log entries in the
            # same project with the same ID as duplicates which can be removed.  If
            # omitted, Stackdriver Logging will generate a unique ID for this
            # log entry.
        "jsonPayload": { # The log entry payload, represented as a structure that
            # is expressed as a JSON object.
          "a_key": "", # Properties of the object.
        },
        "logName": "A String", # Required. The resource name of the log to which this log entry
            # belongs. The format of the name is
            # `"projects//logs/"`.  Examples:
            # `"projects/my-projectid/logs/syslog"`,
            # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
            #
            # The log ID part of resource name must be less than 512 characters
            # long and can only include the following characters: upper and
            # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
            # characters: forward-slash, underscore, hyphen, and period.
            # Forward-slash (`/`) characters in the log ID must be URL-encoded.
        "protoPayload": { # The log entry payload, represented as a protocol buffer.  Some
            # Google Cloud Platform services use this field for their log
            # entry payloads.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
            # applicable.
            # a log entry is associated.
          "last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
          "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
              # same identifier are assumed to be part of the same operation.
          "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
              # `id` and `producer` must be globally unique.  Examples for `producer`:
              # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
          "first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
        },
      },
    ],
  }
write(body, x__xgafv=None) 
Writes log entries to Stackdriver Logging.  All log entries are
written by this method.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The parameters to WriteLogEntries.
    "resource": { # An object representing a resource that can be used for monitoring, logging, # Optional. A default monitored resource object that is assigned to all log
        # entries in `entries` that do not specify a value for `resource`. Example:
        # 
        #     { "type": "gce_instance",
        #       "labels": {
        #         "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
        # 
        # See LogEntry.
        # billing, or other purposes. Examples include virtual machine instances,
        # databases, and storage devices such as disks. The `type` field identifies a
        # MonitoredResourceDescriptor object that describes the resource's
        # schema. Information in the `labels` field identifies the actual resource and
        # its attributes according to the schema. For example, a particular Compute
        # Engine VM instance could be represented by the following object, because the
        # MonitoredResourceDescriptor for `"gce_instance"` has labels
        # `"instance_id"` and `"zone"`:
        #
        #     { "type": "gce_instance",
        #       "labels": { "instance_id": "12345678901234",
        #                   "zone": "us-central1-a" }}
      "labels": { # Required. Values for all of the labels listed in the associated monitored
          # resource descriptor. For example, Cloud SQL databases use the labels
          # `"database_id"` and `"zone"`.
        "a_key": "A String",
      },
      "type": "A String", # Required. The monitored resource type. This field must match
          # the `type` field of a MonitoredResourceDescriptor object. For
          # example, the type of a Cloud SQL database is `"cloudsql_database"`.
    },
    "partialSuccess": True or False, # Optional. Whether valid entries should be written even if some other
        # entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
        # entry is not written, the response status will be the error associated
        # with one of the failed entries and include error details in the form of
        # WriteLogEntriesPartialErrors.
    "labels": { # Optional. Default labels that are added to the `labels` field of all log
        # entries in `entries`. If a log entry already has a label with the same key
        # as a label in this parameter, then the log entry's label is not changed.
        # See LogEntry.
      "a_key": "A String",
    },
    "logName": "A String", # Optional. A default log resource name that is assigned to all log entries
        # in `entries` that do not specify a value for `log_name`.  Example:
        # `"projects/my-project/logs/syslog"`.  See
        # LogEntry.
    "entries": [ # Required. The log entries to write. Values supplied for the fields
        # `log_name`, `resource`, and `labels` in this `entries.write` request are
        # added to those log entries that do not provide their own values for the
        # fields.
        # 
        # To improve throughput and to avoid exceeding the
        # [quota limit](/logging/quota-policy) for calls to `entries.write`,
        # you should write multiple log entries at once rather than
        # calling this method for each individual log entry.
      { # An individual entry in a log.
        "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
            # log entry, if applicable.
            # defined by the HTTP specification. Product-specific logging
            # information MUST be defined in a separate message.
          "status": 42, # The response code indicating the status of response.
              # Examples: 200, 404.
          "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
              # being served from cache. This field is only meaningful if `cache_hit` is
              # True.
          "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
          "latency": "A String", # The request processing latency on the server, from the time the request was
              # received until the response was sent.
          "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
              # cache fill was attempted.
          "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
              # portion of the URL that was requested.
              # Example: `"http://example.com/some/info?color=red"`.
          "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
              # sent to.
          "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
          "cacheHit": True or False, # Whether or not an entity was served from cache
              # (with or without validation).
          "referer": "A String", # The referer URL of the request, as defined in
              # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
          "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
              # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
          "userAgent": "A String", # The user agent sent by the client. Example:
              # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
          "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
              # headers and the request body.
          "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
              # including the response headers and the response body.
        },
        "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
            # Example: a log entry that reports a database error would be
            # associated with the monitored resource designating the particular
            # database that reported the error.
            # billing, or other purposes. Examples include virtual machine instances,
            # databases, and storage devices such as disks. The `type` field identifies a
            # MonitoredResourceDescriptor object that describes the resource's
            # schema. Information in the `labels` field identifies the actual resource and
            # its attributes according to the schema. For example, a particular Compute
            # Engine VM instance could be represented by the following object, because the
            # MonitoredResourceDescriptor for `"gce_instance"` has labels
            # `"instance_id"` and `"zone"`:
            #
            #     { "type": "gce_instance",
            #       "labels": { "instance_id": "12345678901234",
            #                   "zone": "us-central1-a" }}
          "labels": { # Required. Values for all of the labels listed in the associated monitored
              # resource descriptor. For example, Cloud SQL databases use the labels
              # `"database_id"` and `"zone"`.
            "a_key": "A String",
          },
          "type": "A String", # Required. The monitored resource type. This field must match
              # the `type` field of a MonitoredResourceDescriptor object. For
              # example, the type of a Cloud SQL database is `"cloudsql_database"`.
        },
        "severity": "A String", # Optional. The severity of the log entry. The default value is
            # `LogSeverity.DEFAULT`.
        "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
        "timestamp": "A String", # Optional. The time the event described by the log entry occurred.  If
            # omitted, Stackdriver Logging will use the time the log entry is received.
        "labels": { # Optional. A set of user-defined (key, value) data that provides additional
            # information about the log entry.
          "a_key": "A String",
        },
        "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
            # field, the logging service considers other log entries in the
            # same project with the same ID as duplicates which can be removed.  If
            # omitted, Stackdriver Logging will generate a unique ID for this
            # log entry.
        "jsonPayload": { # The log entry payload, represented as a structure that
            # is expressed as a JSON object.
          "a_key": "", # Properties of the object.
        },
        "logName": "A String", # Required. The resource name of the log to which this log entry
            # belongs. The format of the name is
            # `"projects//logs/"`.  Examples:
            # `"projects/my-projectid/logs/syslog"`,
            # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
            #
            # The log ID part of resource name must be less than 512 characters
            # long and can only include the following characters: upper and
            # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
            # characters: forward-slash, underscore, hyphen, and period.
            # Forward-slash (`/`) characters in the log ID must be URL-encoded.
        "protoPayload": { # The log entry payload, represented as a protocol buffer.  Some
            # Google Cloud Platform services use this field for their log
            # entry payloads.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
            # applicable.
            # a log entry is associated.
          "last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
          "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
              # same identifier are assumed to be part of the same operation.
          "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
              # `id` and `producer` must be globally unique.  Examples for `producer`:
              # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
          "first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Result returned from WriteLogEntries.
      # empty
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2.html000066400000000000000000000054171300622755700230230ustar00rootroot00000000000000

Stackdriver Logging API

Instance Methods

billingAccounts()

Returns the billingAccounts Resource.

entries()

Returns the entries Resource.

monitoredResourceDescriptors()

Returns the monitoredResourceDescriptors Resource.

organizations()

Returns the organizations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/logging_v2.monitoredResourceDescriptors.html000066400000000000000000000127751300622755700307610ustar00rootroot00000000000000

Stackdriver Logging API . monitoredResourceDescriptors

Instance Methods

list(pageSize=None, pageToken=None, x__xgafv=None)

Lists the monitored resource descriptors used by Stackdriver Logging.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(pageSize=None, pageToken=None, x__xgafv=None) 
Lists the monitored resource descriptors used by Stackdriver Logging.

Args:
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Result returned from ListMonitoredResourceDescriptors.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call this
        # method again using the value of `nextPageToken` as `pageToken`.
    "resourceDescriptors": [ # A list of resource descriptors.
      { # An object that describes the schema of a MonitoredResource object using a
          # type name and a set of labels.  For example, the monitored resource
          # descriptor for Google Compute Engine VM instances has a type of
          # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
          # `"zone"` to identify particular VM instances.
          #
          # Different APIs can support different monitored resource types. APIs generally
          # provide a `list` method that returns the monitored resource descriptors used
          # by the API.
        "type": "A String", # Required. The monitored resource type. For example, the type
            # `"cloudsql_database"` represents databases in Google Cloud SQL.
            # The maximum length of this value is 256 characters.
        "labels": [ # Required. A set of labels used to describe instances of this monitored
            # resource type. For example, an individual Google Cloud SQL database is
            # identified by values for the labels `"database_id"` and `"zone"`.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
            # displayed in user interfaces. It should be a Title Cased Noun Phrase,
            # without any article or other determiners. For example,
            # `"Google Cloud SQL Database"`.
        "description": "A String", # Optional. A detailed description of the monitored resource type that might
            # be used in documentation.
        "name": "A String", # Optional. The resource name of the monitored resource descriptor:
            # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
            # {type} is the value of the `type` field in this object and
            # {project_id} is a project ID that provides API-specific context for
            # accessing the type.  APIs that do not use project information can use the
            # resource name format `"monitoredResourceDescriptors/{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.
google-api-python-client-1.5.5/docs/dyn/logging_v2.organizations.html000066400000000000000000000026011300622755700257010ustar00rootroot00000000000000

Stackdriver Logging API . organizations

Instance Methods

logs()

Returns the logs Resource.

sinks()

Returns the sinks Resource.

google-api-python-client-1.5.5/docs/dyn/logging_v2.organizations.logs.html000066400000000000000000000043351300622755700266520ustar00rootroot00000000000000

Stackdriver Logging API . organizations . logs

Instance Methods

delete(logName=None, x__xgafv=None)

Deletes a log and all its log entries.

Method Details

delete(logName=None, x__xgafv=None) 
Deletes a log and all its log entries.
The log will reappear if it receives new entries.

Args:
  logName: string, Required. The resource name of the log to delete.  Example:
`"projects/my-project/logs/syslog"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2.organizations.sinks.html000066400000000000000000000547521300622755700270450ustar00rootroot00000000000000

Stackdriver Logging API . organizations . sinks

Instance Methods

create(parent=None, body, x__xgafv=None)

Creates a sink.

delete(sinkName=None, x__xgafv=None)

Deletes a sink.

get(sinkName=None, x__xgafv=None)

Gets a sink.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists sinks.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(sinkName=None, body, x__xgafv=None)

Updates or creates a sink.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a sink.

Args:
  parent: string, Required. The resource in which to create the sink.
Example: `"projects/my-project-id"`.
The new sink must be provided in the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a sink used to export log entries outside of Stackdriver Logging.
    "endTime": "A String", # Optional. Time at which this sink expires.
    "name": "A String", # Required. The client-assigned sink identifier, unique within the
        # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
        # limited to 1000 characters and can include only the following characters:
        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
        # of the name is 100 characters.
    "destination": "A String", # Required. The export destination. See
        # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
        # Examples:
        # 
        #     "storage.googleapis.com/my-gcs-bucket"
        #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
        #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Only log entries matching the filter are exported. The filter
        # must be consistent with the log entry format specified by the
        # `outputVersionFormat` parameter, regardless of the format of the
        # log entry that was originally written to Stackdriver Logging.
        # Example filter (V2 format):
        # 
        #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
    "startTime": "A String", # Optional. Time range for which this sink is active.
        # Logs are exported only if start_time <= entry.timestamp < end_time
        # Both start_time and end_time may be omitted to specify
        # (half) infinite ranges. The start_time must be less than the end_time.
    "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
        # entries.  This version does not have to correspond to the version of the
        # log entry that was written to Stackdriver Logging. If omitted, the
        # v2 format is used.
    "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
        # access.  This may be a service account or a group.
        # Examples (Do not assume these specific values):
        #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
        #    "group:cloud-logs@google.com"
        # 
        #   For GCS destinations, the role "roles/owner" is required on the bucket
        #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
        #     required on the topic
        #   For BigQuery, the role "roles/editor" is required on the dataset
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
delete(sinkName=None, x__xgafv=None) 
Deletes a sink.

Args:
  sinkName: string, Required. The resource name of the sink to delete, including the parent
resource and the sink identifier.  Example:
`"projects/my-project-id/sinks/my-sink-id"`.  It is an error if the sink
does not exist. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(sinkName=None, x__xgafv=None) 
Gets a sink.

Args:
  sinkName: string, Required. The resource name of the sink to return.
Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists sinks.

Args:
  parent: string, Required. The cloud resource containing the sinks.
Example: `"projects/my-logging-project"`. (required)
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.

Returns:
  An object of the form:

    { # Result returned from `ListSinks`.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call the same
        # method again using the value of `nextPageToken` as `pageToken`.
    "sinks": [ # A list of sinks.
      { # Describes a sink used to export log entries outside of Stackdriver Logging.
          "endTime": "A String", # Optional. Time at which this sink expires.
          "name": "A String", # Required. The client-assigned sink identifier, unique within the
              # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
              # limited to 1000 characters and can include only the following characters:
              # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
              # of the name is 100 characters.
          "destination": "A String", # Required. The export destination. See
              # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
              # Examples:
              #
              #     "storage.googleapis.com/my-gcs-bucket"
              #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
              #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
          "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
              # Only log entries matching the filter are exported. The filter
              # must be consistent with the log entry format specified by the
              # `outputVersionFormat` parameter, regardless of the format of the
              # log entry that was originally written to Stackdriver Logging.
              # Example filter (V2 format):
              #
              #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
          "startTime": "A String", # Optional. Time range for which this sink is active.
              # Logs are exported only if start_time <= entry.timestamp < end_time
              # Both start_time and end_time may be omitted to specify
              # (half) infinite ranges. The start_time must be less than the end_time.
          "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
              # entries.  This version does not have to correspond to the version of the
              # log entry that was written to Stackdriver Logging. If omitted, the
              # v2 format is used.
          "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
              # access.  This may be a service account or a group.
              # Examples (Do not assume these specific values):
              #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
              #    "group:cloud-logs@google.com"
              #
              #   For GCS destinations, the role "roles/owner" is required on the bucket
              #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
              #     required on the topic
              #   For BigQuery, the role "roles/editor" is required on 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.
update(sinkName=None, body, x__xgafv=None) 
Updates or creates a sink.

Args:
  sinkName: string, Required. The resource name of the sink to update, including the parent
resource and the sink identifier.  If the sink does not exist, this method
creates the sink.  Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a sink used to export log entries outside of Stackdriver Logging.
    "endTime": "A String", # Optional. Time at which this sink expires.
    "name": "A String", # Required. The client-assigned sink identifier, unique within the
        # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
        # limited to 1000 characters and can include only the following characters:
        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
        # of the name is 100 characters.
    "destination": "A String", # Required. The export destination. See
        # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
        # Examples:
        # 
        #     "storage.googleapis.com/my-gcs-bucket"
        #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
        #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Only log entries matching the filter are exported. The filter
        # must be consistent with the log entry format specified by the
        # `outputVersionFormat` parameter, regardless of the format of the
        # log entry that was originally written to Stackdriver Logging.
        # Example filter (V2 format):
        # 
        #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
    "startTime": "A String", # Optional. Time range for which this sink is active.
        # Logs are exported only if start_time <= entry.timestamp < end_time
        # Both start_time and end_time may be omitted to specify
        # (half) infinite ranges. The start_time must be less than the end_time.
    "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
        # entries.  This version does not have to correspond to the version of the
        # log entry that was written to Stackdriver Logging. If omitted, the
        # v2 format is used.
    "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
        # access.  This may be a service account or a group.
        # Examples (Do not assume these specific values):
        #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
        #    "group:cloud-logs@google.com"
        # 
        #   For GCS destinations, the role "roles/owner" is required on the bucket
        #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
        #     required on the topic
        #   For BigQuery, the role "roles/editor" is required on the dataset
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
google-api-python-client-1.5.5/docs/dyn/logging_v2.projects.html000066400000000000000000000030121300622755700246400ustar00rootroot00000000000000

Stackdriver Logging API . projects

Instance Methods

logs()

Returns the logs Resource.

metrics()

Returns the metrics Resource.

sinks()

Returns the sinks Resource.

google-api-python-client-1.5.5/docs/dyn/logging_v2.projects.logs.html000066400000000000000000000043161300622755700256130ustar00rootroot00000000000000

Stackdriver Logging API . projects . logs

Instance Methods

delete(logName=None, x__xgafv=None)

Deletes a log and all its log entries.

Method Details

delete(logName=None, x__xgafv=None) 
Deletes a log and all its log entries.
The log will reappear if it receives new entries.

Args:
  logName: string, Required. The resource name of the log to delete.  Example:
`"projects/my-project/logs/syslog"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2.projects.metrics.html000066400000000000000000000337401300622755700263200ustar00rootroot00000000000000

Stackdriver Logging API . projects . metrics

Instance Methods

create(parent=None, body, x__xgafv=None)

Creates a logs-based metric.

delete(metricName=None, x__xgafv=None)

Deletes a logs-based metric.

get(metricName=None, x__xgafv=None)

Gets a logs-based metric.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists logs-based metrics.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(metricName=None, body, x__xgafv=None)

Creates or updates a logs-based metric.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a logs-based metric.

Args:
  parent: string, The resource name of the project in which to create the metric.
Example: `"projects/my-project-id"`.

The new metric must be provided in the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a logs-based metric.  The value of the metric is the
      # number of log entries that match a logs filter.
    "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Example: `"resource.type=gae_app AND severity>=ERROR"`.
    "version": "A String", # Output only. The API version that created or updated this metric.
        # The version also dictates the syntax of the filter expression. When a value
        # for this field is missing, the default value of V2 should be assumed.
    "description": "A String", # Optional. A description of this metric, which is used in documentation.
    "name": "A String", # Required. The client-assigned metric identifier. Example:
        # `"severe_errors"`.  Metric identifiers are limited to 100
        # characters and can include only the following characters: `A-Z`,
        # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
        # forward-slash character (`/`) denotes a hierarchy of name pieces,
        # and it cannot be the first character of the name.  The '%' character
        # is used to URL encode unsafe and reserved characters and must be
        # followed by two hexadecimal digits according to RFC 1738.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a logs-based metric.  The value of the metric is the
        # number of log entries that match a logs filter.
      "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Example: `"resource.type=gae_app AND severity>=ERROR"`.
      "version": "A String", # Output only. The API version that created or updated this metric.
          # The version also dictates the syntax of the filter expression. When a value
          # for this field is missing, the default value of V2 should be assumed.
      "description": "A String", # Optional. A description of this metric, which is used in documentation.
      "name": "A String", # Required. The client-assigned metric identifier. Example:
          # `"severe_errors"`.  Metric identifiers are limited to 100
          # characters and can include only the following characters: `A-Z`,
          # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
          # forward-slash character (`/`) denotes a hierarchy of name pieces,
          # and it cannot be the first character of the name.  The '%' character
          # is used to URL encode unsafe and reserved characters and must be
          # followed by two hexadecimal digits according to RFC 1738.
    }
delete(metricName=None, x__xgafv=None) 
Deletes a logs-based metric.

Args:
  metricName: string, The resource name of the metric to delete.
Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(metricName=None, x__xgafv=None) 
Gets a logs-based metric.

Args:
  metricName: string, The resource name of the desired metric.
Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a logs-based metric.  The value of the metric is the
        # number of log entries that match a logs filter.
      "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Example: `"resource.type=gae_app AND severity>=ERROR"`.
      "version": "A String", # Output only. The API version that created or updated this metric.
          # The version also dictates the syntax of the filter expression. When a value
          # for this field is missing, the default value of V2 should be assumed.
      "description": "A String", # Optional. A description of this metric, which is used in documentation.
      "name": "A String", # Required. The client-assigned metric identifier. Example:
          # `"severe_errors"`.  Metric identifiers are limited to 100
          # characters and can include only the following characters: `A-Z`,
          # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
          # forward-slash character (`/`) denotes a hierarchy of name pieces,
          # and it cannot be the first character of the name.  The '%' character
          # is used to URL encode unsafe and reserved characters and must be
          # followed by two hexadecimal digits according to RFC 1738.
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists logs-based metrics.

Args:
  parent: string, Required. The resource name containing the metrics.
Example: `"projects/my-project-id"`. (required)
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.

Returns:
  An object of the form:

    { # Result returned from ListLogMetrics.
    "metrics": [ # A list of logs-based metrics.
      { # Describes a logs-based metric.  The value of the metric is the
            # number of log entries that match a logs filter.
          "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
              # Example: `"resource.type=gae_app AND severity>=ERROR"`.
          "version": "A String", # Output only. The API version that created or updated this metric.
              # The version also dictates the syntax of the filter expression. When a value
              # for this field is missing, the default value of V2 should be assumed.
          "description": "A String", # Optional. A description of this metric, which is used in documentation.
          "name": "A String", # Required. The client-assigned metric identifier. Example:
              # `"severe_errors"`.  Metric identifiers are limited to 100
              # characters and can include only the following characters: `A-Z`,
              # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
              # forward-slash character (`/`) denotes a hierarchy of name pieces,
              # and it cannot be the first character of the name.  The '%' character
              # is used to URL encode unsafe and reserved characters and must be
              # followed by two hexadecimal digits according to RFC 1738.
        },
    ],
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call this
        # method again using the value of `nextPageToken` as `pageToken`.
  }
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(metricName=None, body, x__xgafv=None) 
Creates or updates a logs-based metric.

Args:
  metricName: string, The resource name of the metric to update.
Example: `"projects/my-project-id/metrics/my-metric-id"`.

The updated metric must be provided in the request and have the
same identifier that is specified in `metricName`.
If the metric does not exist, it is created. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a logs-based metric.  The value of the metric is the
      # number of log entries that match a logs filter.
    "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Example: `"resource.type=gae_app AND severity>=ERROR"`.
    "version": "A String", # Output only. The API version that created or updated this metric.
        # The version also dictates the syntax of the filter expression. When a value
        # for this field is missing, the default value of V2 should be assumed.
    "description": "A String", # Optional. A description of this metric, which is used in documentation.
    "name": "A String", # Required. The client-assigned metric identifier. Example:
        # `"severe_errors"`.  Metric identifiers are limited to 100
        # characters and can include only the following characters: `A-Z`,
        # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
        # forward-slash character (`/`) denotes a hierarchy of name pieces,
        # and it cannot be the first character of the name.  The '%' character
        # is used to URL encode unsafe and reserved characters and must be
        # followed by two hexadecimal digits according to RFC 1738.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a logs-based metric.  The value of the metric is the
        # number of log entries that match a logs filter.
      "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Example: `"resource.type=gae_app AND severity>=ERROR"`.
      "version": "A String", # Output only. The API version that created or updated this metric.
          # The version also dictates the syntax of the filter expression. When a value
          # for this field is missing, the default value of V2 should be assumed.
      "description": "A String", # Optional. A description of this metric, which is used in documentation.
      "name": "A String", # Required. The client-assigned metric identifier. Example:
          # `"severe_errors"`.  Metric identifiers are limited to 100
          # characters and can include only the following characters: `A-Z`,
          # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
          # forward-slash character (`/`) denotes a hierarchy of name pieces,
          # and it cannot be the first character of the name.  The '%' character
          # is used to URL encode unsafe and reserved characters and must be
          # followed by two hexadecimal digits according to RFC 1738.
    }
google-api-python-client-1.5.5/docs/dyn/logging_v2.projects.sinks.html000066400000000000000000000547331300622755700260060ustar00rootroot00000000000000

Stackdriver Logging API . projects . sinks

Instance Methods

create(parent=None, body, x__xgafv=None)

Creates a sink.

delete(sinkName=None, x__xgafv=None)

Deletes a sink.

get(sinkName=None, x__xgafv=None)

Gets a sink.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists sinks.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(sinkName=None, body, x__xgafv=None)

Updates or creates a sink.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a sink.

Args:
  parent: string, Required. The resource in which to create the sink.
Example: `"projects/my-project-id"`.
The new sink must be provided in the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a sink used to export log entries outside of Stackdriver Logging.
    "endTime": "A String", # Optional. Time at which this sink expires.
    "name": "A String", # Required. The client-assigned sink identifier, unique within the
        # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
        # limited to 1000 characters and can include only the following characters:
        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
        # of the name is 100 characters.
    "destination": "A String", # Required. The export destination. See
        # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
        # Examples:
        # 
        #     "storage.googleapis.com/my-gcs-bucket"
        #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
        #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Only log entries matching the filter are exported. The filter
        # must be consistent with the log entry format specified by the
        # `outputVersionFormat` parameter, regardless of the format of the
        # log entry that was originally written to Stackdriver Logging.
        # Example filter (V2 format):
        # 
        #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
    "startTime": "A String", # Optional. Time range for which this sink is active.
        # Logs are exported only if start_time <= entry.timestamp < end_time
        # Both start_time and end_time may be omitted to specify
        # (half) infinite ranges. The start_time must be less than the end_time.
    "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
        # entries.  This version does not have to correspond to the version of the
        # log entry that was written to Stackdriver Logging. If omitted, the
        # v2 format is used.
    "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
        # access.  This may be a service account or a group.
        # Examples (Do not assume these specific values):
        #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
        #    "group:cloud-logs@google.com"
        # 
        #   For GCS destinations, the role "roles/owner" is required on the bucket
        #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
        #     required on the topic
        #   For BigQuery, the role "roles/editor" is required on the dataset
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
delete(sinkName=None, x__xgafv=None) 
Deletes a sink.

Args:
  sinkName: string, Required. The resource name of the sink to delete, including the parent
resource and the sink identifier.  Example:
`"projects/my-project-id/sinks/my-sink-id"`.  It is an error if the sink
does not exist. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(sinkName=None, x__xgafv=None) 
Gets a sink.

Args:
  sinkName: string, Required. The resource name of the sink to return.
Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists sinks.

Args:
  parent: string, Required. The cloud resource containing the sinks.
Example: `"projects/my-logging-project"`. (required)
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.

Returns:
  An object of the form:

    { # Result returned from `ListSinks`.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call the same
        # method again using the value of `nextPageToken` as `pageToken`.
    "sinks": [ # A list of sinks.
      { # Describes a sink used to export log entries outside of Stackdriver Logging.
          "endTime": "A String", # Optional. Time at which this sink expires.
          "name": "A String", # Required. The client-assigned sink identifier, unique within the
              # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
              # limited to 1000 characters and can include only the following characters:
              # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
              # of the name is 100 characters.
          "destination": "A String", # Required. The export destination. See
              # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
              # Examples:
              #
              #     "storage.googleapis.com/my-gcs-bucket"
              #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
              #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
          "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
              # Only log entries matching the filter are exported. The filter
              # must be consistent with the log entry format specified by the
              # `outputVersionFormat` parameter, regardless of the format of the
              # log entry that was originally written to Stackdriver Logging.
              # Example filter (V2 format):
              #
              #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
          "startTime": "A String", # Optional. Time range for which this sink is active.
              # Logs are exported only if start_time <= entry.timestamp < end_time
              # Both start_time and end_time may be omitted to specify
              # (half) infinite ranges. The start_time must be less than the end_time.
          "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
              # entries.  This version does not have to correspond to the version of the
              # log entry that was written to Stackdriver Logging. If omitted, the
              # v2 format is used.
          "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
              # access.  This may be a service account or a group.
              # Examples (Do not assume these specific values):
              #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
              #    "group:cloud-logs@google.com"
              #
              #   For GCS destinations, the role "roles/owner" is required on the bucket
              #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
              #     required on the topic
              #   For BigQuery, the role "roles/editor" is required on 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.
update(sinkName=None, body, x__xgafv=None) 
Updates or creates a sink.

Args:
  sinkName: string, Required. The resource name of the sink to update, including the parent
resource and the sink identifier.  If the sink does not exist, this method
creates the sink.  Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a sink used to export log entries outside of Stackdriver Logging.
    "endTime": "A String", # Optional. Time at which this sink expires.
    "name": "A String", # Required. The client-assigned sink identifier, unique within the
        # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
        # limited to 1000 characters and can include only the following characters:
        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
        # of the name is 100 characters.
    "destination": "A String", # Required. The export destination. See
        # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
        # Examples:
        # 
        #     "storage.googleapis.com/my-gcs-bucket"
        #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
        #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Only log entries matching the filter are exported. The filter
        # must be consistent with the log entry format specified by the
        # `outputVersionFormat` parameter, regardless of the format of the
        # log entry that was originally written to Stackdriver Logging.
        # Example filter (V2 format):
        # 
        #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
    "startTime": "A String", # Optional. Time range for which this sink is active.
        # Logs are exported only if start_time <= entry.timestamp < end_time
        # Both start_time and end_time may be omitted to specify
        # (half) infinite ranges. The start_time must be less than the end_time.
    "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
        # entries.  This version does not have to correspond to the version of the
        # log entry that was written to Stackdriver Logging. If omitted, the
        # v2 format is used.
    "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
        # access.  This may be a service account or a group.
        # Examples (Do not assume these specific values):
        #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
        #    "group:cloud-logs@google.com"
        # 
        #   For GCS destinations, the role "roles/owner" is required on the bucket
        #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
        #     required on the topic
        #   For BigQuery, the role "roles/editor" is required on the dataset
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.billingAccounts.html000066400000000000000000000023721300622755700270540ustar00rootroot00000000000000

Stackdriver Logging API . billingAccounts

Instance Methods

logs()

Returns the logs Resource.

google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.billingAccounts.logs.html000066400000000000000000000043621300622755700300200ustar00rootroot00000000000000

Stackdriver Logging API . billingAccounts . logs

Instance Methods

delete(logName=None, x__xgafv=None)

Deletes a log and all its log entries.

Method Details

delete(logName=None, x__xgafv=None) 
Deletes a log and all its log entries.
The log will reappear if it receives new entries.

Args:
  logName: string, Required. The resource name of the log to delete.  Example:
`"projects/my-project/logs/syslog"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.entries.html000066400000000000000000000552701300622755700254120ustar00rootroot00000000000000

Stackdriver Logging API . entries

Instance Methods

list(body, x__xgafv=None)

Lists log entries. Use this method to retrieve log entries from Cloud

write(body, x__xgafv=None)

Writes log entries to Stackdriver Logging. All log entries are

Method Details

list(body, x__xgafv=None) 
Lists log entries.  Use this method to retrieve log entries from Cloud
Logging.  For ways to export log entries, see
[Exporting Logs](/logging/docs/export).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The parameters to `ListLogEntries`.
    "orderBy": "A String", # Optional. How the results should be sorted.  Presently, the only permitted
        # values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
        # option returns entries in order of increasing values of
        # `LogEntry.timestamp` (oldest first), and the second option returns entries
        # in order of decreasing timestamps (newest first).  Entries with equal
        # timestamps are returned in order of `LogEntry.insertId`.
    "resourceNames": [ # Required. One or more cloud resources from which to retrieve log entries.
        # Example: `"projects/my-project-1A"`, `"projects/1234567890"`.  Projects
        # listed in `projectIds` are added to this list.
      "A String",
    ],
    "pageSize": 42, # Optional. The maximum number of results to return from this request.
        # Non-positive values are ignored.  The presence of `nextPageToken` in the
        # response indicates that more results might be available.
    "filter": "A String", # Optional. A filter that chooses which log entries to return.  See [Advanced
        # Logs Filters](/logging/docs/view/advanced_filters).  Only log entries that
        # match the filter are returned.  An empty filter matches all log entries.
    "pageToken": "A String", # Optional. If present, then retrieve the next batch of results from the
        # preceding call to this method.  `pageToken` must be the value of
        # `nextPageToken` from the previous response.  The values of other method
        # parameters should be identical to those in the previous call.
    "projectIds": [ # Deprecated. One or more project identifiers or project numbers from which
        # to retrieve log entries.  Examples: `"my-project-1A"`, `"1234567890"`. If
        # present, these project identifiers are converted to resource format and
        # added to the list of resources in `resourceNames`. Callers should use
        # `resourceNames` rather than this parameter.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Result returned from `ListLogEntries`.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call this
        # method again using the value of `nextPageToken` as `pageToken`.
    "entries": [ # A list of log entries.
      { # An individual entry in a log.
        "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
            # log entry, if applicable.
            # defined by the HTTP specification. Product-specific logging
            # information MUST be defined in a separate message.
          "status": 42, # The response code indicating the status of response.
              # Examples: 200, 404.
          "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
              # being served from cache. This field is only meaningful if `cache_hit` is
              # True.
          "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
          "latency": "A String", # The request processing latency on the server, from the time the request was
              # received until the response was sent.
          "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
              # cache fill was attempted.
          "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
              # portion of the URL that was requested.
              # Example: `"http://example.com/some/info?color=red"`.
          "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
              # sent to.
          "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
          "cacheHit": True or False, # Whether or not an entity was served from cache
              # (with or without validation).
          "referer": "A String", # The referer URL of the request, as defined in
              # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
          "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
              # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
          "userAgent": "A String", # The user agent sent by the client. Example:
              # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
          "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
              # headers and the request body.
          "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
              # including the response headers and the response body.
        },
        "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
            # Example: a log entry that reports a database error would be
            # associated with the monitored resource designating the particular
            # database that reported the error.
            # billing, or other purposes. Examples include virtual machine instances,
            # databases, and storage devices such as disks. The `type` field identifies a
            # MonitoredResourceDescriptor object that describes the resource's
            # schema. Information in the `labels` field identifies the actual resource and
            # its attributes according to the schema. For example, a particular Compute
            # Engine VM instance could be represented by the following object, because the
            # MonitoredResourceDescriptor for `"gce_instance"` has labels
            # `"instance_id"` and `"zone"`:
            #
            #     { "type": "gce_instance",
            #       "labels": { "instance_id": "12345678901234",
            #                   "zone": "us-central1-a" }}
          "labels": { # Required. Values for all of the labels listed in the associated monitored
              # resource descriptor. For example, Cloud SQL databases use the labels
              # `"database_id"` and `"zone"`.
            "a_key": "A String",
          },
          "type": "A String", # Required. The monitored resource type. This field must match
              # the `type` field of a MonitoredResourceDescriptor object. For
              # example, the type of a Cloud SQL database is `"cloudsql_database"`.
        },
        "severity": "A String", # Optional. The severity of the log entry. The default value is
            # `LogSeverity.DEFAULT`.
        "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
        "timestamp": "A String", # Optional. The time the event described by the log entry occurred.  If
            # omitted, Stackdriver Logging will use the time the log entry is received.
        "labels": { # Optional. A set of user-defined (key, value) data that provides additional
            # information about the log entry.
          "a_key": "A String",
        },
        "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
            # field, the logging service considers other log entries in the
            # same project with the same ID as duplicates which can be removed.  If
            # omitted, Stackdriver Logging will generate a unique ID for this
            # log entry.
        "jsonPayload": { # The log entry payload, represented as a structure that
            # is expressed as a JSON object.
          "a_key": "", # Properties of the object.
        },
        "logName": "A String", # Required. The resource name of the log to which this log entry
            # belongs. The format of the name is
            # `"projects//logs/"`.  Examples:
            # `"projects/my-projectid/logs/syslog"`,
            # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
            #
            # The log ID part of resource name must be less than 512 characters
            # long and can only include the following characters: upper and
            # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
            # characters: forward-slash, underscore, hyphen, and period.
            # Forward-slash (`/`) characters in the log ID must be URL-encoded.
        "protoPayload": { # The log entry payload, represented as a protocol buffer.  Some
            # Google Cloud Platform services use this field for their log
            # entry payloads.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
            # applicable.
            # a log entry is associated.
          "last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
          "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
              # same identifier are assumed to be part of the same operation.
          "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
              # `id` and `producer` must be globally unique.  Examples for `producer`:
              # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
          "first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
        },
      },
    ],
  }
write(body, x__xgafv=None) 
Writes log entries to Stackdriver Logging.  All log entries are
written by this method.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The parameters to WriteLogEntries.
    "resource": { # An object representing a resource that can be used for monitoring, logging, # Optional. A default monitored resource object that is assigned to all log
        # entries in `entries` that do not specify a value for `resource`. Example:
        # 
        #     { "type": "gce_instance",
        #       "labels": {
        #         "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
        # 
        # See LogEntry.
        # billing, or other purposes. Examples include virtual machine instances,
        # databases, and storage devices such as disks. The `type` field identifies a
        # MonitoredResourceDescriptor object that describes the resource's
        # schema. Information in the `labels` field identifies the actual resource and
        # its attributes according to the schema. For example, a particular Compute
        # Engine VM instance could be represented by the following object, because the
        # MonitoredResourceDescriptor for `"gce_instance"` has labels
        # `"instance_id"` and `"zone"`:
        #
        #     { "type": "gce_instance",
        #       "labels": { "instance_id": "12345678901234",
        #                   "zone": "us-central1-a" }}
      "labels": { # Required. Values for all of the labels listed in the associated monitored
          # resource descriptor. For example, Cloud SQL databases use the labels
          # `"database_id"` and `"zone"`.
        "a_key": "A String",
      },
      "type": "A String", # Required. The monitored resource type. This field must match
          # the `type` field of a MonitoredResourceDescriptor object. For
          # example, the type of a Cloud SQL database is `"cloudsql_database"`.
    },
    "partialSuccess": True or False, # Optional. Whether valid entries should be written even if some other
        # entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
        # entry is not written, the response status will be the error associated
        # with one of the failed entries and include error details in the form of
        # WriteLogEntriesPartialErrors.
    "labels": { # Optional. Default labels that are added to the `labels` field of all log
        # entries in `entries`. If a log entry already has a label with the same key
        # as a label in this parameter, then the log entry's label is not changed.
        # See LogEntry.
      "a_key": "A String",
    },
    "logName": "A String", # Optional. A default log resource name that is assigned to all log entries
        # in `entries` that do not specify a value for `log_name`.  Example:
        # `"projects/my-project/logs/syslog"`.  See
        # LogEntry.
    "entries": [ # Required. The log entries to write. Values supplied for the fields
        # `log_name`, `resource`, and `labels` in this `entries.write` request are
        # added to those log entries that do not provide their own values for the
        # fields.
        # 
        # To improve throughput and to avoid exceeding the
        # [quota limit](/logging/quota-policy) for calls to `entries.write`,
        # you should write multiple log entries at once rather than
        # calling this method for each individual log entry.
      { # An individual entry in a log.
        "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
            # log entry, if applicable.
            # defined by the HTTP specification. Product-specific logging
            # information MUST be defined in a separate message.
          "status": 42, # The response code indicating the status of response.
              # Examples: 200, 404.
          "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
              # being served from cache. This field is only meaningful if `cache_hit` is
              # True.
          "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
          "latency": "A String", # The request processing latency on the server, from the time the request was
              # received until the response was sent.
          "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
              # cache fill was attempted.
          "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
              # portion of the URL that was requested.
              # Example: `"http://example.com/some/info?color=red"`.
          "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
              # sent to.
          "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
          "cacheHit": True or False, # Whether or not an entity was served from cache
              # (with or without validation).
          "referer": "A String", # The referer URL of the request, as defined in
              # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
          "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
              # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
          "userAgent": "A String", # The user agent sent by the client. Example:
              # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
          "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
              # headers and the request body.
          "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
              # including the response headers and the response body.
        },
        "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
            # Example: a log entry that reports a database error would be
            # associated with the monitored resource designating the particular
            # database that reported the error.
            # billing, or other purposes. Examples include virtual machine instances,
            # databases, and storage devices such as disks. The `type` field identifies a
            # MonitoredResourceDescriptor object that describes the resource's
            # schema. Information in the `labels` field identifies the actual resource and
            # its attributes according to the schema. For example, a particular Compute
            # Engine VM instance could be represented by the following object, because the
            # MonitoredResourceDescriptor for `"gce_instance"` has labels
            # `"instance_id"` and `"zone"`:
            #
            #     { "type": "gce_instance",
            #       "labels": { "instance_id": "12345678901234",
            #                   "zone": "us-central1-a" }}
          "labels": { # Required. Values for all of the labels listed in the associated monitored
              # resource descriptor. For example, Cloud SQL databases use the labels
              # `"database_id"` and `"zone"`.
            "a_key": "A String",
          },
          "type": "A String", # Required. The monitored resource type. This field must match
              # the `type` field of a MonitoredResourceDescriptor object. For
              # example, the type of a Cloud SQL database is `"cloudsql_database"`.
        },
        "severity": "A String", # Optional. The severity of the log entry. The default value is
            # `LogSeverity.DEFAULT`.
        "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
        "timestamp": "A String", # Optional. The time the event described by the log entry occurred.  If
            # omitted, Stackdriver Logging will use the time the log entry is received.
        "labels": { # Optional. A set of user-defined (key, value) data that provides additional
            # information about the log entry.
          "a_key": "A String",
        },
        "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
            # field, the logging service considers other log entries in the
            # same project with the same ID as duplicates which can be removed.  If
            # omitted, Stackdriver Logging will generate a unique ID for this
            # log entry.
        "jsonPayload": { # The log entry payload, represented as a structure that
            # is expressed as a JSON object.
          "a_key": "", # Properties of the object.
        },
        "logName": "A String", # Required. The resource name of the log to which this log entry
            # belongs. The format of the name is
            # `"projects//logs/"`.  Examples:
            # `"projects/my-projectid/logs/syslog"`,
            # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
            #
            # The log ID part of resource name must be less than 512 characters
            # long and can only include the following characters: upper and
            # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
            # characters: forward-slash, underscore, hyphen, and period.
            # Forward-slash (`/`) characters in the log ID must be URL-encoded.
        "protoPayload": { # The log entry payload, represented as a protocol buffer.  Some
            # Google Cloud Platform services use this field for their log
            # entry payloads.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
            # applicable.
            # a log entry is associated.
          "last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
          "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
              # same identifier are assumed to be part of the same operation.
          "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
              # `id` and `producer` must be globally unique.  Examples for `producer`:
              # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
          "first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Result returned from WriteLogEntries.
      # empty
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.html000066400000000000000000000054551300622755700237420ustar00rootroot00000000000000

Stackdriver Logging API

Instance Methods

billingAccounts()

Returns the billingAccounts Resource.

entries()

Returns the entries Resource.

monitoredResourceDescriptors()

Returns the monitoredResourceDescriptors Resource.

organizations()

Returns the organizations Resource.

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html000066400000000000000000000130071300622755700316630ustar00rootroot00000000000000

Stackdriver Logging API . monitoredResourceDescriptors

Instance Methods

list(pageSize=None, pageToken=None, x__xgafv=None)

Lists the monitored resource descriptors used by Stackdriver Logging.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(pageSize=None, pageToken=None, x__xgafv=None) 
Lists the monitored resource descriptors used by Stackdriver Logging.

Args:
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Result returned from ListMonitoredResourceDescriptors.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call this
        # method again using the value of `nextPageToken` as `pageToken`.
    "resourceDescriptors": [ # A list of resource descriptors.
      { # An object that describes the schema of a MonitoredResource object using a
          # type name and a set of labels.  For example, the monitored resource
          # descriptor for Google Compute Engine VM instances has a type of
          # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
          # `"zone"` to identify particular VM instances.
          #
          # Different APIs can support different monitored resource types. APIs generally
          # provide a `list` method that returns the monitored resource descriptors used
          # by the API.
        "type": "A String", # Required. The monitored resource type. For example, the type
            # `"cloudsql_database"` represents databases in Google Cloud SQL.
            # The maximum length of this value is 256 characters.
        "labels": [ # Required. A set of labels used to describe instances of this monitored
            # resource type. For example, an individual Google Cloud SQL database is
            # identified by values for the labels `"database_id"` and `"zone"`.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
            # displayed in user interfaces. It should be a Title Cased Noun Phrase,
            # without any article or other determiners. For example,
            # `"Google Cloud SQL Database"`.
        "description": "A String", # Optional. A detailed description of the monitored resource type that might
            # be used in documentation.
        "name": "A String", # Optional. The resource name of the monitored resource descriptor:
            # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
            # {type} is the value of the `type` field in this object and
            # {project_id} is a project ID that provides API-specific context for
            # accessing the type.  APIs that do not use project information can use the
            # resource name format `"monitoredResourceDescriptors/{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.
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.organizations.html000066400000000000000000000023641300622755700266240ustar00rootroot00000000000000

Stackdriver Logging API . organizations

Instance Methods

logs()

Returns the logs Resource.

google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.organizations.logs.html000066400000000000000000000043541300622755700275700ustar00rootroot00000000000000

Stackdriver Logging API . organizations . logs

Instance Methods

delete(logName=None, x__xgafv=None)

Deletes a log and all its log entries.

Method Details

delete(logName=None, x__xgafv=None) 
Deletes a log and all its log entries.
The log will reappear if it receives new entries.

Args:
  logName: string, Required. The resource name of the log to delete.  Example:
`"projects/my-project/logs/syslog"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.projects.html000066400000000000000000000030431300622755700255610ustar00rootroot00000000000000

Stackdriver Logging API . projects

Instance Methods

logs()

Returns the logs Resource.

metrics()

Returns the metrics Resource.

sinks()

Returns the sinks Resource.

google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.projects.logs.html000066400000000000000000000043351300622755700265310ustar00rootroot00000000000000

Stackdriver Logging API . projects . logs

Instance Methods

delete(logName=None, x__xgafv=None)

Deletes a log and all its log entries.

Method Details

delete(logName=None, x__xgafv=None) 
Deletes a log and all its log entries.
The log will reappear if it receives new entries.

Args:
  logName: string, Required. The resource name of the log to delete.  Example:
`"projects/my-project/logs/syslog"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.projects.metrics.html000066400000000000000000000337571300622755700272450ustar00rootroot00000000000000

Stackdriver Logging API . projects . metrics

Instance Methods

create(parent=None, body, x__xgafv=None)

Creates a logs-based metric.

delete(metricName=None, x__xgafv=None)

Deletes a logs-based metric.

get(metricName=None, x__xgafv=None)

Gets a logs-based metric.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists logs-based metrics.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(metricName=None, body, x__xgafv=None)

Creates or updates a logs-based metric.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a logs-based metric.

Args:
  parent: string, The resource name of the project in which to create the metric.
Example: `"projects/my-project-id"`.

The new metric must be provided in the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a logs-based metric.  The value of the metric is the
      # number of log entries that match a logs filter.
    "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Example: `"resource.type=gae_app AND severity>=ERROR"`.
    "version": "A String", # Output only. The API version that created or updated this metric.
        # The version also dictates the syntax of the filter expression. When a value
        # for this field is missing, the default value of V2 should be assumed.
    "description": "A String", # Optional. A description of this metric, which is used in documentation.
    "name": "A String", # Required. The client-assigned metric identifier. Example:
        # `"severe_errors"`.  Metric identifiers are limited to 100
        # characters and can include only the following characters: `A-Z`,
        # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
        # forward-slash character (`/`) denotes a hierarchy of name pieces,
        # and it cannot be the first character of the name.  The '%' character
        # is used to URL encode unsafe and reserved characters and must be
        # followed by two hexadecimal digits according to RFC 1738.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a logs-based metric.  The value of the metric is the
        # number of log entries that match a logs filter.
      "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Example: `"resource.type=gae_app AND severity>=ERROR"`.
      "version": "A String", # Output only. The API version that created or updated this metric.
          # The version also dictates the syntax of the filter expression. When a value
          # for this field is missing, the default value of V2 should be assumed.
      "description": "A String", # Optional. A description of this metric, which is used in documentation.
      "name": "A String", # Required. The client-assigned metric identifier. Example:
          # `"severe_errors"`.  Metric identifiers are limited to 100
          # characters and can include only the following characters: `A-Z`,
          # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
          # forward-slash character (`/`) denotes a hierarchy of name pieces,
          # and it cannot be the first character of the name.  The '%' character
          # is used to URL encode unsafe and reserved characters and must be
          # followed by two hexadecimal digits according to RFC 1738.
    }
delete(metricName=None, x__xgafv=None) 
Deletes a logs-based metric.

Args:
  metricName: string, The resource name of the metric to delete.
Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(metricName=None, x__xgafv=None) 
Gets a logs-based metric.

Args:
  metricName: string, The resource name of the desired metric.
Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a logs-based metric.  The value of the metric is the
        # number of log entries that match a logs filter.
      "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Example: `"resource.type=gae_app AND severity>=ERROR"`.
      "version": "A String", # Output only. The API version that created or updated this metric.
          # The version also dictates the syntax of the filter expression. When a value
          # for this field is missing, the default value of V2 should be assumed.
      "description": "A String", # Optional. A description of this metric, which is used in documentation.
      "name": "A String", # Required. The client-assigned metric identifier. Example:
          # `"severe_errors"`.  Metric identifiers are limited to 100
          # characters and can include only the following characters: `A-Z`,
          # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
          # forward-slash character (`/`) denotes a hierarchy of name pieces,
          # and it cannot be the first character of the name.  The '%' character
          # is used to URL encode unsafe and reserved characters and must be
          # followed by two hexadecimal digits according to RFC 1738.
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists logs-based metrics.

Args:
  parent: string, Required. The resource name containing the metrics.
Example: `"projects/my-project-id"`. (required)
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.

Returns:
  An object of the form:

    { # Result returned from ListLogMetrics.
    "metrics": [ # A list of logs-based metrics.
      { # Describes a logs-based metric.  The value of the metric is the
            # number of log entries that match a logs filter.
          "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
              # Example: `"resource.type=gae_app AND severity>=ERROR"`.
          "version": "A String", # Output only. The API version that created or updated this metric.
              # The version also dictates the syntax of the filter expression. When a value
              # for this field is missing, the default value of V2 should be assumed.
          "description": "A String", # Optional. A description of this metric, which is used in documentation.
          "name": "A String", # Required. The client-assigned metric identifier. Example:
              # `"severe_errors"`.  Metric identifiers are limited to 100
              # characters and can include only the following characters: `A-Z`,
              # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
              # forward-slash character (`/`) denotes a hierarchy of name pieces,
              # and it cannot be the first character of the name.  The '%' character
              # is used to URL encode unsafe and reserved characters and must be
              # followed by two hexadecimal digits according to RFC 1738.
        },
    ],
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call this
        # method again using the value of `nextPageToken` as `pageToken`.
  }
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(metricName=None, body, x__xgafv=None) 
Creates or updates a logs-based metric.

Args:
  metricName: string, The resource name of the metric to update.
Example: `"projects/my-project-id/metrics/my-metric-id"`.

The updated metric must be provided in the request and have the
same identifier that is specified in `metricName`.
If the metric does not exist, it is created. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a logs-based metric.  The value of the metric is the
      # number of log entries that match a logs filter.
    "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Example: `"resource.type=gae_app AND severity>=ERROR"`.
    "version": "A String", # Output only. The API version that created or updated this metric.
        # The version also dictates the syntax of the filter expression. When a value
        # for this field is missing, the default value of V2 should be assumed.
    "description": "A String", # Optional. A description of this metric, which is used in documentation.
    "name": "A String", # Required. The client-assigned metric identifier. Example:
        # `"severe_errors"`.  Metric identifiers are limited to 100
        # characters and can include only the following characters: `A-Z`,
        # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
        # forward-slash character (`/`) denotes a hierarchy of name pieces,
        # and it cannot be the first character of the name.  The '%' character
        # is used to URL encode unsafe and reserved characters and must be
        # followed by two hexadecimal digits according to RFC 1738.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a logs-based metric.  The value of the metric is the
        # number of log entries that match a logs filter.
      "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Example: `"resource.type=gae_app AND severity>=ERROR"`.
      "version": "A String", # Output only. The API version that created or updated this metric.
          # The version also dictates the syntax of the filter expression. When a value
          # for this field is missing, the default value of V2 should be assumed.
      "description": "A String", # Optional. A description of this metric, which is used in documentation.
      "name": "A String", # Required. The client-assigned metric identifier. Example:
          # `"severe_errors"`.  Metric identifiers are limited to 100
          # characters and can include only the following characters: `A-Z`,
          # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The
          # forward-slash character (`/`) denotes a hierarchy of name pieces,
          # and it cannot be the first character of the name.  The '%' character
          # is used to URL encode unsafe and reserved characters and must be
          # followed by two hexadecimal digits according to RFC 1738.
    }
google-api-python-client-1.5.5/docs/dyn/logging_v2beta1.projects.sinks.html000066400000000000000000000547521300622755700267240ustar00rootroot00000000000000

Stackdriver Logging API . projects . sinks

Instance Methods

create(parent=None, body, x__xgafv=None)

Creates a sink.

delete(sinkName=None, x__xgafv=None)

Deletes a sink.

get(sinkName=None, x__xgafv=None)

Gets a sink.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists sinks.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(sinkName=None, body, x__xgafv=None)

Updates or creates a sink.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a sink.

Args:
  parent: string, Required. The resource in which to create the sink.
Example: `"projects/my-project-id"`.
The new sink must be provided in the request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a sink used to export log entries outside of Stackdriver Logging.
    "endTime": "A String", # Optional. Time at which this sink expires.
    "name": "A String", # Required. The client-assigned sink identifier, unique within the
        # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
        # limited to 1000 characters and can include only the following characters:
        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
        # of the name is 100 characters.
    "destination": "A String", # Required. The export destination. See
        # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
        # Examples:
        # 
        #     "storage.googleapis.com/my-gcs-bucket"
        #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
        #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Only log entries matching the filter are exported. The filter
        # must be consistent with the log entry format specified by the
        # `outputVersionFormat` parameter, regardless of the format of the
        # log entry that was originally written to Stackdriver Logging.
        # Example filter (V2 format):
        # 
        #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
    "startTime": "A String", # Optional. Time range for which this sink is active.
        # Logs are exported only if start_time <= entry.timestamp < end_time
        # Both start_time and end_time may be omitted to specify
        # (half) infinite ranges. The start_time must be less than the end_time.
    "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
        # entries.  This version does not have to correspond to the version of the
        # log entry that was written to Stackdriver Logging. If omitted, the
        # v2 format is used.
    "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
        # access.  This may be a service account or a group.
        # Examples (Do not assume these specific values):
        #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
        #    "group:cloud-logs@google.com"
        # 
        #   For GCS destinations, the role "roles/owner" is required on the bucket
        #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
        #     required on the topic
        #   For BigQuery, the role "roles/editor" is required on the dataset
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
delete(sinkName=None, x__xgafv=None) 
Deletes a sink.

Args:
  sinkName: string, Required. The resource name of the sink to delete, including the parent
resource and the sink identifier.  Example:
`"projects/my-project-id/sinks/my-sink-id"`.  It is an error if the sink
does not exist. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(sinkName=None, x__xgafv=None) 
Gets a sink.

Args:
  sinkName: string, Required. The resource name of the sink to return.
Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists sinks.

Args:
  parent: string, Required. The cloud resource containing the sinks.
Example: `"projects/my-logging-project"`. (required)
  pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method.  `pageToken` must be the value of
`nextPageToken` from the previous response.  The values of other method
parameters should be identical to those in the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored.  The presence of `nextPageToken` in the
response indicates that more results might be available.

Returns:
  An object of the form:

    { # Result returned from `ListSinks`.
    "nextPageToken": "A String", # If there might be more results than appear in this response, then
        # `nextPageToken` is included.  To get the next set of results, call the same
        # method again using the value of `nextPageToken` as `pageToken`.
    "sinks": [ # A list of sinks.
      { # Describes a sink used to export log entries outside of Stackdriver Logging.
          "endTime": "A String", # Optional. Time at which this sink expires.
          "name": "A String", # Required. The client-assigned sink identifier, unique within the
              # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
              # limited to 1000 characters and can include only the following characters:
              # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
              # of the name is 100 characters.
          "destination": "A String", # Required. The export destination. See
              # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
              # Examples:
              #
              #     "storage.googleapis.com/my-gcs-bucket"
              #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
              #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
          "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
              # Only log entries matching the filter are exported. The filter
              # must be consistent with the log entry format specified by the
              # `outputVersionFormat` parameter, regardless of the format of the
              # log entry that was originally written to Stackdriver Logging.
              # Example filter (V2 format):
              #
              #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
          "startTime": "A String", # Optional. Time range for which this sink is active.
              # Logs are exported only if start_time <= entry.timestamp < end_time
              # Both start_time and end_time may be omitted to specify
              # (half) infinite ranges. The start_time must be less than the end_time.
          "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
              # entries.  This version does not have to correspond to the version of the
              # log entry that was written to Stackdriver Logging. If omitted, the
              # v2 format is used.
          "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
              # access.  This may be a service account or a group.
              # Examples (Do not assume these specific values):
              #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
              #    "group:cloud-logs@google.com"
              #
              #   For GCS destinations, the role "roles/owner" is required on the bucket
              #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
              #     required on the topic
              #   For BigQuery, the role "roles/editor" is required on 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.
update(sinkName=None, body, x__xgafv=None) 
Updates or creates a sink.

Args:
  sinkName: string, Required. The resource name of the sink to update, including the parent
resource and the sink identifier.  If the sink does not exist, this method
creates the sink.  Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a sink used to export log entries outside of Stackdriver Logging.
    "endTime": "A String", # Optional. Time at which this sink expires.
    "name": "A String", # Required. The client-assigned sink identifier, unique within the
        # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
        # limited to 1000 characters and can include only the following characters:
        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
        # of the name is 100 characters.
    "destination": "A String", # Required. The export destination. See
        # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
        # Examples:
        # 
        #     "storage.googleapis.com/my-gcs-bucket"
        #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
        #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
        # Only log entries matching the filter are exported. The filter
        # must be consistent with the log entry format specified by the
        # `outputVersionFormat` parameter, regardless of the format of the
        # log entry that was originally written to Stackdriver Logging.
        # Example filter (V2 format):
        # 
        #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
    "startTime": "A String", # Optional. Time range for which this sink is active.
        # Logs are exported only if start_time <= entry.timestamp < end_time
        # Both start_time and end_time may be omitted to specify
        # (half) infinite ranges. The start_time must be less than the end_time.
    "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
        # entries.  This version does not have to correspond to the version of the
        # log entry that was written to Stackdriver Logging. If omitted, the
        # v2 format is used.
    "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
        # access.  This may be a service account or a group.
        # Examples (Do not assume these specific values):
        #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
        #    "group:cloud-logs@google.com"
        # 
        #   For GCS destinations, the role "roles/owner" is required on the bucket
        #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
        #     required on the topic
        #   For BigQuery, the role "roles/editor" is required on the dataset
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a sink used to export log entries outside of Stackdriver Logging.
      "endTime": "A String", # Optional. Time at which this sink expires.
      "name": "A String", # Required. The client-assigned sink identifier, unique within the
          # project. Example: `"my-syslog-errors-to-pubsub"`.  Sink identifiers are
          # limited to 1000 characters and can include only the following characters:
          # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.  The maximum length
          # of the name is 100 characters.
      "destination": "A String", # Required. The export destination. See
          # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
          # Examples:
          #
          #     "storage.googleapis.com/my-gcs-bucket"
          #     "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
          #     "pubsub.googleapis.com/projects/my-project/topics/my-topic"
      "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
          # Only log entries matching the filter are exported. The filter
          # must be consistent with the log entry format specified by the
          # `outputVersionFormat` parameter, regardless of the format of the
          # log entry that was originally written to Stackdriver Logging.
          # Example filter (V2 format):
          #
          #     logName=projects/my-projectid/logs/syslog AND severity>=ERROR
      "startTime": "A String", # Optional. Time range for which this sink is active.
          # Logs are exported only if start_time <= entry.timestamp < end_time
          # Both start_time and end_time may be omitted to specify
          # (half) infinite ranges. The start_time must be less than the end_time.
      "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
          # entries.  This version does not have to correspond to the version of the
          # log entry that was written to Stackdriver Logging. If omitted, the
          # v2 format is used.
      "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
          # access.  This may be a service account or a group.
          # Examples (Do not assume these specific values):
          #    "serviceAccount:cloud-logs@system.gserviceaccount.com"
          #    "group:cloud-logs@google.com"
          #
          #   For GCS destinations, the role "roles/owner" is required on the bucket
          #   For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
          #     required on the topic
          #   For BigQuery, the role "roles/editor" is required on the dataset
    }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.accounts.html000066400000000000000000000047631300622755700245270ustar00rootroot00000000000000

Google Mirror API . accounts

Instance Methods

insert(userToken, accountType, accountName, body)

Inserts a new account for a user

Method Details

insert(userToken, accountType, accountName, body) 
Inserts a new account for a user

Args:
  userToken: string, The ID for the user. (required)
  accountType: string, Account type to be passed to Android Account Manager. (required)
  accountName: string, The name of the account to be passed to the Android Account Manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents an account passed into the Account Manager on Glass.
    "userData": [
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "authTokens": [
      {
        "authToken": "A String",
        "type": "A String",
      },
    ],
    "password": "A String",
    "features": [
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # Represents an account passed into the Account Manager on Glass.
      "userData": [
        {
          "value": "A String",
          "key": "A String",
        },
      ],
      "authTokens": [
        {
          "authToken": "A String",
          "type": "A String",
        },
      ],
      "password": "A String",
      "features": [
        "A String",
      ],
    }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.contacts.html000066400000000000000000000630251300622755700245220ustar00rootroot00000000000000

Google Mirror API . contacts

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",
      ],
      "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",
      ],
      "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.
      "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
          # - ADD_CAPTION
        "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.
      "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
        { # A single menu command that is part of a Contact.
          "type": "A String", # The type of operation this command corresponds to. Allowed values are:
              # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
              # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
        },
      ],
      "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
      "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
    }
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",
    ],
    "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",
    ],
    "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.
    "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
        # - ADD_CAPTION
      "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.
    "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
      { # A single menu command that is part of a Contact.
        "type": "A String", # The type of operation this command corresponds to. Allowed values are:
            # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
            # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
      },
    ],
    "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
    "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
  }


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",
      ],
      "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",
      ],
      "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.
      "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
          # - ADD_CAPTION
        "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.
      "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
        { # A single menu command that is part of a Contact.
          "type": "A String", # The type of operation this command corresponds to. Allowed values are:
              # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
              # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
        },
      ],
      "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
      "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
    }
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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
    ],
    "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",
    ],
    "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",
    ],
    "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.
    "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
        # - ADD_CAPTION
      "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.
    "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
      { # A single menu command that is part of a Contact.
        "type": "A String", # The type of operation this command corresponds to. Allowed values are:
            # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
            # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
      },
    ],
    "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
    "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
  }


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",
      ],
      "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",
      ],
      "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.
      "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
          # - ADD_CAPTION
        "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.
      "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
        { # A single menu command that is part of a Contact.
          "type": "A String", # The type of operation this command corresponds to. Allowed values are:
              # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
              # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
        },
      ],
      "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
      "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
    }
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",
    ],
    "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",
    ],
    "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.
    "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
        # - ADD_CAPTION
      "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.
    "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
      { # A single menu command that is part of a Contact.
        "type": "A String", # The type of operation this command corresponds to. Allowed values are:
            # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
            # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
      },
    ],
    "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
    "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
  }


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",
      ],
      "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",
      ],
      "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.
      "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
          # - ADD_CAPTION
        "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.
      "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
        { # A single menu command that is part of a Contact.
          "type": "A String", # The type of operation this command corresponds to. Allowed values are:
              # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
              # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
        },
      ],
      "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
      "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
    }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.html000066400000000000000000000055161300622755700227060ustar00rootroot00000000000000

Google Mirror API

Instance Methods

accounts()

Returns the accounts Resource.

contacts()

Returns the contacts Resource.

locations()

Returns the locations Resource.

settings()

Returns the settings Resource.

subscriptions()

Returns the subscriptions Resource.

timeline()

Returns the timeline Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/mirror_v1.locations.html000066400000000000000000000066171300622755700247030ustar00rootroot00000000000000

Google Mirror API . locations

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.
  }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.settings.html000066400000000000000000000043111300622755700245350ustar00rootroot00000000000000

Google Mirror API . settings

Instance Methods

get(id=None)

Gets a single setting by ID.

Method Details

get(id=None) 
Gets a single setting by ID.

Args:
  id: string, The ID of the setting. The following IDs are valid: 
- locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. 
- timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles. (required)

Returns:
  An object of the form:

    { # A setting for Glass.
    "kind": "mirror#setting", # The type of resource. This is always mirror#setting.
    "id": "A String", # The setting's ID. The following IDs are valid:
        # - locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content.
        # - timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles.
    "value": "A String", # The setting value, as a string.
  }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.subscriptions.html000066400000000000000000000446201300622755700256130ustar00rootroot00000000000000

Google Mirror API . subscriptions

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.
              # - LAUNCH - the user initiated a voice command.  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.
        # - settings - Settings 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.
                # - LAUNCH - the user initiated a voice command.  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.
          # - settings - Settings 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.
                    # - LAUNCH - the user initiated a voice command.  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.
              # - settings - Settings 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.
              # - LAUNCH - the user initiated a voice command.  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.
        # - settings - Settings 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.
                # - LAUNCH - the user initiated a voice command.  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.
          # - settings - Settings 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://).
    }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.timeline.attachments.html000066400000000000000000000126551300622755700270270ustar00rootroot00000000000000

Google Mirror API . timeline . attachments

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.
  }
google-api-python-client-1.5.5/docs/dyn/mirror_v1.timeline.html000066400000000000000000004477071300622755700245270ustar00rootroot00000000000000

Google Mirror API . timeline

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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
      "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.
          "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
          "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.
          "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
              # - When the action is OPEN_URI, the payload is the URL of the website to view.
              # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
              # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
          "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
            },
          ],
          "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.
              # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
              # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
              # - NAVIGATE - Navigate to the timeline item's location.
              # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
              # - OPEN_URI - Open the payload of the menu item in the browser.
              # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
              # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
              # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
              # - Otherwise, if the creator.email is set, the message is an email.
          "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",
            ],
            "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",
            ],
            "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.
            "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
                # - ADD_CAPTION
              "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.
            "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
              { # A single menu command that is part of a Contact.
                "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                    # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                    # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
              },
            ],
            "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
            "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
          },
      ],
      "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.
      "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",
        ],
        "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",
        ],
        "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.
        "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
            # - ADD_CAPTION
          "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.
        "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
          { # A single menu command that is part of a Contact.
            "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
          },
        ],
        "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
        "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
      },
    "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.
        "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
        "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.
        "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
            # - When the action is OPEN_URI, the payload is the URL of the website to view.
            # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
            # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
        "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
          },
        ],
        "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.
            # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
            # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
            # - NAVIGATE - Navigate to the timeline item's location.
            # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
            # - OPEN_URI - Open the payload of the menu item in the browser.
            # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
            # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
            # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
            # - Otherwise, if the creator.email is set, the message is an email.
        "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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
    ],
    "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.
    "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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
      "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.
          "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
          "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.
          "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
              # - When the action is OPEN_URI, the payload is the URL of the website to view.
              # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
              # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
          "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
            },
          ],
          "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.
              # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
              # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
              # - NAVIGATE - Navigate to the timeline item's location.
              # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
              # - OPEN_URI - Open the payload of the menu item in the browser.
              # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
              # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
              # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
              # - Otherwise, if the creator.email is set, the message is an email.
          "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",
            ],
            "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",
            ],
            "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.
            "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
                # - ADD_CAPTION
              "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.
            "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
              { # A single menu command that is part of a Contact.
                "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                    # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                    # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
              },
            ],
            "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
            "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
          },
      ],
      "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.
      "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",
              ],
              "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",
              ],
              "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.
              "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
                  # - ADD_CAPTION
                "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.
              "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
                { # A single menu command that is part of a Contact.
                  "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                      # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                      # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
                },
              ],
              "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
              "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
            },
          "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.
              "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
              "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.
              "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
                  # - When the action is OPEN_URI, the payload is the URL of the website to view.
                  # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
                  # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
              "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
                },
              ],
              "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.
                  # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
                  # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
                  # - NAVIGATE - Navigate to the timeline item's location.
                  # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
                  # - OPEN_URI - Open the payload of the menu item in the browser.
                  # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
                  # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
                  # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
                  # - Otherwise, if the creator.email is set, the message is an email.
              "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",
                ],
                "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",
                ],
                "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.
                "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
                    # - ADD_CAPTION
                  "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.
                "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
                  { # A single menu command that is part of a Contact.
                    "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                        # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                        # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
                  },
                ],
                "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
                "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
              },
          ],
          "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.
          "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",
        ],
        "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",
        ],
        "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.
        "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
            # - ADD_CAPTION
          "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.
        "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
          { # A single menu command that is part of a Contact.
            "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
          },
        ],
        "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
        "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
      },
    "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.
        "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
        "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.
        "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
            # - When the action is OPEN_URI, the payload is the URL of the website to view.
            # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
            # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
        "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
          },
        ],
        "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.
            # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
            # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
            # - NAVIGATE - Navigate to the timeline item's location.
            # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
            # - OPEN_URI - Open the payload of the menu item in the browser.
            # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
            # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
            # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
            # - Otherwise, if the creator.email is set, the message is an email.
        "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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
    ],
    "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.
    "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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
      "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.
          "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
          "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.
          "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
              # - When the action is OPEN_URI, the payload is the URL of the website to view.
              # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
              # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
          "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
            },
          ],
          "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.
              # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
              # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
              # - NAVIGATE - Navigate to the timeline item's location.
              # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
              # - OPEN_URI - Open the payload of the menu item in the browser.
              # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
              # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
              # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
              # - Otherwise, if the creator.email is set, the message is an email.
          "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",
            ],
            "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",
            ],
            "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.
            "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
                # - ADD_CAPTION
              "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.
            "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
              { # A single menu command that is part of a Contact.
                "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                    # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                    # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
              },
            ],
            "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
            "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
          },
      ],
      "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.
      "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",
        ],
        "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",
        ],
        "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.
        "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
            # - ADD_CAPTION
          "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.
        "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
          { # A single menu command that is part of a Contact.
            "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
          },
        ],
        "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
        "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
      },
    "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.
        "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
        "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.
        "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
            # - When the action is OPEN_URI, the payload is the URL of the website to view.
            # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
            # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
        "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
          },
        ],
        "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.
            # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
            # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
            # - NAVIGATE - Navigate to the timeline item's location.
            # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
            # - OPEN_URI - Open the payload of the menu item in the browser.
            # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
            # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
            # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
            # - Otherwise, if the creator.email is set, the message is an email.
        "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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
    ],
    "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.
    "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",
          ],
          "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",
          ],
          "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.
          "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
              # - ADD_CAPTION
            "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.
          "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
            { # A single menu command that is part of a Contact.
              "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                  # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                  # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
            },
          ],
          "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
          "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
        },
      "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.
          "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
          "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.
          "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action.
              # - When the action is OPEN_URI, the payload is the URL of the website to view.
              # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video
              # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
          "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. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
            },
          ],
          "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.
              # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property.
              # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient.
              # - NAVIGATE - Navigate to the timeline item's location.
              # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
              # - OPEN_URI - Open the payload of the menu item in the browser.
              # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player.
              # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator:
              # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS.
              # - Otherwise, if the creator.email is set, the message is an email.
          "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",
            ],
            "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",
            ],
            "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.
            "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
                # - ADD_CAPTION
              "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.
            "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
              { # A single menu command that is part of a Contact.
                "type": "A String", # The type of operation this command corresponds to. Allowed values are:
                    # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
                    # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
              },
            ],
            "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
            "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
          },
      ],
      "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.
      "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.
    }
google-api-python-client-1.5.5/docs/dyn/ml_v1beta1.html000066400000000000000000000041341300622755700227140ustar00rootroot00000000000000

Google Cloud Machine Learning

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/ml_v1beta1.projects.html000066400000000000000000000312751300622755700245520ustar00rootroot00000000000000

Google Cloud Machine Learning . projects

Instance Methods

jobs()

Returns the jobs Resource.

models()

Returns the models Resource.

operations()

Returns the operations Resource.

getConfig(name=None, x__xgafv=None)

Get the service account information associated with your project. You need

predict(name=None, body, x__xgafv=None)

Performs prediction on the data in the request.

Method Details

getConfig(name=None, x__xgafv=None) 
Get the service account information associated with your project. You need
this information in order to grant the service account persmissions for
the Google Cloud Storage location where you put your model training code
for training the model with Google Cloud Machine Learning.

Args:
  name: string, Required. The project name.

Authorization: requires `Viewer` role on the specified project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Returns service account information associated with a project.
    "serviceAccountProject": "A String", # The project number for `service_account`.
    "serviceAccount": "A String", # The service account Cloud ML uses to access resources in the project.
  }
predict(name=None, body, x__xgafv=None) 
Performs prediction on the data in the request.

Responses are very similar to requests. There are two top-level fields,
each of which are JSON lists:



  
predictions

  
The list of predictions, one per instance in the request.

  
error

  
An error message returned instead of a prediction list if any
      instance produced an error.




If the call is successful, the response body will contain one prediction
entry per instance in the request body. If prediction fails for any
instance, the response body will contain no predictions and will contian
a single error entry instead.

Even though there is one prediction per instance, the format of a
prediction is not directly related to the format of an instance.
Predictions take whatever format is specified in the outputs collection
defined in the model. The collection of predictions is returned in a JSON
list. Each member of the list can be a simple value, a list, or a JSON
object of any complexity. If your model has more than one output tensor,
each prediction will be a JSON object containing a name/value pair for each
output. The names identify the output aliases in the graph.

The following examples show some possible responses:

A simple set of predictions for three input instances, where each
prediction is an integer value:

{"predictions": [5, 4, 3]}


A more complex set of predictions, each containing two named values that
correspond to output tensors, named **label** and **scores** respectively.
The value of **label** is the predicted category ("car" or "beach") and
**scores** contains a list of probabilities for that instance across the
possible categories.

{"predictions": [{"label": "beach", "scores": [0.1, 0.9]},
                 {"label": "car", "scores": [0.75, 0.25]}]}


A response when there is an error processing an input instance:

{"error": "Divide by zero"}



Args:
  name: string, Required. The resource name of a model or a version.

Authorization: requires `Viewer` role on the parent project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for predictions to be issued against a trained model.
      # 
      # The body of the request is a single JSON object with a single top-level
      # field:
      # 
      # 

      #   
instances

      #   
A JSON array containing values representing the instances to use for
      #       prediction.

      # 

      # 
      # The structure of each element of the instances list is determined by your
      # model's input definition. Instances can include named inputs or can contain
      # only unlabeled values.
      # 
      # Most data does not include named inputs. Some instances will be simple
      # JSON values (boolean, number, or string). However, instances are often lists
      # of simple values, or complex nested lists. Here are some examples of request
      # bodies:
      # 
      # CSV data with each row encoded as a string value:
      # 
      # {"instances": ["1.0,true,\\"x\\"", "-2.0,false,\\"y\\""]}
      # 

      # Plain text:
      # 
      # {"instances": ["the quick brown fox", "la bruja le dio"]}
      # 

      # Sentences encoded as lists of words (vectors of strings):
      # 
      # {"instances": [["the","quick","brown"], ["la","bruja","le"]]}
      # 

      # Floating point scalar values:
      # 
      # {"instances": [0.0, 1.1, 2.2]}
      # 

      # Vectors of integers:
      # 
      # {"instances": [[0, 1, 2], [3, 4, 5],...]}
      # 

      # Tensors (in this case, two-dimensional tensors):
      # 
      # {"instances": [[[0, 1, 2], [3, 4, 5]], ...]}
      # 

      # Images represented as a three-dimensional list. In this encoding scheme the
      # first two dimensions represent the rows and columns of the image, and the
      # third contains the R, G, and B values for each pixel.
      # 
      # {"instances": [[[[138, 30, 66], [130, 20, 56], ...]]]]}
      # 

      # Data must be encoded as UTF-8. If your data uses another character encoding,
      # you must base64 encode the data and mark it as binary. To mark a JSON string
      # as binary, replace it with an object with a single attribute named `b`:
      # 
{"b": "..."} 

      # For example:
      # 
      # Two Serialized tf.Examples (fake data, for illustrative purposes only):
      # 
      # {"instances": [{"b64": "X5ad6u"}, {"b64": "IA9j4nx"}]}
      # 

      # Two JPEG image byte strings (fake data, for illustrative purposes only):
      # 
      # {"instances": [{"b64": "ASa8asdf"}, {"b64": "JLK7ljk3"}]}
      # 

      # If your data includes named references, format each instance as a JSON object
      # with the named references as the keys:
      # 
      # JSON input data to be preprocessed:
      # 
      # {"instances": [{"a": 1.0,  "b": true,  "c": "x"},
      #                {"a": -2.0, "b": false, "c": "y"}]}
      # 

      # Some models have an underlying TensorFlow graph that accepts multiple input
      # tensors. In this case, you should use the names of JSON name/value pairs to
      # identify the input tensors, as shown in the following exmaples:
      # 
      # For a graph with input tensor aliases "tag" (string) and "image"
      # (base64-encoded string):
      # 
      # {"instances": [{"tag": "beach", "image": {"b64": "ASa8asdf"}},
      #                {"tag": "car", "image": {"b64": "JLK7ljk3"}}]}
      # 

      # For a graph with input tensor aliases "tag" (string) and "image"
      # (3-dimensional array of 8-bit ints):
      # 
      # {"instances": [{"tag": "beach", "image": [[[263, 1, 10], [262, 2, 11], ...]]},
      #                {"tag": "car", "image": [[[10, 11, 24], [23, 10, 15], ...]]}]}
      # 

      # If the call is successful, the response body will contain one prediction
      # entry per instance in the request body. If prediction fails for any
      # instance, the response body will contain no predictions and will contian
      # a single error entry instead.
    "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for # 
        # Required. The prediction request body.
        # payload formats that can't be represented as JSON, such as raw binary or
        # an HTML page.
        #
        #
        # This message can be used both in streaming and non-streaming API methods in
        # the request as well as the response.
        #
        # It can be used as a top-level request field, which is convenient if one
        # wants to extract parameters from either the URL or HTTP template into the
        # request fields and also want access to the raw HTTP body.
        #
        # Example:
        #
        #     message GetResourceRequest {
        #       // A unique request id.
        #       string request_id = 1;
        #
        #       // The raw HTTP body is bound to this field.
        #       google.api.HttpBody http_body = 2;
        #     }
        #
        #     service ResourceService {
        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
        #       rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
        #     }
        #
        # Example with streaming methods:
        #
        #     service CaldavService {
        #       rpc GetCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #       rpc UpdateCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #     }
        #
        # Use of this type only changes how the request and response bodies are
        # handled, all other features will continue to work unchanged.
      "contentType": "A String", # The HTTP Content-Type string representing the content type of the body.
      "data": "A String", # HTTP body binary data.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for
      # payload formats that can't be represented as JSON, such as raw binary or
      # an HTML page.
      #
      #
      # This message can be used both in streaming and non-streaming API methods in
      # the request as well as the response.
      #
      # It can be used as a top-level request field, which is convenient if one
      # wants to extract parameters from either the URL or HTTP template into the
      # request fields and also want access to the raw HTTP body.
      #
      # Example:
      #
      #     message GetResourceRequest {
      #       // A unique request id.
      #       string request_id = 1;
      #
      #       // The raw HTTP body is bound to this field.
      #       google.api.HttpBody http_body = 2;
      #     }
      #
      #     service ResourceService {
      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
      #       rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
      #     }
      #
      # Example with streaming methods:
      #
      #     service CaldavService {
      #       rpc GetCalendar(stream google.api.HttpBody)
      #         returns (stream google.api.HttpBody);
      #       rpc UpdateCalendar(stream google.api.HttpBody)
      #         returns (stream google.api.HttpBody);
      #     }
      #
      # Use of this type only changes how the request and response bodies are
      # handled, all other features will continue to work unchanged.
    "contentType": "A String", # The HTTP Content-Type string representing the content type of the body.
    "data": "A String", # HTTP body binary data.
  }
google-api-python-client-1.5.5/docs/dyn/ml_v1beta1.projects.jobs.html000066400000000000000000001375231300622755700255110ustar00rootroot00000000000000

Google Cloud Machine Learning . projects . jobs

Instance Methods

cancel(name=None, body, x__xgafv=None)

Cancels a running job.

create(parent=None, body, x__xgafv=None)

Creates a training or a batch prediction job.

get(name=None, x__xgafv=None)

Describes a job.

list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists the jobs in the project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name=None, body, x__xgafv=None) 
Cancels a running job.

Args:
  name: string, Required. The name of the job to cancel.

Authorization: requires `Editor` role on the parent project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the CancelJob method.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
create(parent=None, body, x__xgafv=None) 
Creates a training or a batch prediction job.

Args:
  parent: string, Required. The project name.

Authorization: requires `Editor` role on the specified project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a training or prediction job.
    "trainingOutput": { # Represents results of a training job. # The current training job result.
      "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
      "trials": [ # Results for individual Hyperparameter trials.
        { # Represents the result of a single hyperparameter tuning trial from a
            # training job. The TrainingOutput object that is returned on successful
            # completion of a training job with hyperparameter tuning includes a list
            # of HyperparameterOutput objects, one for each successful trial.
          "hyperparameters": { # The hyperparameters given to this trial.
            "a_key": "A String",
          },
          "trialId": "A String", # The trial id for these results.
          "allMetrics": [ # All recorded object metrics for this trial.
            { # An observed value of a metric.
              "trainingStep": "A String", # The global training step for this metric.
              "objectiveValue": 3.14, # The objective value at this training step.
            },
          ],
          "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
            "trainingStep": "A String", # The global training step for this metric.
            "objectiveValue": 3.14, # The objective value at this training step.
          },
        },
      ],
    },
    "startTime": "A String", # Output only. When the job processing was started.
    "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
    "jobId": "A String", # Required. The user-specified id of the job.
    "state": "A String", # Output only. The detailed state of a job.
    "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
      "modelName": "A String", # Use this field if you want to use the default version for the specified
          # model. The string must use the following format:
          #
          # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"`
      "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
          # May contain wildcards.
        "A String",
      ],
      "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
          # Defaults to 10 if not specified.
      "outputPath": "A String", # Required. The output Google Cloud Storage location.
      "dataFormat": "A String", # Required. The format of the input data files.
      "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
          # string is formatted the same way as `model_version`, with the addition
          # of the version information:
          #
          # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"`
      "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
    },
    "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
      "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
          # job's worker nodes.
          #
          # The supported values are the same as those described in the entry for
          # `masterType`.
          #
          # This value must be present when `scaleTier` is set to `CUSTOM` and
          # `workerCount` is greater than zero.
      "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
          # and parameter servers.
      "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
          # job's master worker.
          #
          # The following types are supported:
          #
          # 

          #   
standard

          #   

          #   A basic machine configuration suitable for training simple models with
          #   small to moderate datasets.
          #   

          #   
large_model

          #   

          #   A machine with a lot of memory, specially suited for parameter servers
          #   when your model is large (having many hidden layers or layers with very
          #   large numbers of nodes).
          #   

          #   
complex_model_s

          #   

          #   A machine suitable for the master and workers of the cluster when your
          #   model requires more computation than the standard machine can handle
          #   satisfactorily.
          #   

          #   
complex_model_m

          #   

          #   A machine with roughly twice the number of cores and roughly double the
          #   memory of complex_model_s.
          #   

          #   
complex_model_l

          #   

          #   A machine with roughly twice the number of cores and roughly double the
          #   memory of complex_model_m.
          #   

          # 

          #
          # You must set this value when `scaleTier` is set to `CUSTOM`.
      "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
        "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
            # the specified hyperparameters.
            #
            # Defaults to one.
        "params": [ # Required. The set of parameters to tune.
          { # Represents a single hyperparameter to optimize.
            "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
                # should be unset if type is `CATEGORICAL`. This value should be integers if
                # type is `INTEGER`.
            "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
                # should be unset if type is `CATEGORICAL`. This value should be integers if
                # type is INTEGER.
            "discreteValues": [ # Required if type is `DISCRETE`.
                # A list of feasible points.
                # The list should be in strictly increasing order. For instance, this
                # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
                # should not contain more than 1,000 values.
              3.14,
            ],
            "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
                # a HyperparameterSpec message. E.g., "learning_rate".
            "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
              "A String",
            ],
            "type": "A String", # Required. The type of the parameter.
            "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
                # Leave unset for categorical parameters.
                # Some kind of scaling is strongly recommended for real or integral
                # parameters (e.g., `UNIT_LINEAR_SCALE`).
          },
        ],
        "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
            # You can reduce the time it takes to perform hyperparameter tuning by adding
            # trials in parallel. However, each trail only benefits from the information
            # gained in completed trials. That means that a trial does not get access to
            # the results of trials running at the same time, which could reduce the
            # quality of the overall optimization.
            #
            # Each trial will use the same scale tier and machine types.
            #
            # Defaults to one.
        "goal": "A String", # Required. The type of goal to use for tuning. Available types are
            # `MAXIMIZE` and `MINIMIZE`.
            #
            # Defaults to `MAXIMIZE`.
      },
      "region": "A String", # Required. The Google Compute Engine region to run the training job in.
      "args": [ # Optional. Command line arguments to pass to the program.
        "A String",
      ],
      "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
      "packageUris": [ # Required. The Google Cloud Storage location of the packages with
          # the training program and any additional dependencies.
        "A String",
      ],
      "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
          # replica in the cluster will be of the type specified in `worker_type`.
          #
          # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
          # set this value, you must also set `worker_type`.
      "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
          # job's parameter server.
          #
          # The supported values are the same as those described in the entry for
          # `master_type`.
          #
          # This value must be present when `scaleTier` is set to `CUSTOM` and
          # `parameter_server_count` is greater than zero.
      "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
          # job. Each replica in the cluster will be of the type specified in
          # `parameter_server_type`.
          #
          # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
          # set this value, you must also set `parameter_server_type`.
    },
    "endTime": "A String", # Output only. When the job processing was completed.
    "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
      "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
      "predictionCount": "A String", # The number of generated predictions.
      "errorCount": "A String", # The number of data instances which resulted in errors.
    },
    "createTime": "A String", # Output only. When the job was created.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a training or prediction job.
      "trainingOutput": { # Represents results of a training job. # The current training job result.
        "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
        "trials": [ # Results for individual Hyperparameter trials.
          { # Represents the result of a single hyperparameter tuning trial from a
              # training job. The TrainingOutput object that is returned on successful
              # completion of a training job with hyperparameter tuning includes a list
              # of HyperparameterOutput objects, one for each successful trial.
            "hyperparameters": { # The hyperparameters given to this trial.
              "a_key": "A String",
            },
            "trialId": "A String", # The trial id for these results.
            "allMetrics": [ # All recorded object metrics for this trial.
              { # An observed value of a metric.
                "trainingStep": "A String", # The global training step for this metric.
                "objectiveValue": 3.14, # The objective value at this training step.
              },
            ],
            "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
              "trainingStep": "A String", # The global training step for this metric.
              "objectiveValue": 3.14, # The objective value at this training step.
            },
          },
        ],
      },
      "startTime": "A String", # Output only. When the job processing was started.
      "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
      "jobId": "A String", # Required. The user-specified id of the job.
      "state": "A String", # Output only. The detailed state of a job.
      "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
        "modelName": "A String", # Use this field if you want to use the default version for the specified
            # model. The string must use the following format:
            #
            # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"`
        "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
            # May contain wildcards.
          "A String",
        ],
        "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
            # Defaults to 10 if not specified.
        "outputPath": "A String", # Required. The output Google Cloud Storage location.
        "dataFormat": "A String", # Required. The format of the input data files.
        "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
            # string is formatted the same way as `model_version`, with the addition
            # of the version information:
            #
            # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"`
        "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
      },
      "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
        "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
            # job's worker nodes.
            #
            # The supported values are the same as those described in the entry for
            # `masterType`.
            #
            # This value must be present when `scaleTier` is set to `CUSTOM` and
            # `workerCount` is greater than zero.
        "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
            # and parameter servers.
        "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
            # job's master worker.
            #
            # The following types are supported:
            #
            # 

            #   
standard

            #   

            #   A basic machine configuration suitable for training simple models with
            #   small to moderate datasets.
            #   

            #   
large_model

            #   

            #   A machine with a lot of memory, specially suited for parameter servers
            #   when your model is large (having many hidden layers or layers with very
            #   large numbers of nodes).
            #   

            #   
complex_model_s

            #   

            #   A machine suitable for the master and workers of the cluster when your
            #   model requires more computation than the standard machine can handle
            #   satisfactorily.
            #   

            #   
complex_model_m

            #   

            #   A machine with roughly twice the number of cores and roughly double the
            #   memory of complex_model_s.
            #   

            #   
complex_model_l

            #   

            #   A machine with roughly twice the number of cores and roughly double the
            #   memory of complex_model_m.
            #   

            # 

            #
            # You must set this value when `scaleTier` is set to `CUSTOM`.
        "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
          "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
              # the specified hyperparameters.
              #
              # Defaults to one.
          "params": [ # Required. The set of parameters to tune.
            { # Represents a single hyperparameter to optimize.
              "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
                  # should be unset if type is `CATEGORICAL`. This value should be integers if
                  # type is `INTEGER`.
              "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
                  # should be unset if type is `CATEGORICAL`. This value should be integers if
                  # type is INTEGER.
              "discreteValues": [ # Required if type is `DISCRETE`.
                  # A list of feasible points.
                  # The list should be in strictly increasing order. For instance, this
                  # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
                  # should not contain more than 1,000 values.
                3.14,
              ],
              "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
                  # a HyperparameterSpec message. E.g., "learning_rate".
              "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
                "A String",
              ],
              "type": "A String", # Required. The type of the parameter.
              "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
                  # Leave unset for categorical parameters.
                  # Some kind of scaling is strongly recommended for real or integral
                  # parameters (e.g., `UNIT_LINEAR_SCALE`).
            },
          ],
          "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
              # You can reduce the time it takes to perform hyperparameter tuning by adding
              # trials in parallel. However, each trail only benefits from the information
              # gained in completed trials. That means that a trial does not get access to
              # the results of trials running at the same time, which could reduce the
              # quality of the overall optimization.
              #
              # Each trial will use the same scale tier and machine types.
              #
              # Defaults to one.
          "goal": "A String", # Required. The type of goal to use for tuning. Available types are
              # `MAXIMIZE` and `MINIMIZE`.
              #
              # Defaults to `MAXIMIZE`.
        },
        "region": "A String", # Required. The Google Compute Engine region to run the training job in.
        "args": [ # Optional. Command line arguments to pass to the program.
          "A String",
        ],
        "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
        "packageUris": [ # Required. The Google Cloud Storage location of the packages with
            # the training program and any additional dependencies.
          "A String",
        ],
        "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
            # replica in the cluster will be of the type specified in `worker_type`.
            #
            # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
            # set this value, you must also set `worker_type`.
        "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
            # job's parameter server.
            #
            # The supported values are the same as those described in the entry for
            # `master_type`.
            #
            # This value must be present when `scaleTier` is set to `CUSTOM` and
            # `parameter_server_count` is greater than zero.
        "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
            # job. Each replica in the cluster will be of the type specified in
            # `parameter_server_type`.
            #
            # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
            # set this value, you must also set `parameter_server_type`.
      },
      "endTime": "A String", # Output only. When the job processing was completed.
      "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
        "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
        "predictionCount": "A String", # The number of generated predictions.
        "errorCount": "A String", # The number of data instances which resulted in errors.
      },
      "createTime": "A String", # Output only. When the job was created.
    }
get(name=None, x__xgafv=None) 
Describes a job.

Args:
  name: string, Required. The name of the job to get the description of.

Authorization: requires `Viewer` role on the parent project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a training or prediction job.
      "trainingOutput": { # Represents results of a training job. # The current training job result.
        "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
        "trials": [ # Results for individual Hyperparameter trials.
          { # Represents the result of a single hyperparameter tuning trial from a
              # training job. The TrainingOutput object that is returned on successful
              # completion of a training job with hyperparameter tuning includes a list
              # of HyperparameterOutput objects, one for each successful trial.
            "hyperparameters": { # The hyperparameters given to this trial.
              "a_key": "A String",
            },
            "trialId": "A String", # The trial id for these results.
            "allMetrics": [ # All recorded object metrics for this trial.
              { # An observed value of a metric.
                "trainingStep": "A String", # The global training step for this metric.
                "objectiveValue": 3.14, # The objective value at this training step.
              },
            ],
            "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
              "trainingStep": "A String", # The global training step for this metric.
              "objectiveValue": 3.14, # The objective value at this training step.
            },
          },
        ],
      },
      "startTime": "A String", # Output only. When the job processing was started.
      "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
      "jobId": "A String", # Required. The user-specified id of the job.
      "state": "A String", # Output only. The detailed state of a job.
      "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
        "modelName": "A String", # Use this field if you want to use the default version for the specified
            # model. The string must use the following format:
            #
            # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"`
        "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
            # May contain wildcards.
          "A String",
        ],
        "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
            # Defaults to 10 if not specified.
        "outputPath": "A String", # Required. The output Google Cloud Storage location.
        "dataFormat": "A String", # Required. The format of the input data files.
        "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
            # string is formatted the same way as `model_version`, with the addition
            # of the version information:
            #
            # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"`
        "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
      },
      "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
        "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
            # job's worker nodes.
            #
            # The supported values are the same as those described in the entry for
            # `masterType`.
            #
            # This value must be present when `scaleTier` is set to `CUSTOM` and
            # `workerCount` is greater than zero.
        "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
            # and parameter servers.
        "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
            # job's master worker.
            #
            # The following types are supported:
            #
            # 

            #   
standard

            #   

            #   A basic machine configuration suitable for training simple models with
            #   small to moderate datasets.
            #   

            #   
large_model

            #   

            #   A machine with a lot of memory, specially suited for parameter servers
            #   when your model is large (having many hidden layers or layers with very
            #   large numbers of nodes).
            #   

            #   
complex_model_s

            #   

            #   A machine suitable for the master and workers of the cluster when your
            #   model requires more computation than the standard machine can handle
            #   satisfactorily.
            #   

            #   
complex_model_m

            #   

            #   A machine with roughly twice the number of cores and roughly double the
            #   memory of complex_model_s.
            #   

            #   
complex_model_l

            #   

            #   A machine with roughly twice the number of cores and roughly double the
            #   memory of complex_model_m.
            #   

            # 

            #
            # You must set this value when `scaleTier` is set to `CUSTOM`.
        "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
          "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
              # the specified hyperparameters.
              #
              # Defaults to one.
          "params": [ # Required. The set of parameters to tune.
            { # Represents a single hyperparameter to optimize.
              "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
                  # should be unset if type is `CATEGORICAL`. This value should be integers if
                  # type is `INTEGER`.
              "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
                  # should be unset if type is `CATEGORICAL`. This value should be integers if
                  # type is INTEGER.
              "discreteValues": [ # Required if type is `DISCRETE`.
                  # A list of feasible points.
                  # The list should be in strictly increasing order. For instance, this
                  # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
                  # should not contain more than 1,000 values.
                3.14,
              ],
              "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
                  # a HyperparameterSpec message. E.g., "learning_rate".
              "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
                "A String",
              ],
              "type": "A String", # Required. The type of the parameter.
              "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
                  # Leave unset for categorical parameters.
                  # Some kind of scaling is strongly recommended for real or integral
                  # parameters (e.g., `UNIT_LINEAR_SCALE`).
            },
          ],
          "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
              # You can reduce the time it takes to perform hyperparameter tuning by adding
              # trials in parallel. However, each trail only benefits from the information
              # gained in completed trials. That means that a trial does not get access to
              # the results of trials running at the same time, which could reduce the
              # quality of the overall optimization.
              #
              # Each trial will use the same scale tier and machine types.
              #
              # Defaults to one.
          "goal": "A String", # Required. The type of goal to use for tuning. Available types are
              # `MAXIMIZE` and `MINIMIZE`.
              #
              # Defaults to `MAXIMIZE`.
        },
        "region": "A String", # Required. The Google Compute Engine region to run the training job in.
        "args": [ # Optional. Command line arguments to pass to the program.
          "A String",
        ],
        "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
        "packageUris": [ # Required. The Google Cloud Storage location of the packages with
            # the training program and any additional dependencies.
          "A String",
        ],
        "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
            # replica in the cluster will be of the type specified in `worker_type`.
            #
            # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
            # set this value, you must also set `worker_type`.
        "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
            # job's parameter server.
            #
            # The supported values are the same as those described in the entry for
            # `master_type`.
            #
            # This value must be present when `scaleTier` is set to `CUSTOM` and
            # `parameter_server_count` is greater than zero.
        "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
            # job. Each replica in the cluster will be of the type specified in
            # `parameter_server_type`.
            #
            # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
            # set this value, you must also set `parameter_server_type`.
      },
      "endTime": "A String", # Output only. When the job processing was completed.
      "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
        "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
        "predictionCount": "A String", # The number of generated predictions.
        "errorCount": "A String", # The number of data instances which resulted in errors.
      },
      "createTime": "A String", # Output only. When the job was created.
    }
list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists the jobs in the project.

Args:
  parent: string, Required. The name of the project for which to list jobs.

Authorization: requires `Viewer` role on the specified project. (required)
  pageSize: integer, Optional. The number of jobs to retrieve per "page" of results. If there
are more remaining results than this number, the response message will
contain a valid value in the `next_page_token` field.

The default value is 20, and the maximum page size is 100.
  filter: string, Optional. Specifies the subset of jobs to retrieve.
  pageToken: string, Optional. A page token to request the next page of results.

You get the token from the `next_page_token` field of the response from
the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the ListJobs method.
    "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
        # subsequent call.
    "jobs": [ # The list of jobs.
      { # Represents a training or prediction job.
          "trainingOutput": { # Represents results of a training job. # The current training job result.
            "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
            "trials": [ # Results for individual Hyperparameter trials.
              { # Represents the result of a single hyperparameter tuning trial from a
                  # training job. The TrainingOutput object that is returned on successful
                  # completion of a training job with hyperparameter tuning includes a list
                  # of HyperparameterOutput objects, one for each successful trial.
                "hyperparameters": { # The hyperparameters given to this trial.
                  "a_key": "A String",
                },
                "trialId": "A String", # The trial id for these results.
                "allMetrics": [ # All recorded object metrics for this trial.
                  { # An observed value of a metric.
                    "trainingStep": "A String", # The global training step for this metric.
                    "objectiveValue": 3.14, # The objective value at this training step.
                  },
                ],
                "finalMetric": { # An observed value of a metric. # The final objective metric seen for this trial.
                  "trainingStep": "A String", # The global training step for this metric.
                  "objectiveValue": 3.14, # The objective value at this training step.
                },
              },
            ],
          },
          "startTime": "A String", # Output only. When the job processing was started.
          "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
          "jobId": "A String", # Required. The user-specified id of the job.
          "state": "A String", # Output only. The detailed state of a job.
          "predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
            "modelName": "A String", # Use this field if you want to use the default version for the specified
                # model. The string must use the following format:
                #
                # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"`
            "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
                # May contain wildcards.
              "A String",
            ],
            "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
                # Defaults to 10 if not specified.
            "outputPath": "A String", # Required. The output Google Cloud Storage location.
            "dataFormat": "A String", # Required. The format of the input data files.
            "versionName": "A String", # Use this field if you want to specify a version of the model to use. The
                # string is formatted the same way as `model_version`, with the addition
                # of the version information:
                #
                # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[YOUR_VERSION]"`
            "region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
          },
          "trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
            "workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
                # job's worker nodes.
                #
                # The supported values are the same as those described in the entry for
                # `masterType`.
                #
                # This value must be present when `scaleTier` is set to `CUSTOM` and
                # `workerCount` is greater than zero.
            "scaleTier": "A String", # Required. Specifies the machine types, the number of replicas for workers
                # and parameter servers.
            "masterType": "A String", # Optional. Specifies the type of virtual machine to use for your training
                # job's master worker.
                #
                # The following types are supported:
                #
                # 

                #   
standard

                #   

                #   A basic machine configuration suitable for training simple models with
                #   small to moderate datasets.
                #   

                #   
large_model

                #   

                #   A machine with a lot of memory, specially suited for parameter servers
                #   when your model is large (having many hidden layers or layers with very
                #   large numbers of nodes).
                #   

                #   
complex_model_s

                #   

                #   A machine suitable for the master and workers of the cluster when your
                #   model requires more computation than the standard machine can handle
                #   satisfactorily.
                #   

                #   
complex_model_m

                #   

                #   A machine with roughly twice the number of cores and roughly double the
                #   memory of complex_model_s.
                #   

                #   
complex_model_l

                #   

                #   A machine with roughly twice the number of cores and roughly double the
                #   memory of complex_model_m.
                #   

                # 

                #
                # You must set this value when `scaleTier` is set to `CUSTOM`.
            "hyperparameters": { # Represents a set of hyperparameters to optimize. # Optional. The set of Hyperparameters to tune.
              "maxTrials": 42, # Optional. How many training trials should be attempted to optimize
                  # the specified hyperparameters.
                  #
                  # Defaults to one.
              "params": [ # Required. The set of parameters to tune.
                { # Represents a single hyperparameter to optimize.
                  "maxValue": 3.14, # Required if typeis `DOUBLE` or `INTEGER`. This field
                      # should be unset if type is `CATEGORICAL`. This value should be integers if
                      # type is `INTEGER`.
                  "minValue": 3.14, # Required if type is `DOUBLE` or `INTEGER`. This field
                      # should be unset if type is `CATEGORICAL`. This value should be integers if
                      # type is INTEGER.
                  "discreteValues": [ # Required if type is `DISCRETE`.
                      # A list of feasible points.
                      # The list should be in strictly increasing order. For instance, this
                      # parameter might have possible settings of 1.5, 2.5, and 4.0. This list
                      # should not contain more than 1,000 values.
                    3.14,
                  ],
                  "parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
                      # a HyperparameterSpec message. E.g., "learning_rate".
                  "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
                    "A String",
                  ],
                  "type": "A String", # Required. The type of the parameter.
                  "scaleType": "A String", # Optional. How the parameter should be scaled to the hypercube.
                      # Leave unset for categorical parameters.
                      # Some kind of scaling is strongly recommended for real or integral
                      # parameters (e.g., `UNIT_LINEAR_SCALE`).
                },
              ],
              "maxParallelTrials": 42, # Optional. The number of training trials to run concurrently.
                  # You can reduce the time it takes to perform hyperparameter tuning by adding
                  # trials in parallel. However, each trail only benefits from the information
                  # gained in completed trials. That means that a trial does not get access to
                  # the results of trials running at the same time, which could reduce the
                  # quality of the overall optimization.
                  #
                  # Each trial will use the same scale tier and machine types.
                  #
                  # Defaults to one.
              "goal": "A String", # Required. The type of goal to use for tuning. Available types are
                  # `MAXIMIZE` and `MINIMIZE`.
                  #
                  # Defaults to `MAXIMIZE`.
            },
            "region": "A String", # Required. The Google Compute Engine region to run the training job in.
            "args": [ # Optional. Command line arguments to pass to the program.
              "A String",
            ],
            "pythonModule": "A String", # Required. The Python module name to run after installing the packages.
            "packageUris": [ # Required. The Google Cloud Storage location of the packages with
                # the training program and any additional dependencies.
              "A String",
            ],
            "workerCount": "A String", # Optional. The number of worker replicas to use for the training job. Each
                # replica in the cluster will be of the type specified in `worker_type`.
                #
                # This value can only be used when `scale_tier` is set to `CUSTOM`. If you
                # set this value, you must also set `worker_type`.
            "parameterServerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
                # job's parameter server.
                #
                # The supported values are the same as those described in the entry for
                # `master_type`.
                #
                # This value must be present when `scaleTier` is set to `CUSTOM` and
                # `parameter_server_count` is greater than zero.
            "parameterServerCount": "A String", # Optional. The number of parameter server replicas to use for the training
                # job. Each replica in the cluster will be of the type specified in
                # `parameter_server_type`.
                #
                # This value can only be used when `scale_tier` is set to `CUSTOM`.If you
                # set this value, you must also set `parameter_server_type`.
          },
          "endTime": "A String", # Output only. When the job processing was completed.
          "predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
            "outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
            "predictionCount": "A String", # The number of generated predictions.
            "errorCount": "A String", # The number of data instances which resulted in errors.
          },
          "createTime": "A String", # Output only. When the job was created.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/ml_v1beta1.projects.models.html000066400000000000000000000537511300622755700260370ustar00rootroot00000000000000

Google Cloud Machine Learning . projects . models

Instance Methods

versions()

Returns the versions Resource.

create(parent=None, body, x__xgafv=None)

Creates a model which will later contain one or more versions.

delete(name=None, x__xgafv=None)

Deletes a model.

get(name=None, x__xgafv=None)

Gets information about a model, including its name, the description (if

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists the models in a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a model which will later contain one or more versions.

You must add at least one version before you can request predictions from
the model. Add versions by calling
[projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create).

Args:
  parent: string, Required. The project name.

Authorization: requires `Editor` role on the specified project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a machine learning solution.
      # 
      # A model can have multiple versions, each of which is a deployed, trained
      # model ready to receive prediction requests. The model itself is just a
      # container.
    "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
        # handle prediction requests that do not specify a version.
        # 
        # You can change the default version by calling
        # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
        #
        # Each version is a trained model deployed in the cloud, ready to handle
        # prediction requests. A model can have multiple versions. You can get
        # information about all of the versions of a given model by calling
        # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
      "description": "A String", # Optional. The description specified for the version when it was created.
      "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
      "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
          # create the version. See the
          # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
          # more informaiton.
          #
          # When passing Version to
          # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
          # the model service uses the specified location as the source of the model.
          # Once deployed, the model version is hosted by the prediction service, so
          # this location is useful only as a historical record.
      "createTime": "A String", # Output only. The time the version was created.
      "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
          # requests that do not specify a version.
          #
          # You can change the default version by calling
          # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
      "name": "A String", # Required.The name specified for the version when it was created.
          #
          # The version name must be unique within the model it is created in.
    },
    "description": "A String", # Optional. The description specified for the model when it was created.
    "name": "A String", # Required. The name specified for the model when it was created.
        # 
        # The model name must be unique within the project it is created in.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a machine learning solution.
        #
        # A model can have multiple versions, each of which is a deployed, trained
        # model ready to receive prediction requests. The model itself is just a
        # container.
      "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
          # handle prediction requests that do not specify a version.
          #
          # You can change the default version by calling
          # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
          #
          # Each version is a trained model deployed in the cloud, ready to handle
          # prediction requests. A model can have multiple versions. You can get
          # information about all of the versions of a given model by calling
          # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
        "description": "A String", # Optional. The description specified for the version when it was created.
        "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
        "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
            # create the version. See the
            # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
            # more informaiton.
            #
            # When passing Version to
            # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
            # the model service uses the specified location as the source of the model.
            # Once deployed, the model version is hosted by the prediction service, so
            # this location is useful only as a historical record.
        "createTime": "A String", # Output only. The time the version was created.
        "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
            # requests that do not specify a version.
            #
            # You can change the default version by calling
            # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
        "name": "A String", # Required.The name specified for the version when it was created.
            #
            # The version name must be unique within the model it is created in.
      },
      "description": "A String", # Optional. The description specified for the model when it was created.
      "name": "A String", # Required. The name specified for the model when it was created.
          #
          # The model name must be unique within the project it is created in.
    }
delete(name=None, x__xgafv=None) 
Deletes a model.

You can only delete a model if there are no versions in it. You can delete
versions by calling
[projects.models.versions.delete](/ml/reference/rest/v1beta1/projects.models.versions/delete).

Args:
  name: string, Required. The name of the model.

Authorization: requires `Editor` role on the parent project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
get(name=None, x__xgafv=None) 
Gets information about a model, including its name, the description (if
set), and the default version (if at least one version of the model has
been deployed).

Args:
  name: string, Required. The name of the model.

Authorization: requires `Viewer` role on the parent project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a machine learning solution.
        #
        # A model can have multiple versions, each of which is a deployed, trained
        # model ready to receive prediction requests. The model itself is just a
        # container.
      "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
          # handle prediction requests that do not specify a version.
          #
          # You can change the default version by calling
          # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
          #
          # Each version is a trained model deployed in the cloud, ready to handle
          # prediction requests. A model can have multiple versions. You can get
          # information about all of the versions of a given model by calling
          # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
        "description": "A String", # Optional. The description specified for the version when it was created.
        "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
        "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
            # create the version. See the
            # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
            # more informaiton.
            #
            # When passing Version to
            # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
            # the model service uses the specified location as the source of the model.
            # Once deployed, the model version is hosted by the prediction service, so
            # this location is useful only as a historical record.
        "createTime": "A String", # Output only. The time the version was created.
        "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
            # requests that do not specify a version.
            #
            # You can change the default version by calling
            # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
        "name": "A String", # Required.The name specified for the version when it was created.
            #
            # The version name must be unique within the model it is created in.
      },
      "description": "A String", # Optional. The description specified for the model when it was created.
      "name": "A String", # Required. The name specified for the model when it was created.
          #
          # The model name must be unique within the project it is created in.
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists the models in a project.

Each project can contain multiple models, and each model can have multiple
versions.

Args:
  parent: string, Required. The name of the project whose models are to be listed.

Authorization: requires `Viewer` role on the specified project. (required)
  pageToken: string, Optional. A page token to request the next page of results.

You get the token from the `next_page_token` field of the response from
the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The number of models to retrieve per "page" of results. If there
are more remaining results than this number, the response message will
contain a valid value in the `next_page_token` field.

The default value is 20, and the maximum page size is 100.

Returns:
  An object of the form:

    { # Response message for the ListModels method.
    "models": [ # The list of models.
      { # Represents a machine learning solution.
            #
            # A model can have multiple versions, each of which is a deployed, trained
            # model ready to receive prediction requests. The model itself is just a
            # container.
          "defaultVersion": { # Represents a version of the model. # Output only. The default version of the model. This version will be used to
              # handle prediction requests that do not specify a version.
              #
              # You can change the default version by calling
              # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
              #
              # Each version is a trained model deployed in the cloud, ready to handle
              # prediction requests. A model can have multiple versions. You can get
              # information about all of the versions of a given model by calling
              # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
            "description": "A String", # Optional. The description specified for the version when it was created.
            "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
            "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
                # create the version. See the
                # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
                # more informaiton.
                #
                # When passing Version to
                # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
                # the model service uses the specified location as the source of the model.
                # Once deployed, the model version is hosted by the prediction service, so
                # this location is useful only as a historical record.
            "createTime": "A String", # Output only. The time the version was created.
            "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
                # requests that do not specify a version.
                #
                # You can change the default version by calling
                # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
            "name": "A String", # Required.The name specified for the version when it was created.
                #
                # The version name must be unique within the model it is created in.
          },
          "description": "A String", # Optional. The description specified for the model when it was created.
          "name": "A String", # Required. The name specified for the model when it was created.
              #
              # The model name must be unique within the project it is created in.
        },
    ],
    "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
        # subsequent call.
  }
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.
google-api-python-client-1.5.5/docs/dyn/ml_v1beta1.projects.models.versions.html000066400000000000000000000620541300622755700277020ustar00rootroot00000000000000

Google Cloud Machine Learning . projects . models . versions

Instance Methods

create(parent=None, body, x__xgafv=None)

Creates a new version of a model from a trained TensorFlow model.

delete(name=None, x__xgafv=None)

Deletes a model version.

get(name=None, x__xgafv=None)

Gets information about a model version.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Gets basic information about all the versions of a model.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setDefault(name=None, body, x__xgafv=None)

Designates a version to be the default for the model.

Method Details

create(parent=None, body, x__xgafv=None) 
Creates a new version of a model from a trained TensorFlow model.

If the version created in the cloud by this call is the first deployed
version of the specified model, it will be made the default version of the
model. When you add a version to a model that already has one or more
versions, the default version does not automatically change. If you want a
new version to be the default, you must call
[projects.models.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).

Args:
  parent: string, Required. The name of the model.

Authorization: requires `Editor` role on the parent project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a version of the model.
    # 
    # Each version is a trained model deployed in the cloud, ready to handle
    # prediction requests. A model can have multiple versions. You can get
    # information about all of the versions of a given model by calling
    # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
  "description": "A String", # Optional. The description specified for the version when it was created.
  "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
  "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
      # create the version. See the
      # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
      # more informaiton.
      # 
      # When passing Version to
      # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
      # the model service uses the specified location as the source of the model.
      # Once deployed, the model version is hosted by the prediction service, so
      # this location is useful only as a historical record.
  "createTime": "A String", # Output only. The time the version was created.
  "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
      # requests that do not specify a version.
      # 
      # You can change the default version by calling
      # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
  "name": "A String", # Required.The name specified for the version when it was created.
      # 
      # The version name must be unique within the model it is created in.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
delete(name=None, x__xgafv=None) 
Deletes a model version.

Each model can have multiple versions deployed and in use at any given
time. Use this method to remove a single version.

Note: You cannot delete the version that is set as the default version
of the model unless it is the only remaining version.

Args:
  name: string, Required. The name of the version. You can get the names of all the
versions of a model by calling
[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).

Authorization: requires `Editor` role on the parent project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
get(name=None, x__xgafv=None) 
Gets information about a model version.

Models can have multiple versions. You can call
[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list)
to get the same information that this method returns for all of the
versions of a model.

Args:
  name: string, Required. The name of the version.

Authorization: requires `Viewer` role on the parent project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a version of the model.
      #
      # Each version is a trained model deployed in the cloud, ready to handle
      # prediction requests. A model can have multiple versions. You can get
      # information about all of the versions of a given model by calling
      # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
    "description": "A String", # Optional. The description specified for the version when it was created.
    "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
    "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
        # create the version. See the
        # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
        # more informaiton.
        #
        # When passing Version to
        # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
        # the model service uses the specified location as the source of the model.
        # Once deployed, the model version is hosted by the prediction service, so
        # this location is useful only as a historical record.
    "createTime": "A String", # Output only. The time the version was created.
    "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
        # requests that do not specify a version.
        #
        # You can change the default version by calling
        # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
    "name": "A String", # Required.The name specified for the version when it was created.
        #
        # The version name must be unique within the model it is created in.
  }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Gets basic information about all the versions of a model.

If you expect that a model has a lot of versions, or if you need to handle
only a limited number of results at a time, you can request that the list
be retrieved in batches (called pages):

Args:
  parent: string, Required. The name of the model for which to list the version.

Authorization: requires `Viewer` role on the parent project. (required)
  pageToken: string, Optional. A page token to request the next page of results.

You get the token from the `next_page_token` field of the response from
the previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Optional. The number of versions to retrieve per "page" of results. If
there are more remaining results than this number, the response message
will contain a valid value in the `next_page_token` field.

The default value is 20, and the maximum page size is 100.

Returns:
  An object of the form:

    { # Response message for the ListVersions method.
    "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
        # subsequent call.
    "versions": [ # The list of versions.
      { # Represents a version of the model.
          #
          # Each version is a trained model deployed in the cloud, ready to handle
          # prediction requests. A model can have multiple versions. You can get
          # information about all of the versions of a given model by calling
          # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
        "description": "A String", # Optional. The description specified for the version when it was created.
        "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
        "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
            # create the version. See the
            # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
            # more informaiton.
            #
            # When passing Version to
            # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
            # the model service uses the specified location as the source of the model.
            # Once deployed, the model version is hosted by the prediction service, so
            # this location is useful only as a historical record.
        "createTime": "A String", # Output only. The time the version was created.
        "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
            # requests that do not specify a version.
            #
            # You can change the default version by calling
            # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
        "name": "A String", # Required.The name specified for the version when it was created.
            #
            # The version name must be unique within the model it is created in.
      },
    ],
  }
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.
setDefault(name=None, body, x__xgafv=None) 
Designates a version to be the default for the model.

The default version is used for prediction requests made against the model
that don't specify a version.

The first version to be created for a model is automatically set as the
default. You must make any subsequent changes to the default version
setting manually using this method.

Args:
  name: string, Required. The name of the version to make the default for the model. You
can get the names of all the versions of a model by calling
[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).

Authorization: requires `Editor` role on the parent project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the SetDefaultVersion request.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a version of the model.
      #
      # Each version is a trained model deployed in the cloud, ready to handle
      # prediction requests. A model can have multiple versions. You can get
      # information about all of the versions of a given model by calling
      # [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
    "description": "A String", # Optional. The description specified for the version when it was created.
    "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
    "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
        # create the version. See the
        # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
        # more informaiton.
        #
        # When passing Version to
        # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
        # the model service uses the specified location as the source of the model.
        # Once deployed, the model version is hosted by the prediction service, so
        # this location is useful only as a historical record.
    "createTime": "A String", # Output only. The time the version was created.
    "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
        # requests that do not specify a version.
        #
        # You can change the default version by calling
        # [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
    "name": "A String", # Required.The name specified for the version when it was created.
        #
        # The version name must be unique within the model it is created in.
  }
google-api-python-client-1.5.5/docs/dyn/ml_v1beta1.projects.operations.html000066400000000000000000000421061300622755700267270ustar00rootroot00000000000000

Google Cloud Machine Learning . projects . operations

Instance Methods

cancel(name, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server

delete(name, x__xgafv=None)

Deletes a long-running operation. This method indicates that the client is

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation.  The server
makes a best effort to cancel the operation, but success is not
guaranteed.  If the server doesn't support this method, it returns
`google.rpc.Code.UNIMPLEMENTED`.  Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to `Code.CANCELLED`.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
`google.rpc.Code.UNIMPLEMENTED`.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation.  Clients can use this
method to poll the operation result at intervals as recommended by the API
service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding below allows API services to override the binding
to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "nextPageToken": "A String", # The standard List next-page token.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If true, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should have the format of `operations/some/unique/name`.
        "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.html000066400000000000000000000041371300622755700235610ustar00rootroot00000000000000

Stackdriver Monitoring API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html000066400000000000000000000437211300622755700311750ustar00rootroot00000000000000

Stackdriver Monitoring API . projects . collectdTimeSeries

Instance Methods

create(name, body, x__xgafv=None)

Stackdriver Monitoring Agent only: Creates a new time series.

Method Details

create(name, body, x__xgafv=None) 
Stackdriver Monitoring Agent only: Creates a new time series.

Args:
  name: string, The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The CreateCollectdTimeSeries request.
    "collectdPayloads": [ # The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.
      { # A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.
        "plugin": "A String", # The name of the plugin. Example: "disk".
        "typeInstance": "A String", # The measurement type instance. Example: "used".
        "values": [ # The measured values during this time interval. Each value must have a different dataSourceName.
          { # A single data point from a collectd-based plugin.
            "dataSourceType": "A String", # The type of measurement.
            "dataSourceName": "A String", # The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx".
            "value": { # A single strongly-typed value. # The measurement value.
              "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
                "count": "A String", # The number of values in the population. Must be non-negative.
                "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
                  "A String",
                ],
                "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
                  "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).  Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
                    "scale": 3.14, # Must be greater than 0.
                    "growthFactor": 3.14, # Must be greater than 1.
                    "numFiniteBuckets": 42, # Must be greater than 0.
                  },
                  "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i).  Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
                    "width": 3.14, # Must be greater than 0.
                    "numFiniteBuckets": 42, # Must be greater than 0.
                    "offset": 3.14, # Lower bound of the first bucket.
                  },
                  "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi  Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
                    "bounds": [ # The values must be monotonically increasing.
                      3.14,
                    ],
                  },
                },
                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
                  "max": 3.14, # The maximum of the population values.
                  "min": 3.14, # The minimum of the population values.
                },
                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
                    # Sum[i=1..n]((x_i - mean)^2)
                    # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
                "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
              },
              "stringValue": "A String", # A variable-length string value.
              "boolValue": True or False, # A Boolean value: true or false.
              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
            },
          },
        ],
        "startTime": "A String", # The start time of the interval.
        "endTime": "A String", # The end time of the interval.
        "type": "A String", # The measurement type. Example: "memory".
        "pluginInstance": "A String", # The instance name of the plugin Example: "hdcl".
        "metadata": { # The measurement metadata. Example: "process_id" -> 12345
          "a_key": { # A single strongly-typed value.
            "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
              "count": "A String", # The number of values in the population. Must be non-negative.
              "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
                "A String",
              ],
              "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
                "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).  Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
                  "scale": 3.14, # Must be greater than 0.
                  "growthFactor": 3.14, # Must be greater than 1.
                  "numFiniteBuckets": 42, # Must be greater than 0.
                },
                "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i).  Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
                  "width": 3.14, # Must be greater than 0.
                  "numFiniteBuckets": 42, # Must be greater than 0.
                  "offset": 3.14, # Lower bound of the first bucket.
                },
                "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi  Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
                  "bounds": [ # The values must be monotonically increasing.
                    3.14,
                  ],
                },
              },
              "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
                "max": 3.14, # The maximum of the population values.
                "min": 3.14, # The minimum of the population values.
              },
              "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
                  # Sum[i=1..n]((x_i - mean)^2)
                  # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
              "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
            },
            "stringValue": "A String", # A variable-length string value.
            "boolValue": True or False, # A Boolean value: true or false.
            "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
            "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
          },
        },
      },
    ],
    "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": # The monitored resource associated with the time series.
        # { "type": "gce_instance",
        #   "labels": { "instance_id": "12345678901234",
        #               "zone": "us-central1-a" }}
      "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
        "a_key": "A String",
      },
      "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
    },
    "collectdVersion": "A String", # The version of collectd that collected the data. Example: "5.3.0-192.el6".
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
      # service Foo {
      #   rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      # }
      # The JSON representation for Empty is empty JSON object {}.
  }
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.groups.html000066400000000000000000000535601300622755700267330ustar00rootroot00000000000000

Stackdriver Monitoring API . projects . groups

Instance Methods

members()

Returns the members Resource.

create(name, body, validateOnly=None, x__xgafv=None)

Creates a new group.

delete(name, x__xgafv=None)

Deletes an existing group.

get(name, x__xgafv=None)

Gets a single group.

list(name, ancestorsOfGroup=None, descendantsOfGroup=None, pageSize=None, x__xgafv=None, pageToken=None, childrenOfGroup=None)

Lists the existing groups.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name, body, validateOnly=None, x__xgafv=None)

Updates an existing group. You can change any group attributes except name.

Method Details

create(name, body, validateOnly=None, x__xgafv=None) 
Creates a new group.

Args:
  name: string, The project in which to create the group. The format is "projects/{project_id_or_number}". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
    "filter": "A String", # The filter used to determine which monitored resources belong to this group.
    "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
    "displayName": "A String", # A user-assigned name for this group, used only for display purposes.
    "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
    "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
  }

  validateOnly: boolean, If true, validate this request but do not create the group.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
      "filter": "A String", # The filter used to determine which monitored resources belong to this group.
      "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
      "displayName": "A String", # A user-assigned name for this group, used only for display purposes.
      "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
      "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
    }
delete(name, x__xgafv=None) 
Deletes an existing group.

Args:
  name: string, The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
      # service Foo {
      #   rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      # }
      # The JSON representation for Empty is empty JSON object {}.
  }
get(name, x__xgafv=None) 
Gets a single group.

Args:
  name: string, The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
      "filter": "A String", # The filter used to determine which monitored resources belong to this group.
      "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
      "displayName": "A String", # A user-assigned name for this group, used only for display purposes.
      "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
      "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
    }
list(name, ancestorsOfGroup=None, descendantsOfGroup=None, pageSize=None, x__xgafv=None, pageToken=None, childrenOfGroup=None) 
Lists the existing groups.

Args:
  name: string, The project whose groups are to be listed. The format is "projects/{project_id_or_number}". (required)
  ancestorsOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
  descendantsOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.
  pageSize: integer, A positive number that is the maximum number of results to return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  childrenOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.

Returns:
  An object of the form:

    { # The ListGroups response.
    "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
    "group": [ # The groups that match the specified filters.
      { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
          "filter": "A String", # The filter used to determine which monitored resources belong to this group.
          "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
          "displayName": "A String", # A user-assigned name for this group, used only for display purposes.
          "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
          "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
        },
    ],
  }
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(name, body, validateOnly=None, x__xgafv=None) 
Updates an existing group. You can change any group attributes except name.

Args:
  name: string, Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
    "filter": "A String", # The filter used to determine which monitored resources belong to this group.
    "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
    "displayName": "A String", # A user-assigned name for this group, used only for display purposes.
    "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
    "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
  }

  validateOnly: boolean, If true, validate this request but do not update the existing group.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
      "filter": "A String", # The filter used to determine which monitored resources belong to this group.
      "parentName": "A String", # The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
      "displayName": "A String", # A user-assigned name for this group, used only for display purposes.
      "name": "A String", # Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
      "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
    }
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.groups.members.html000066400000000000000000000124501300622755700303550ustar00rootroot00000000000000

Stackdriver Monitoring API . projects . groups . members

Instance Methods

list(name, pageSize=None, x__xgafv=None, pageToken=None, interval_endTime=None, filter=None, interval_startTime=None)

Lists the monitored resources that are members of a group.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(name, pageSize=None, x__xgafv=None, pageToken=None, interval_endTime=None, filter=None, interval_startTime=None) 
Lists the monitored resources that are members of a group.

Args:
  name: string, The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}". (required)
  pageSize: integer, A positive number that is the maximum number of results to return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  interval_endTime: string, Required. The end of the time interval.
  filter: string, An optional list filter (/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:
resource.type = "gce_instance"

  interval_startTime: string, Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

Returns:
  An object of the form:

    { # The ListGroupMembers response.
    "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
    "totalSize": 42, # The total number of elements matching this request.
    "members": [ # A set of monitored resources in the group.
      { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone":
          # { "type": "gce_instance",
          #   "labels": { "instance_id": "12345678901234",
          #               "zone": "us-central1-a" }}
        "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
          "a_key": "A String",
        },
        "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.html000066400000000000000000000037571300622755700254200ustar00rootroot00000000000000

Stackdriver Monitoring API . projects

Instance Methods

collectdTimeSeries()

Returns the collectdTimeSeries Resource.

groups()

Returns the groups Resource.

metricDescriptors()

Returns the metricDescriptors Resource.

monitoredResourceDescriptors()

Returns the monitoredResourceDescriptors Resource.

timeSeries()

Returns the timeSeries Resource.

google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.metricDescriptors.html000066400000000000000000000550611300622755700311170ustar00rootroot00000000000000

Stackdriver Monitoring API . projects . metricDescriptors

Instance Methods

create(name, body, x__xgafv=None)

Creates a new metric descriptor. User-created metric descriptors define custom metrics (/monitoring/custom-metrics).

delete(name, x__xgafv=None)

Deletes a metric descriptor. Only user-created custom metrics (/monitoring/custom-metrics) can be deleted.

get(name, x__xgafv=None)

Gets a single metric descriptor. This method does not require a Stackdriver account.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(name, body, x__xgafv=None) 
Creates a new metric descriptor. User-created metric descriptors define custom metrics (/monitoring/custom-metrics).

Args:
  name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Defines a metric type and its schema.
    "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
    "description": "A String", # A detailed description of the metric, which can be used in documentation.
    "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
    "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
    "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
      { # A description of a label.
        "valueType": "A String", # The type of data that can be assigned to the label.
        "description": "A String", # A human-readable description for the label.
        "key": "A String", # The label key.
      },
    ],
    "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
        # compute.googleapis.com/instance/cpu/utilization
        # compute.googleapis.com/instance/disk/read_ops_count
        # compute.googleapis.com/instance/network/received_bytes_count
        # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
    "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
        # bit bit
        # By byte
        # s second
        # min minute
        # h hour
        # d dayPrefixes (PREFIX)
        # k kilo (10**3)
        # M mega (10**6)
        # G giga (10**9)
        # T tera (10**12)
        # P peta (10**15)
        # E exa (10**18)
        # Z zetta (10**21)
        # Y yotta (10**24)
        # m milli (10**-3)
        # u micro (10**-6)
        # n nano (10**-9)
        # p pico (10**-12)
        # f femto (10**-15)
        # a atto (10**-18)
        # z zepto (10**-21)
        # y yocto (10**-24)
        # Ki kibi (2**10)
        # Mi mebi (2**20)
        # Gi gibi (2**30)
        # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
        # / division (as an infix operator, e.g. 1/s).
        # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
        # Expression = Component { "." Component } { "/" Component } ;
        # 
        # Component = [ PREFIX ] UNIT [ Annotation ]
        #           | Annotation
        #           | "1"
        #           ;
        # 
        # Annotation = "{" NAME "}" ;
        # Notes:
        # Annotation is just a comment if it follows a UNIT and is  equivalent to 1 if it is used alone. For examples,  {requests}/s == 1/s, By{transmitted}/s == By/s.
        # NAME is a sequence of non-blank printable ASCII characters not  containing '{' or '}'.
    "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
        # projects/{project_id}/metricDescriptors/{type=**}
        # metricDescriptors/{type=**}
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines a metric type and its schema.
      "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
      "description": "A String", # A detailed description of the metric, which can be used in documentation.
      "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
      "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
      "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
        { # A description of a label.
          "valueType": "A String", # The type of data that can be assigned to the label.
          "description": "A String", # A human-readable description for the label.
          "key": "A String", # The label key.
        },
      ],
      "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
          # compute.googleapis.com/instance/cpu/utilization
          # compute.googleapis.com/instance/disk/read_ops_count
          # compute.googleapis.com/instance/network/received_bytes_count
          # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
      "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
          # bit bit
          # By byte
          # s second
          # min minute
          # h hour
          # d dayPrefixes (PREFIX)
          # k kilo (10**3)
          # M mega (10**6)
          # G giga (10**9)
          # T tera (10**12)
          # P peta (10**15)
          # E exa (10**18)
          # Z zetta (10**21)
          # Y yotta (10**24)
          # m milli (10**-3)
          # u micro (10**-6)
          # n nano (10**-9)
          # p pico (10**-12)
          # f femto (10**-15)
          # a atto (10**-18)
          # z zepto (10**-21)
          # y yocto (10**-24)
          # Ki kibi (2**10)
          # Mi mebi (2**20)
          # Gi gibi (2**30)
          # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
          # / division (as an infix operator, e.g. 1/s).
          # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
          # Expression = Component { "." Component } { "/" Component } ;
          #
          # Component = [ PREFIX ] UNIT [ Annotation ]
          #           | Annotation
          #           | "1"
          #           ;
          #
          # Annotation = "{" NAME "}" ;
          # Notes:
          # Annotation is just a comment if it follows a UNIT and is  equivalent to 1 if it is used alone. For examples,  {requests}/s == 1/s, By{transmitted}/s == By/s.
          # NAME is a sequence of non-blank printable ASCII characters not  containing '{' or '}'.
      "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
          # projects/{project_id}/metricDescriptors/{type=**}
          # metricDescriptors/{type=**}
    }
delete(name, x__xgafv=None) 
Deletes a metric descriptor. Only user-created custom metrics (/monitoring/custom-metrics) can be deleted.

Args:
  name: string, The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
      # service Foo {
      #   rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      # }
      # The JSON representation for Empty is empty JSON object {}.
  }
get(name, x__xgafv=None) 
Gets a single metric descriptor. This method does not require a Stackdriver account.

Args:
  name: string, The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines a metric type and its schema.
      "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
      "description": "A String", # A detailed description of the metric, which can be used in documentation.
      "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
      "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
      "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
        { # A description of a label.
          "valueType": "A String", # The type of data that can be assigned to the label.
          "description": "A String", # A human-readable description for the label.
          "key": "A String", # The label key.
        },
      ],
      "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
          # compute.googleapis.com/instance/cpu/utilization
          # compute.googleapis.com/instance/disk/read_ops_count
          # compute.googleapis.com/instance/network/received_bytes_count
          # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
      "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
          # bit bit
          # By byte
          # s second
          # min minute
          # h hour
          # d dayPrefixes (PREFIX)
          # k kilo (10**3)
          # M mega (10**6)
          # G giga (10**9)
          # T tera (10**12)
          # P peta (10**15)
          # E exa (10**18)
          # Z zetta (10**21)
          # Y yotta (10**24)
          # m milli (10**-3)
          # u micro (10**-6)
          # n nano (10**-9)
          # p pico (10**-12)
          # f femto (10**-15)
          # a atto (10**-18)
          # z zepto (10**-21)
          # y yocto (10**-24)
          # Ki kibi (2**10)
          # Mi mebi (2**20)
          # Gi gibi (2**30)
          # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
          # / division (as an infix operator, e.g. 1/s).
          # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
          # Expression = Component { "." Component } { "/" Component } ;
          #
          # Component = [ PREFIX ] UNIT [ Annotation ]
          #           | Annotation
          #           | "1"
          #           ;
          #
          # Annotation = "{" NAME "}" ;
          # Notes:
          # Annotation is just a comment if it follows a UNIT and is  equivalent to 1 if it is used alone. For examples,  {requests}/s == 1/s, By{transmitted}/s == By/s.
          # NAME is a sequence of non-blank printable ASCII characters not  containing '{' or '}'.
      "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
          # projects/{project_id}/metricDescriptors/{type=**}
          # metricDescriptors/{type=**}
    }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Args:
  name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
  pageSize: integer, A positive number that is the maximum number of results to return.
  filter: string, If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (/monitoring/custom-metrics):
metric.type = starts_with("custom.googleapis.com/")

  pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The ListMetricDescriptors response.
    "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
    "metricDescriptors": [ # The metric descriptors that are available to the project and that match the value of filter, if present.
      { # Defines a metric type and its schema.
          "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
          "description": "A String", # A detailed description of the metric, which can be used in documentation.
          "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
          "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
          "labels": [ # The set of labels that can be used to describe a specific instance of this metric type. For example, the compute.googleapis.com/instance/network/received_bytes_count metric type has a label, loadbalanced, that specifies whether the traffic was received through a load balanced IP address.
            { # A description of a label.
              "valueType": "A String", # The type of data that can be assigned to the label.
              "description": "A String", # A human-readable description for the label.
              "key": "A String", # The label key.
            },
          ],
          "type": "A String", # The metric type including a DNS name prefix, for example "compute.googleapis.com/instance/cpu/utilization". Metric types should use a natural hierarchical grouping such as the following:
              # compute.googleapis.com/instance/cpu/utilization
              # compute.googleapis.com/instance/disk/read_ops_count
              # compute.googleapis.com/instance/network/received_bytes_count
              # Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable.
          "unit": "A String", # The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)
              # bit bit
              # By byte
              # s second
              # min minute
              # h hour
              # d dayPrefixes (PREFIX)
              # k kilo (10**3)
              # M mega (10**6)
              # G giga (10**9)
              # T tera (10**12)
              # P peta (10**15)
              # E exa (10**18)
              # Z zetta (10**21)
              # Y yotta (10**24)
              # m milli (10**-3)
              # u micro (10**-6)
              # n nano (10**-9)
              # p pico (10**-12)
              # f femto (10**-15)
              # a atto (10**-18)
              # z zepto (10**-21)
              # y yocto (10**-24)
              # Ki kibi (2**10)
              # Mi mebi (2**20)
              # Gi gibi (2**30)
              # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:
              # / division (as an infix operator, e.g. 1/s).
              # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:
              # Expression = Component { "." Component } { "/" Component } ;
              #
              # Component = [ PREFIX ] UNIT [ Annotation ]
              #           | Annotation
              #           | "1"
              #           ;
              #
              # Annotation = "{" NAME "}" ;
              # Notes:
              # Annotation is just a comment if it follows a UNIT and is  equivalent to 1 if it is used alone. For examples,  {requests}/s == 1/s, By{transmitted}/s == By/s.
              # NAME is a sequence of non-blank printable ASCII characters not  containing '{' or '}'.
          "name": "A String", # Resource name. The format of the name may vary between different implementations. For examples:
              # projects/{project_id}/metricDescriptors/{type=**}
              # metricDescriptors/{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.
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.monitoredResourceDescriptors.html000066400000000000000000000211431300622755700333360ustar00rootroot00000000000000

Stackdriver Monitoring API . projects . monitoredResourceDescriptors

Instance Methods

get(name, x__xgafv=None)

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(name, x__xgafv=None) 
Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Args:
  name: string, The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
    "type": "A String", # Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
    "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
      { # A description of a label.
        "valueType": "A String", # The type of data that can be assigned to the label.
        "description": "A String", # A human-readable description for the label.
        "key": "A String", # The label key.
      },
    ],
    "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
    "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
    "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Args:
  name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
  pageSize: integer, A positive number that is the maximum number of results to return.
  filter: string, An optional filter (/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:
resource.type = starts_with("gce_") AND resource.label:id

  pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The ListMonitoredResourcDescriptors response.
    "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
    "resourceDescriptors": [ # The monitored resource descriptors that are available to this project and that match filter, if present.
      { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
        "type": "A String", # Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
        "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
        "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
        "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{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.
google-api-python-client-1.5.5/docs/dyn/monitoring_v3.projects.timeSeries.html000066400000000000000000000752741300622755700275330ustar00rootroot00000000000000

Stackdriver Monitoring API . projects . timeSeries

Instance Methods

create(name, body, x__xgafv=None)

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

list(name, orderBy=None, pageSize=None, x__xgafv=None, aggregation_alignmentPeriod=None, pageToken=None, aggregation_groupByFields=None, aggregation_perSeriesAligner=None, interval_endTime=None, aggregation_crossSeriesReducer=None, filter=None, interval_startTime=None, view=None)

Lists time series that match a filter. This method does not require a Stackdriver account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(name, body, x__xgafv=None) 
Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Args:
  name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The CreateTimeSeries request.
    "timeSeries": [ # The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.
      { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
        "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
        "metric": { # A specific metric identified by specifying values for all of the labels of a MetricDescriptor. # The associated metric. A fully-specified metric used to identify the time series.
          "labels": { # The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the MetricDescriptor must be assigned values.
            "a_key": "A String",
          },
          "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, compute.googleapis.com/instance/cpu/usage_time.
        },
        "points": [ # The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
          { # A single data point in a time series.
            "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
              "endTime": "A String", # Required. The end of the time interval.
              "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
            },
            "value": { # A single strongly-typed value. # The value of the data point.
              "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
                "count": "A String", # The number of values in the population. Must be non-negative.
                "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
                  "A String",
                ],
                "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
                  "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).  Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
                    "scale": 3.14, # Must be greater than 0.
                    "growthFactor": 3.14, # Must be greater than 1.
                    "numFiniteBuckets": 42, # Must be greater than 0.
                  },
                  "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i).  Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
                    "width": 3.14, # Must be greater than 0.
                    "numFiniteBuckets": 42, # Must be greater than 0.
                    "offset": 3.14, # Lower bound of the first bucket.
                  },
                  "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi  Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
                    "bounds": [ # The values must be monotonically increasing.
                      3.14,
                    ],
                  },
                },
                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
                  "max": 3.14, # The maximum of the population values.
                  "min": 3.14, # The minimum of the population values.
                },
                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
                    # Sum[i=1..n]((x_i - mean)^2)
                    # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
                "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
              },
              "stringValue": "A String", # A variable-length string value.
              "boolValue": True or False, # A Boolean value: true or false.
              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
            },
          },
        ],
        "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": # The associated resource. A fully-specified monitored resource used to identify the time series.
            # { "type": "gce_instance",
            #   "labels": { "instance_id": "12345678901234",
            #               "zone": "us-central1-a" }}
          "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
            "a_key": "A String",
          },
          "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
        },
        "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
      # service Foo {
      #   rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      # }
      # The JSON representation for Empty is empty JSON object {}.
  }
list(name, orderBy=None, pageSize=None, x__xgafv=None, aggregation_alignmentPeriod=None, pageToken=None, aggregation_groupByFields=None, aggregation_perSeriesAligner=None, interval_endTime=None, aggregation_crossSeriesReducer=None, filter=None, interval_startTime=None, view=None) 
Lists time series that match a filter. This method does not require a Stackdriver account.

Args:
  name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
  orderBy: string, Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
  pageSize: integer, A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  aggregation_alignmentPeriod: string, The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
  pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  aggregation_groupByFields: string, The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified, the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. (repeated)
  aggregation_perSeriesAligner: string, The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.
  interval_endTime: string, Required. The end of the time interval.
  aggregation_crossSeriesReducer: string, The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.
  filter: string, A monitoring filter (/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:
metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
    metric.label.instance_name = "my-instance-name"

  interval_startTime: string, Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
  view: string, Specifies which information is returned about the time series.

Returns:
  An object of the form:

    { # The ListTimeSeries response.
    "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
    "timeSeries": [ # One or more time series that match the filter included in the request.
      { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
        "metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
        "metric": { # A specific metric identified by specifying values for all of the labels of a MetricDescriptor. # The associated metric. A fully-specified metric used to identify the time series.
          "labels": { # The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the MetricDescriptor must be assigned values.
            "a_key": "A String",
          },
          "type": "A String", # An existing metric type, see google.api.MetricDescriptor. For example, compute.googleapis.com/instance/cpu/usage_time.
        },
        "points": [ # The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
          { # A single data point in a time series.
            "interval": { # A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time. # The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
              "endTime": "A String", # Required. The end of the time interval.
              "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
            },
            "value": { # A single strongly-typed value. # The value of the data point.
              "distributionValue": { # Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. # A distribution value.
                "count": "A String", # The number of values in the population. Must be non-negative.
                "bucketCounts": [ # If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
                  "A String",
                ],
                "bucketOptions": { # A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given. # Defines the histogram bucket boundaries.
                  "exponentialBuckets": { # Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).  Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
                    "scale": 3.14, # Must be greater than 0.
                    "growthFactor": 3.14, # Must be greater than 1.
                    "numFiniteBuckets": 42, # Must be greater than 0.
                  },
                  "linearBuckets": { # Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i).  Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
                    "width": 3.14, # Must be greater than 0.
                    "numFiniteBuckets": 42, # Must be greater than 0.
                    "offset": 3.14, # Lower bound of the first bucket.
                  },
                  "explicitBuckets": { # A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi  Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
                    "bounds": [ # The values must be monotonically increasing.
                      3.14,
                    ],
                  },
                },
                "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
                  "max": 3.14, # The maximum of the population values.
                  "min": 3.14, # The minimum of the population values.
                },
                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is:
                    # Sum[i=1..n]((x_i - mean)^2)
                    # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
                "mean": 3.14, # The arithmetic mean of the values in the population. If count is zero then this field must be zero.
              },
              "stringValue": "A String", # A variable-length string value.
              "boolValue": True or False, # A Boolean value: true or false.
              "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
              "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
            },
          },
        ],
        "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": # The associated resource. A fully-specified monitored resource used to identify the time series.
            # { "type": "gce_instance",
            #   "labels": { "instance_id": "12345678901234",
            #               "zone": "us-central1-a" }}
          "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
            "a_key": "A String",
          },
          "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
        },
        "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/oauth2_v1.html000066400000000000000000000144611300622755700225750ustar00rootroot00000000000000

Google OAuth2 API

Instance Methods

userinfo()

Returns the userinfo Resource.

getCertForOpenIdConnect()

A description of how to use this function

getCertForOpenIdConnectRaw()

A description of how to use this function

getRobotJwk(robotEmail)

A description of how to use this function

getRobotMetadataRaw(robotEmail)

A description of how to use this function

getRobotMetadataX509(robotEmail)

A description of how to use this function

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

tokeninfo(access_token=None, id_token=None)

Get token info

Method Details

getCertForOpenIdConnect() 
A description of how to use this function

Args:

Returns:
  An object of the form:

    {
    "a_key": "A String",
  }
getCertForOpenIdConnectRaw() 
A description of how to use this function

Args:

Returns:
  An object of the form:

    {
    "keyvalues": [
      {
        "keyid": "A String",
        "modulus": "A String",
        "exponent": "A String",
        "algorithm": "RSA",
      },
    ],
  }
getRobotJwk(robotEmail) 
A description of how to use this function

Args:
  robotEmail: string, The email of robot account. (required)

Returns:
  An object of the form:

    {
    "keys": [
      {
        "use": "sig",
        "e": "A String",
        "kty": "RSA",
        "alg": "RS256",
        "n": "A String",
        "kid": "A String",
      },
    ],
  }
getRobotMetadataRaw(robotEmail) 
A description of how to use this function

Args:
  robotEmail: string, The email of robot account. (required)

Returns:
  An object of the form:

    {
    "keyvalues": [
      {
        "keyid": "A String",
        "modulus": "A String",
        "exponent": "A String",
        "algorithm": "RSA",
      },
    ],
  }
getRobotMetadataX509(robotEmail) 
A description of how to use this function

Args:
  robotEmail: string, The email of robot account. (required)

Returns:
  An object of the form:

    {
    "a_key": "A String",
  }
new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
tokeninfo(access_token=None, id_token=None) 
Get token info

Args:
  access_token: string, The oauth2 access token
  id_token: string, The ID token

Returns:
  An object of the form:

    {
    "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
    "nonce": "A String", # Nonce of the id token.
    "user_id": "A String", # The obfuscated user id.
    "email_verified": 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.
    "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.
    "issued_at": 42, # The issue time of the token, as number of seconds.
    "scope": "A String", # The space separated list of scopes granted to this token.
    "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.
    "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
    "issuer": "A String", # Who issued the token.
  }
google-api-python-client-1.5.5/docs/dyn/oauth2_v1.userinfo.html000066400000000000000000000043121300622755700244200ustar00rootroot00000000000000

Google OAuth2 API . userinfo

Instance Methods

v2()

Returns the v2 Resource.

get()

Get user info

Method Details

get() 
Get user info

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 preferred locale.
    "gender": "A String", # The user's gender.
    "email": "A String", # The user's email address.
    "link": "A String", # URL of the profile page.
    "given_name": "A String", # The user's first name.
    "id": "A String", # The obfuscated ID of the user.
    "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
    "verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
  }
google-api-python-client-1.5.5/docs/dyn/oauth2_v1.userinfo.v2.html000066400000000000000000000023701300622755700247500ustar00rootroot00000000000000

Google OAuth2 API . userinfo . v2

Instance Methods

me()

Returns the me Resource.

google-api-python-client-1.5.5/docs/dyn/oauth2_v1.userinfo.v2.me.html000066400000000000000000000042341300622755700253510ustar00rootroot00000000000000

Google OAuth2 API . userinfo . v2 . me

Instance Methods

get()

Get user info

Method Details

get() 
Get user info

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 preferred locale.
    "gender": "A String", # The user's gender.
    "email": "A String", # The user's email address.
    "link": "A String", # URL of the profile page.
    "given_name": "A String", # The user's first name.
    "id": "A String", # The obfuscated ID of the user.
    "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
    "verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
  }
google-api-python-client-1.5.5/docs/dyn/oauth2_v2.html000066400000000000000000000100731300622755700225710ustar00rootroot00000000000000

Google OAuth2 API

Instance Methods

userinfo()

Returns the userinfo Resource.

getCertForOpenIdConnect()

A description of how to use this function

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

tokeninfo(token_handle=None, access_token=None, id_token=None)

A description of how to use this function

Method Details

getCertForOpenIdConnect() 
A description of how to use this function

Args:

Returns:
  An object of the form:

    {
    "keys": [
      {
        "use": "sig",
        "e": "A String",
        "kty": "RSA",
        "alg": "RS256",
        "n": "A String",
        "kid": "A String",
      },
    ],
  }
new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
tokeninfo(token_handle=None, access_token=None, id_token=None) 
A description of how to use this function

Args:
  token_handle: string, A parameter
  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.
    "token_handle": "A String", # The token handle associated with this token.
    "user_id": "A String", # The 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.
  }
google-api-python-client-1.5.5/docs/dyn/oauth2_v2.userinfo.html000066400000000000000000000044021300622755700244210ustar00rootroot00000000000000

Google OAuth2 API . userinfo

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 preferred locale.
    "gender": "A String", # The user's gender.
    "email": "A String", # The user's email address.
    "link": "A String", # URL of the profile page.
    "given_name": "A String", # The user's first name.
    "id": "A String", # The obfuscated ID of the user.
    "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
    "verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
  }
google-api-python-client-1.5.5/docs/dyn/oauth2_v2.userinfo.v2.html000066400000000000000000000023701300622755700247510ustar00rootroot00000000000000

Google OAuth2 API . userinfo . v2

Instance Methods

me()

Returns the me Resource.

google-api-python-client-1.5.5/docs/dyn/oauth2_v2.userinfo.v2.me.html000066400000000000000000000043241300622755700253520ustar00rootroot00000000000000

Google OAuth2 API . userinfo . v2 . me

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 preferred locale.
    "gender": "A String", # The user's gender.
    "email": "A String", # The user's email address.
    "link": "A String", # URL of the profile page.
    "given_name": "A String", # The user's first name.
    "id": "A String", # The obfuscated ID of the user.
    "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
    "verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
  }
google-api-python-client-1.5.5/docs/dyn/pagespeedonline_v1.html000066400000000000000000000041611300622755700245310ustar00rootroot00000000000000

PageSpeed Insights API

Instance Methods

pagespeedapi()

Returns the pagespeedapi Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/pagespeedonline_v1.pagespeedapi.html000066400000000000000000000213511300622755700271570ustar00rootroot00000000000000

PageSpeed Insights API . pagespeedapi

Instance Methods

runpagespeed(url, screenshot=None, locale=None, rule=None, strategy=None, filter_third_party_resources=None)

Runs PageSpeed analysis on the page at the specified URL, and returns a PageSpeed 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 PageSpeed analysis on the page at the specified URL, and returns a PageSpeed 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 PageSpeed 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:

    {
    "kind": "pagespeedonline#result", # Kind of result.
    "formattedResults": { # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed 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 PageSpeed 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'.
                  },
                },
              ],
            },
          ],
          "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.
        },
      },
    },
    "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 PageSpeed used to generate these results.
      "major": 42, # The major version number of PageSpeed used to generate these results.
      "minor": 42, # The minor version number of PageSpeed used to generate these results.
    },
    "score": 42, # The PageSpeed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
    "responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
    "invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
      "A String",
    ],
    "pageStats": { # Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
      "otherResponseBytes": "A String", # Number of response bytes for other resources on the page.
      "flashResponseBytes": "A String", # Number of response bytes for flash resources on the page.
      "totalRequestBytes": "A String", # Total size of all request bytes sent by the page.
      "numberCssResources": 42, # Number of CSS resources referenced by the page.
      "numberResources": 42, # Number of HTTP resources loaded by the page.
      "cssResponseBytes": "A String", # Number of uncompressed response bytes for CSS resources on the page.
      "javascriptResponseBytes": "A String", # Number of uncompressed response bytes for JS resources on the page.
      "imageResponseBytes": "A String", # Number of response bytes for image resources on the page.
      "numberHosts": 42, # Number of unique hosts referenced by the page.
      "numberStaticResources": 42, # Number of static (i.e. cacheable) resources on the page.
      "htmlResponseBytes": "A String", # Number of uncompressed response bytes for the main HTML document and all iframes on the page.
      "numberJsResources": 42, # Number of JavaScript resources referenced by the page.
      "textResponseBytes": "A String", # Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.
    },
    "id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
  }
google-api-python-client-1.5.5/docs/dyn/pagespeedonline_v2.html000066400000000000000000000041611300622755700245320ustar00rootroot00000000000000

PageSpeed Insights API

Instance Methods

pagespeedapi()

Returns the pagespeedapi Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/pagespeedonline_v2.pagespeedapi.html000066400000000000000000000400041300622755700271540ustar00rootroot00000000000000

PageSpeed Insights API . pagespeedapi

Instance Methods

runpagespeed(url, screenshot=None, locale=None, rule=None, strategy=None, filter_third_party_resources=None)

Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, 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 PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, 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 PageSpeed 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:

    {
    "kind": "pagespeedonline#result", # Kind of result.
    "formattedResults": { # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed 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 PageSpeed 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.
                  {
                    "rects": [ # The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot.
                      {
                        "width": 42, # The width of the rect.
                        "top": 42, # The top coordinate of the rect, in page coordinates.
                        "left": 42, # The left coordinate of the rect, in page coordinates.
                        "height": 42, # The height of the rect.
                      },
                    ],
                    "value": "A String", # Argument value, as a localized string.
                    "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT.
                    "secondary_rects": [ # Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments.
                      {
                        "width": 42, # The width of the rect.
                        "top": 42, # The top coordinate of the rect, in page coordinates.
                        "left": 42, # The left coordinate of the rect, in page coordinates.
                        "height": 42, # The height of the rect.
                      },
                    ],
                    "key": "A String", # The placeholder key for this arg, as a string.
                  },
                ],
                "format": "A String", # A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
              },
              "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.
                        {
                          "rects": [ # The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot.
                            {
                              "width": 42, # The width of the rect.
                              "top": 42, # The top coordinate of the rect, in page coordinates.
                              "left": 42, # The left coordinate of the rect, in page coordinates.
                              "height": 42, # The height of the rect.
                            },
                          ],
                          "value": "A String", # Argument value, as a localized string.
                          "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT.
                          "secondary_rects": [ # Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments.
                            {
                              "width": 42, # The width of the rect.
                              "top": 42, # The top coordinate of the rect, in page coordinates.
                              "left": 42, # The left coordinate of the rect, in page coordinates.
                              "height": 42, # The height of the rect.
                            },
                          ],
                          "key": "A String", # The placeholder key for this arg, as a string.
                        },
                      ],
                      "format": "A String", # A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
                    },
                  ],
                  "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.
                      {
                        "rects": [ # The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot.
                          {
                            "width": 42, # The width of the rect.
                            "top": 42, # The top coordinate of the rect, in page coordinates.
                            "left": 42, # The left coordinate of the rect, in page coordinates.
                            "height": 42, # The height of the rect.
                          },
                        ],
                        "value": "A String", # Argument value, as a localized string.
                        "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT.
                        "secondary_rects": [ # Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments.
                          {
                            "width": 42, # The width of the rect.
                            "top": 42, # The top coordinate of the rect, in page coordinates.
                            "left": 42, # The left coordinate of the rect, in page coordinates.
                            "height": 42, # The height of the rect.
                          },
                        ],
                        "key": "A String", # The placeholder key for this arg, as a string.
                      },
                    ],
                    "format": "A String", # A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
                  },
                },
              ],
            },
          ],
          "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.
          "groups": [ # List of rule groups that this rule belongs to. Each entry in the list is one of "SPEED" or "USABILITY".
            "A String",
          ],
          "summary": { # A brief summary description for the rule, indicating at a high level what should be done to follow the rule and what benefit can be gained by doing so.
            "args": [ # List of arguments for the format string.
              {
                "rects": [ # The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot.
                  {
                    "width": 42, # The width of the rect.
                    "top": 42, # The top coordinate of the rect, in page coordinates.
                    "left": 42, # The left coordinate of the rect, in page coordinates.
                    "height": 42, # The height of the rect.
                  },
                ],
                "value": "A String", # Argument value, as a localized string.
                "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT.
                "secondary_rects": [ # Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments.
                  {
                    "width": 42, # The width of the rect.
                    "top": 42, # The top coordinate of the rect, in page coordinates.
                    "left": 42, # The left coordinate of the rect, in page coordinates.
                    "height": 42, # The height of the rect.
                  },
                ],
                "key": "A String", # The placeholder key for this arg, as a string.
              },
            ],
            "format": "A String", # A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
          },
        },
      },
    },
    "screenshot": { # Base64-encoded screenshot of the page that was analyzed.
      "height": 42, # Height of screenshot in pixels.
      "width": 42, # Width of screenshot in pixels.
      "key": "A String", # Unique string key, if any, identifying this image.
      "page_rect": { # The region of the page that is captured by this image, with dimensions measured in CSS pixels.
        "width": 42, # The width of the rect.
        "top": 42, # The top coordinate of the rect, in page coordinates.
        "left": 42, # The left coordinate of the rect, in page coordinates.
        "height": 42, # The height of the rect.
      },
      "data": "A String", # Image data base64 encoded.
      "mime_type": "A String", # Mime type of image data (e.g. "image/jpeg").
    },
    "title": "A String", # Title of the page, as displayed in the browser's title bar.
    "ruleGroups": { # A map with one entry for each rule group in these results.
      "a_key": { # The name of this rule group: one of "SPEED" or "USABILITY".
        "score": 42, # The score (0-100) for this rule group, which indicates how much better a page could be in that category (e.g. how much faster, or how much more usable). A high score indicates little room for improvement, while a lower score indicates more room for improvement.
      },
    },
    "version": { # The version of PageSpeed used to generate these results.
      "major": 42, # The major version number of PageSpeed used to generate these results.
      "minor": 42, # The minor version number of PageSpeed used to generate these results.
    },
    "responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
    "invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
      "A String",
    ],
    "pageStats": { # Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
      "otherResponseBytes": "A String", # Number of response bytes for other resources on the page.
      "flashResponseBytes": "A String", # Number of response bytes for flash resources on the page.
      "totalRequestBytes": "A String", # Total size of all request bytes sent by the page.
      "numberCssResources": 42, # Number of CSS resources referenced by the page.
      "numberResources": 42, # Number of HTTP resources loaded by the page.
      "cssResponseBytes": "A String", # Number of uncompressed response bytes for CSS resources on the page.
      "javascriptResponseBytes": "A String", # Number of uncompressed response bytes for JS resources on the page.
      "imageResponseBytes": "A String", # Number of response bytes for image resources on the page.
      "numberHosts": 42, # Number of unique hosts referenced by the page.
      "numberStaticResources": 42, # Number of static (i.e. cacheable) resources on the page.
      "htmlResponseBytes": "A String", # Number of uncompressed response bytes for the main HTML document and all iframes on the page.
      "numberJsResources": 42, # Number of JavaScript resources referenced by the page.
      "textResponseBytes": "A String", # Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.
    },
    "id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
  }
google-api-python-client-1.5.5/docs/dyn/partners_v2.clientMessages.html000066400000000000000000000075551300622755700262050ustar00rootroot00000000000000

Google Partners API . clientMessages

Instance Methods

log(body, x__xgafv=None)

Logs a generic message from the client, such as `Failed to render component`, `Profile page is running slow`, `More than 500 users have accessed this result.`, etc.

Method Details

log(body, x__xgafv=None) 
Logs a generic message from the client, such as `Failed to render component`, `Profile page is running slow`, `More than 500 users have accessed this result.`, etc.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for LogClientMessage.
    "clientInfo": { # Map of client info, such as URL, browser navigator, browser platform, etc.
      "a_key": "A String",
    },
    "requestMetadata": { # Common data that is in each API request. # Current request metadata.
      "locale": "A String", # Locale to use for the current request.
      "partnersSessionId": "A String", # Google Partners session ID.
      "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
        "trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
        "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
      },
      "userOverrides": { # Values to use instead of the user's respective defaults. These are only honored by whitelisted products. # Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products.
        "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
        "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
      },
      "experimentIds": [ # Experiment IDs the current request belongs to.
        "A String",
      ],
    },
    "details": "A String", # Details about the client message.
    "level": "A String", # Message level of client message.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for LogClientMessage.
    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
      "debugInfo": { # Debug information about this request. # Debug information about this request.
        "serverTraceInfo": "A String", # Server-side debug stack trace.
        "serviceUrl": "A String", # URL of the service that handled this request.
        "serverInfo": "A String", # Info about the server that serviced this request.
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/partners_v2.companies.html000066400000000000000000000554071300622755700252140ustar00rootroot00000000000000

Google Partners API . companies

Instance Methods

leads()

Returns the leads Resource.

get(companyId, orderBy=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, currencyCode=None, address=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None, view=None)

Gets a company.

list(orderBy=None, maxMonthlyBudget_units=None, requestMetadata_userOverrides_userId=None, pageSize=None, requestMetadata_userOverrides_ipAddress=None, maxMonthlyBudget_currencyCode=None, minMonthlyBudget_nanos=None, languageCodes=None, x__xgafv=None, industries=None, requestMetadata_locale=None, pageToken=None, minMonthlyBudget_currencyCode=None, companyName=None, maxMonthlyBudget_nanos=None, requestMetadata_trafficSource_trafficSubId=None, address=None, services=None, gpsMotivations=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, websiteUrl=None, requestMetadata_partnersSessionId=None, minMonthlyBudget_units=None, view=None)

Lists companies.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(companyId, orderBy=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, currencyCode=None, address=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None, view=None) 
Gets a company.

Args:
  companyId: string, The ID of the company to retrieve. (required)
  orderBy: string, How to order addresses within the returned company. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.
  requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
  requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
  requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
  x__xgafv: string, V1 error format.
  currencyCode: string, If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.
  address: string, The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set.
  requestMetadata_locale: string, Locale to use for the current request.
  requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
  requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
  requestMetadata_partnersSessionId: string, Google Partners session ID.
  view: string, The view of `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.

Returns:
  An object of the form:

    { # Response message for GetCompany.
    "company": { # A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers. # The company.
      "industries": [ # Industries the company can help with.
        "A String",
      ],
      "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner business.
        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
        "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
      },
      "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
        "url": "A String", # The URL of the public profile.
        "displayImageUrl": "A String", # The URL to the main display image of the public profile.
        "displayName": "A String", # The display name of the public profile.
        "id": "A String", # The ID which can be used to retrieve more details about the public profile.
      },
      "name": "A String", # The name of the company.
      "localizedInfos": [ # The list of localized info for the company.
        { # The localized company information.
          "countryCodes": [ # List of country codes for the localized company info.
            "A String",
          ],
          "languageCode": "A String", # Language code of the localized company info, as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").
          "displayName": "A String", # Localized display name.
          "overview": "A String", # Localized brief description that the company uses to advertise themselves.
        },
      ],
      "locations": [ # The list of company locations.
        { # A location with address and geographic coordinates.
          "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The latitude and longitude of the location, in degrees.
            "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
            "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
          },
          "address": "A String", # The complete address of the location.
        },
      ],
      "websiteUrl": "A String", # URL of the company's website.
      "ranks": [ # Information related to the ranking of the company within the list of companies.
        { # Information related to ranking of results.
          "type": "A String", # The type of rank.
          "value": 3.14, # The numerical value of the rank.
        },
      ],
      "services": [ # Services the company can help with.
        "A String",
      ],
      "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
        { # Google Partners certification status.
          "isCertified": True or False, # Whether certification is passing.
          "type": "A String", # The type of the certification.
          "examStatuses": [ # List of certification exam statuses.
            { # Status for a Google Partners certification exam.
              "numberUsersPass": 42, # The number of people who have passed the certification exam.
              "type": "A String", # The type of certification exam.
            },
          ],
        },
      ],
      "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business, converted to the requested currency code.
        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
        "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
      },
      "id": "A String", # The ID of the company.
    },
    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
      "debugInfo": { # Debug information about this request. # Debug information about this request.
        "serverTraceInfo": "A String", # Server-side debug stack trace.
        "serviceUrl": "A String", # URL of the service that handled this request.
        "serverInfo": "A String", # Info about the server that serviced this request.
      },
    },
  }
list(orderBy=None, maxMonthlyBudget_units=None, requestMetadata_userOverrides_userId=None, pageSize=None, requestMetadata_userOverrides_ipAddress=None, maxMonthlyBudget_currencyCode=None, minMonthlyBudget_nanos=None, languageCodes=None, x__xgafv=None, industries=None, requestMetadata_locale=None, pageToken=None, minMonthlyBudget_currencyCode=None, companyName=None, maxMonthlyBudget_nanos=None, requestMetadata_trafficSource_trafficSubId=None, address=None, services=None, gpsMotivations=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, websiteUrl=None, requestMetadata_partnersSessionId=None, minMonthlyBudget_units=None, view=None) 
Lists companies.

Args:
  orderBy: string, How to order addresses within the returned companies. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.
  maxMonthlyBudget_units: string, The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
  requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
  pageSize: integer, Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.
  requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
  maxMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217.
  minMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
  languageCodes: string, List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages"). (repeated)
  x__xgafv: string, V1 error format.
  industries: string, List of industries the company can help with. (repeated)
  requestMetadata_locale: string, Locale to use for the current request.
  pageToken: string, A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to ListCompanies.
  minMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217.
  companyName: string, Company name to search for.
  maxMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
  requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
  address: string, The address to use when searching for companies. If not given, the geo-located address of the request is used.
  services: string, List of services the company can help with. (repeated)
  gpsMotivations: string, List of reasons for using Google Partner Search to get companies. (repeated)
  requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
  requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
  websiteUrl: string, Website URL that will help to find a better matched company. .
  requestMetadata_partnersSessionId: string, Google Partners session ID.
  minMonthlyBudget_units: string, The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
  view: string, The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.

Returns:
  An object of the form:

    { # Response message for ListCompanies.
    "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the `ListCompaniesRequest.page_token` field in the subsequent call to ListCompanies to retrieve the next page of results.
    "companies": [ # The list of companies.
      { # A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers.
        "industries": [ # Industries the company can help with.
          "A String",
        ],
        "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner business.
          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
          "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
        },
        "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
          "url": "A String", # The URL of the public profile.
          "displayImageUrl": "A String", # The URL to the main display image of the public profile.
          "displayName": "A String", # The display name of the public profile.
          "id": "A String", # The ID which can be used to retrieve more details about the public profile.
        },
        "name": "A String", # The name of the company.
        "localizedInfos": [ # The list of localized info for the company.
          { # The localized company information.
            "countryCodes": [ # List of country codes for the localized company info.
              "A String",
            ],
            "languageCode": "A String", # Language code of the localized company info, as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").
            "displayName": "A String", # Localized display name.
            "overview": "A String", # Localized brief description that the company uses to advertise themselves.
          },
        ],
        "locations": [ # The list of company locations.
          { # A location with address and geographic coordinates.
            "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The latitude and longitude of the location, in degrees.
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
            "address": "A String", # The complete address of the location.
          },
        ],
        "websiteUrl": "A String", # URL of the company's website.
        "ranks": [ # Information related to the ranking of the company within the list of companies.
          { # Information related to ranking of results.
            "type": "A String", # The type of rank.
            "value": 3.14, # The numerical value of the rank.
          },
        ],
        "services": [ # Services the company can help with.
          "A String",
        ],
        "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
          { # Google Partners certification status.
            "isCertified": True or False, # Whether certification is passing.
            "type": "A String", # The type of the certification.
            "examStatuses": [ # List of certification exam statuses.
              { # Status for a Google Partners certification exam.
                "numberUsersPass": 42, # The number of people who have passed the certification exam.
                "type": "A String", # The type of certification exam.
              },
            ],
          },
        ],
        "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business, converted to the requested currency code.
          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
          "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
        },
        "id": "A String", # The ID of the company.
      },
    ],
    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
      "debugInfo": { # Debug information about this request. # Debug information about this request.
        "serverTraceInfo": "A String", # Server-side debug stack trace.
        "serviceUrl": "A String", # URL of the service that handled this request.
        "serverInfo": "A String", # Info about the server that serviced this 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.
google-api-python-client-1.5.5/docs/dyn/partners_v2.companies.leads.html000066400000000000000000000157721300622755700263040ustar00rootroot00000000000000

Google Partners API . companies . leads

Instance Methods

create(companyId, body, x__xgafv=None)

Creates an advertiser lead for the given company ID.

Method Details

create(companyId, body, x__xgafv=None) 
Creates an advertiser lead for the given company ID.

Args:
  companyId: string, The ID of the company to contact. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for CreateLead.
    "requestMetadata": { # Common data that is in each API request. # Current request metadata.
      "locale": "A String", # Locale to use for the current request.
      "partnersSessionId": "A String", # Google Partners session ID.
      "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
        "trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
        "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
      },
      "userOverrides": { # Values to use instead of the user's respective defaults. These are only honored by whitelisted products. # Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products.
        "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
        "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
      },
      "experimentIds": [ # Experiment IDs the current request belongs to.
        "A String",
      ],
    },
    "recaptchaChallenge": { # reCaptcha challenge info. # reCaptcha challenge info.
      "id": "A String", # The ID of the reCaptcha challenge.
      "response": "A String", # The response to the reCaptcha challenge.
    },
    "lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED` and either `email` or `phone_number` must be provided.
      "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
        "A String",
      ],
      "familyName": "A String", # Last name of lead source.
      "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
        "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
      },
      "comments": "A String", # Comments lead source gave.
      "email": "A String", # Email address of lead source.
      "websiteUrl": "A String", # Website URL of lead source.
      "phoneNumber": "A String", # Phone number of lead source.
      "givenName": "A String", # First name of lead source.
      "type": "A String", # Type of lead.
      "id": "A String", # ID of the lead.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for CreateLead. Debug information about this request.
    "recaptchaStatus": "A String", # The outcome of reCaptcha validation.
    "lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # Lead that was created depending on the outcome of reCaptcha validation.
      "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
        "A String",
      ],
      "familyName": "A String", # Last name of lead source.
      "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
        "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
      },
      "comments": "A String", # Comments lead source gave.
      "email": "A String", # Email address of lead source.
      "websiteUrl": "A String", # Website URL of lead source.
      "phoneNumber": "A String", # Phone number of lead source.
      "givenName": "A String", # First name of lead source.
      "type": "A String", # Type of lead.
      "id": "A String", # ID of the lead.
    },
    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
      "debugInfo": { # Debug information about this request. # Debug information about this request.
        "serverTraceInfo": "A String", # Server-side debug stack trace.
        "serviceUrl": "A String", # URL of the service that handled this request.
        "serverInfo": "A String", # Info about the server that serviced this request.
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/partners_v2.html000066400000000000000000000050751300622755700232330ustar00rootroot00000000000000

Google Partners API

Instance Methods

clientMessages()

Returns the clientMessages Resource.

companies()

Returns the companies Resource.

userEvents()

Returns the userEvents Resource.

userStates()

Returns the userStates Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/partners_v2.userEvents.html000066400000000000000000000124251300622755700253720ustar00rootroot00000000000000

Google Partners API . userEvents

Instance Methods

log(body, x__xgafv=None)

Logs a user event.

Method Details

log(body, x__xgafv=None) 
Logs a user event.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for LogUserEvent.
    "lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # Advertiser lead information.
      "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
        "A String",
      ],
      "familyName": "A String", # Last name of lead source.
      "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
        "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
      },
      "comments": "A String", # Comments lead source gave.
      "email": "A String", # Email address of lead source.
      "websiteUrl": "A String", # Website URL of lead source.
      "phoneNumber": "A String", # Phone number of lead source.
      "givenName": "A String", # First name of lead source.
      "type": "A String", # Type of lead.
      "id": "A String", # ID of the lead.
    },
    "url": "A String", # The URL where the event occurred.
    "eventDatas": [ # List of event data for the event.
      { # Key value data pair for an event.
        "values": [ # Data values.
          "A String",
        ],
        "key": "A String", # Data type.
      },
    ],
    "eventAction": "A String", # The action that occurred.
    "eventCategory": "A String", # The category the action belongs to.
    "requestMetadata": { # Common data that is in each API request. # Current request metadata.
      "locale": "A String", # Locale to use for the current request.
      "partnersSessionId": "A String", # Google Partners session ID.
      "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
        "trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
        "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
      },
      "userOverrides": { # Values to use instead of the user's respective defaults. These are only honored by whitelisted products. # Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products.
        "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
        "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
      },
      "experimentIds": [ # Experiment IDs the current request belongs to.
        "A String",
      ],
    },
    "eventScope": "A String", # The scope of the event.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for LogUserEvent.
    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
      "debugInfo": { # Debug information about this request. # Debug information about this request.
        "serverTraceInfo": "A String", # Server-side debug stack trace.
        "serviceUrl": "A String", # URL of the service that handled this request.
        "serverInfo": "A String", # Info about the server that serviced this request.
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/partners_v2.userStates.html000066400000000000000000000066571300622755700254030ustar00rootroot00000000000000

Google Partners API . userStates

Instance Methods

list(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)

Lists states for current user.

Method Details

list(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None) 
Lists states for current user.

Args:
  requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
  requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
  requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
  x__xgafv: string, V1 error format.
  requestMetadata_locale: string, Locale to use for the current request.
  requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
  requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
  requestMetadata_partnersSessionId: string, Google Partners session ID.

Returns:
  An object of the form:

    { # Response message for ListUserStates.
    "userStates": [ # User's states.
      "A String",
    ],
    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
      "debugInfo": { # Debug information about this request. # Debug information about this request.
        "serverTraceInfo": "A String", # Server-side debug stack trace.
        "serviceUrl": "A String", # URL of the service that handled this request.
        "serverInfo": "A String", # Info about the server that serviced this request.
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/people_v1.html000066400000000000000000000041101300622755700226450ustar00rootroot00000000000000

Google People API

Instance Methods

people()

Returns the people Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/people_v1.people.connections.html000066400000000000000000001170661300622755700264700ustar00rootroot00000000000000

Google People API . people . connections

Instance Methods

list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, syncToken=None, requestMask_includeField=None)

Provides a list of the authenticated user's contacts merged with any linked profiles.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, syncToken=None, requestMask_includeField=None) 
Provides a list of the authenticated user's contacts merged with any linked profiles.

Args:
  resourceName: string, The resource name to return connections for. Only `people/me` is valid. (required)
  pageSize: integer, The number of connections to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100.
  x__xgafv: string, V1 error format.
  pageToken: string, The token of the page to be returned.
  sortOrder: string, The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
  syncToken: string, A sync token, returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created are returned.
  requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.

Returns:
  An object of the form:

    {
    "connections": [ # The list of people that the requestor is connected to.
      { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
        "phoneNumbers": [ # The person's phone numbers.
          { # A person's phone number.
            "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
            "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
            "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
            "value": "A String", # The phone number.
            "metadata": { # Metadata about a field. # Metadata about the phone number.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "addresses": [ # The person's street addresses.
          { # A person's physical address. May be a P.O. box or street address. All fields are optional.
            "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
            "city": "A String", # The city of the address.
            "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "region": "A String", # The region of the address; for example, the state or province.
            "poBox": "A String", # The P.O. box of the address.
            "streetAddress": "A String", # The street address.
            "country": "A String", # The country of the address.
            "postalCode": "A String", # The postal code of the address.
            "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
            "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
            "metadata": { # Metadata about a field. # Metadata about the address.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "nicknames": [ # The person's nicknames.
          { # A person's nickname.
            "type": "A String", # The type of the nickname.
            "value": "A String", # The nickname.
            "metadata": { # Metadata about a field. # Metadata about the nickname.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "occupations": [ # The person's occupations.
          { # A person's occupation.
            "value": "A String", # The occupation; for example, `carpenter`.
            "metadata": { # Metadata about a field. # Metadata about the occupation.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "braggingRights": [ # The person's bragging rights.
          { # A person's bragging rights.
            "value": "A String", # The bragging rights; for example, `climbed mount everest`.
            "metadata": { # Metadata about a field. # Metadata about the bragging rights.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "names": [ # The person's names.
          { # A person's name. If the name is a mononym, the family name is empty.
            "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
            "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
            "phoneticFamilyName": "A String", # The family name spelled as it sounds.
            "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
            "middleName": "A String", # The middle name(s).
            "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
            "familyName": "A String", # The family name.
            "phoneticGivenName": "A String", # The given name spelled as it sounds.
            "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
            "givenName": "A String", # The given name.
            "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
            "metadata": { # Metadata about a field. # Metadata about the name.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
        "birthdays": [ # The person's birthdays.
          { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
            "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
              "month": 42, # Month of year. Must be from 1 to 12.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
            },
            "text": "A String", # A free-form string representing the user's birthday.
            "metadata": { # Metadata about a field. # Metadata about the birthday.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "relations": [ # The person's relations.
          { # A person's relation to another person.
            "person": "A String", # The name of the other person this relation refers to.
            "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
            "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
            "metadata": { # Metadata about a field. # Metadata about the relation.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
        "relationshipStatuses": [ # The person's relationship statuses.
          { # A person's relationship status.
            "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
            "metadata": { # Metadata about a field. # Metadata about the relationship status.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "skills": [ # The person's skills.
          { # A skill that the person has.
            "value": "A String", # The skill; for example, `underwater basket weaving`.
            "metadata": { # Metadata about a field. # Metadata about the skill.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "imClients": [ # The person's instant messaging clients.
          { # A person's instant messaging client.
            "username": "A String", # The user name used in the IM client.
            "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
            "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
            "metadata": { # Metadata about a field. # Metadata about the IM client.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "events": [ # The person's events.
          { # An event related to the person.
            "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
              "month": 42, # Month of year. Must be from 1 to 12.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
            },
            "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
            "metadata": { # Metadata about a field. # Metadata about the event.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "metadata": { # Metadata about a person. # Metadata about the person.
          "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
            "A String",
          ],
          "sources": [ # The sources of data for the person.
            { # The source of a field.
              "type": "A String", # The source type.
              "id": "A String", # A unique identifier within the source type generated by the server.
            },
          ],
          "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
          "objectType": "A String", # The type of the person object.
        },
        "interests": [ # The person's interests.
          { # One of the person's interests.
            "value": "A String", # The interest; for example, `stargazing`.
            "metadata": { # Metadata about a field. # Metadata about the interest.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "photos": [ # The person's photos.
          { # A person's photo. A picture shown next to the person's name to help others recognize the person.
            "url": "A String", # The URL of the photo.
            "metadata": { # Metadata about a field. # Metadata about the photo.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "residences": [ # The person's residences.
          { # A person's past or current residence.
            "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
            "value": "A String", # The address of the residence.
            "metadata": { # Metadata about a field. # Metadata about the residence.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "relationshipInterests": [ # The kind of relationship the person is looking for.
          { # The kind of relationship the person is looking for.
            "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
            "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
            "metadata": { # Metadata about a field. # Metadata about the relationship interest.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "coverPhotos": [ # The person's cover photos.
          { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
            "url": "A String", # The URL of the cover photo.
            "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
            "metadata": { # Metadata about a field. # Metadata about the cover photo.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "locales": [ # The person's locale preferences.
          { # A person's locale preference.
            "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
            "metadata": { # Metadata about a field. # Metadata about the locale.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "organizations": [ # The person's past or current organizations.
          { # A person's past or current organization. Overlapping date ranges are permitted.
            "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
            "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
              "month": 42, # Month of year. Must be from 1 to 12.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
            },
            "name": "A String", # The name of the organization.
            "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
              "month": 42, # Month of year. Must be from 1 to 12.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
            },
            "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
            "title": "A String", # The person's job title at the organization.
            "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
            "jobDescription": "A String", # The person's job description at the organization.
            "location": "A String", # The location of the organization office the person works at.
            "department": "A String", # The person's department at the organization.
            "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
            "phoneticName": "A String", # The phonetic name of the organization.
            "metadata": { # Metadata about a field. # Metadata about the organization.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "biographies": [ # The person's biographies.
          { # A person's short biography.
            "value": "A String", # The short biography.
            "metadata": { # Metadata about a field. # Metadata about the biography.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "memberships": [ # The person's group memberships.
          { # A person's membership in a group.
            "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
              "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
            },
            "domainMembership": { # A Google Apps Domain membership. # The domain membership.
              "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
            },
            "metadata": { # Metadata about a field. # Metadata about the membership.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "taglines": [ # The person's taglines.
          { # A brief one-line description of the person.
            "value": "A String", # The tagline.
            "metadata": { # Metadata about a field. # Metadata about the tagline.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "urls": [ # The person's associated URLs.
          { # A person's associated URLs.
            "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
            "value": "A String", # The URL.
            "metadata": { # Metadata about a field. # Metadata about the URL.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "ageRange": "A String", # The person's age range.
        "genders": [ # The person's genders.
          { # A person's gender.
            "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
            "metadata": { # Metadata about a field. # Metadata about the gender.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
        "emailAddresses": [ # The person's email addresses.
          { # A person's email address.
            "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
            "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
            "value": "A String", # The email address.
            "metadata": { # Metadata about a field. # Metadata about the email address.
              "source": { # The source of a field. # The source of the field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
            },
          },
        ],
      },
    ],
    "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
    "nextSyncToken": "A String", # The token that can be used to retrieve changes 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.
google-api-python-client-1.5.5/docs/dyn/people_v1.people.html000066400000000000000000002266531300622755700241520ustar00rootroot00000000000000

Google People API . people

Instance Methods

connections()

Returns the connections Resource.

get(resourceName, x__xgafv=None, requestMask_includeField=None)

Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.

getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)

Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.

Method Details

get(resourceName, x__xgafv=None, requestMask_includeField=None) 
Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.

Args:
  resourceName: string, The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
  x__xgafv: string, V1 error format.
  requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.

Returns:
  An object of the form:

    { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
    "phoneNumbers": [ # The person's phone numbers.
      { # A person's phone number.
        "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
        "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
        "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
        "value": "A String", # The phone number.
        "metadata": { # Metadata about a field. # Metadata about the phone number.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "addresses": [ # The person's street addresses.
      { # A person's physical address. May be a P.O. box or street address. All fields are optional.
        "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
        "city": "A String", # The city of the address.
        "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "region": "A String", # The region of the address; for example, the state or province.
        "poBox": "A String", # The P.O. box of the address.
        "streetAddress": "A String", # The street address.
        "country": "A String", # The country of the address.
        "postalCode": "A String", # The postal code of the address.
        "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
        "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
        "metadata": { # Metadata about a field. # Metadata about the address.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "nicknames": [ # The person's nicknames.
      { # A person's nickname.
        "type": "A String", # The type of the nickname.
        "value": "A String", # The nickname.
        "metadata": { # Metadata about a field. # Metadata about the nickname.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "occupations": [ # The person's occupations.
      { # A person's occupation.
        "value": "A String", # The occupation; for example, `carpenter`.
        "metadata": { # Metadata about a field. # Metadata about the occupation.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "braggingRights": [ # The person's bragging rights.
      { # A person's bragging rights.
        "value": "A String", # The bragging rights; for example, `climbed mount everest`.
        "metadata": { # Metadata about a field. # Metadata about the bragging rights.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "names": [ # The person's names.
      { # A person's name. If the name is a mononym, the family name is empty.
        "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
        "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
        "phoneticFamilyName": "A String", # The family name spelled as it sounds.
        "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
        "middleName": "A String", # The middle name(s).
        "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
        "familyName": "A String", # The family name.
        "phoneticGivenName": "A String", # The given name spelled as it sounds.
        "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
        "givenName": "A String", # The given name.
        "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
        "metadata": { # Metadata about a field. # Metadata about the name.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
    "birthdays": [ # The person's birthdays.
      { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
        "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
          "month": 42, # Month of year. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
        },
        "text": "A String", # A free-form string representing the user's birthday.
        "metadata": { # Metadata about a field. # Metadata about the birthday.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "relations": [ # The person's relations.
      { # A person's relation to another person.
        "person": "A String", # The name of the other person this relation refers to.
        "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
        "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
        "metadata": { # Metadata about a field. # Metadata about the relation.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
    "relationshipStatuses": [ # The person's relationship statuses.
      { # A person's relationship status.
        "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
        "metadata": { # Metadata about a field. # Metadata about the relationship status.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "skills": [ # The person's skills.
      { # A skill that the person has.
        "value": "A String", # The skill; for example, `underwater basket weaving`.
        "metadata": { # Metadata about a field. # Metadata about the skill.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "imClients": [ # The person's instant messaging clients.
      { # A person's instant messaging client.
        "username": "A String", # The user name used in the IM client.
        "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
        "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
        "metadata": { # Metadata about a field. # Metadata about the IM client.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "events": [ # The person's events.
      { # An event related to the person.
        "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
          "month": 42, # Month of year. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
        },
        "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
        "metadata": { # Metadata about a field. # Metadata about the event.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "metadata": { # Metadata about a person. # Metadata about the person.
      "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
        "A String",
      ],
      "sources": [ # The sources of data for the person.
        { # The source of a field.
          "type": "A String", # The source type.
          "id": "A String", # A unique identifier within the source type generated by the server.
        },
      ],
      "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
      "objectType": "A String", # The type of the person object.
    },
    "interests": [ # The person's interests.
      { # One of the person's interests.
        "value": "A String", # The interest; for example, `stargazing`.
        "metadata": { # Metadata about a field. # Metadata about the interest.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "photos": [ # The person's photos.
      { # A person's photo. A picture shown next to the person's name to help others recognize the person.
        "url": "A String", # The URL of the photo.
        "metadata": { # Metadata about a field. # Metadata about the photo.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "residences": [ # The person's residences.
      { # A person's past or current residence.
        "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
        "value": "A String", # The address of the residence.
        "metadata": { # Metadata about a field. # Metadata about the residence.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "relationshipInterests": [ # The kind of relationship the person is looking for.
      { # The kind of relationship the person is looking for.
        "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
        "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
        "metadata": { # Metadata about a field. # Metadata about the relationship interest.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "coverPhotos": [ # The person's cover photos.
      { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
        "url": "A String", # The URL of the cover photo.
        "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
        "metadata": { # Metadata about a field. # Metadata about the cover photo.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "locales": [ # The person's locale preferences.
      { # A person's locale preference.
        "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
        "metadata": { # Metadata about a field. # Metadata about the locale.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "organizations": [ # The person's past or current organizations.
      { # A person's past or current organization. Overlapping date ranges are permitted.
        "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
        "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
          "month": 42, # Month of year. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
        },
        "name": "A String", # The name of the organization.
        "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
          "month": 42, # Month of year. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
        },
        "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
        "title": "A String", # The person's job title at the organization.
        "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
        "jobDescription": "A String", # The person's job description at the organization.
        "location": "A String", # The location of the organization office the person works at.
        "department": "A String", # The person's department at the organization.
        "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
        "phoneticName": "A String", # The phonetic name of the organization.
        "metadata": { # Metadata about a field. # Metadata about the organization.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "biographies": [ # The person's biographies.
      { # A person's short biography.
        "value": "A String", # The short biography.
        "metadata": { # Metadata about a field. # Metadata about the biography.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "memberships": [ # The person's group memberships.
      { # A person's membership in a group.
        "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
          "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
        },
        "domainMembership": { # A Google Apps Domain membership. # The domain membership.
          "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
        },
        "metadata": { # Metadata about a field. # Metadata about the membership.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "taglines": [ # The person's taglines.
      { # A brief one-line description of the person.
        "value": "A String", # The tagline.
        "metadata": { # Metadata about a field. # Metadata about the tagline.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "urls": [ # The person's associated URLs.
      { # A person's associated URLs.
        "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
        "value": "A String", # The URL.
        "metadata": { # Metadata about a field. # Metadata about the URL.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "ageRange": "A String", # The person's age range.
    "genders": [ # The person's genders.
      { # A person's gender.
        "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
        "metadata": { # Metadata about a field. # Metadata about the gender.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
    "emailAddresses": [ # The person's email addresses.
      { # A person's email address.
        "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
        "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
        "value": "A String", # The email address.
        "metadata": { # Metadata about a field. # Metadata about the email address.
          "source": { # The source of a field. # The source of the field.
            "type": "A String", # The source type.
            "id": "A String", # A unique identifier within the source type generated by the server.
          },
          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
        },
      },
    ],
  }
getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None) 
Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.

Args:
  resourceNames: string, The resource name, such as one returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list), of one of the people to provide information about. You can include this parameter up to 50 times in one request. (repeated)
  x__xgafv: string, V1 error format.
  requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.

Returns:
  An object of the form:

    {
    "responses": [ # The response for each requested resource name.
      { # The response for a single person
        "requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
        "person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.
          "phoneNumbers": [ # The person's phone numbers.
            { # A person's phone number.
              "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
              "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
              "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
              "value": "A String", # The phone number.
              "metadata": { # Metadata about a field. # Metadata about the phone number.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "addresses": [ # The person's street addresses.
            { # A person's physical address. May be a P.O. box or street address. All fields are optional.
              "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
              "city": "A String", # The city of the address.
              "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "region": "A String", # The region of the address; for example, the state or province.
              "poBox": "A String", # The P.O. box of the address.
              "streetAddress": "A String", # The street address.
              "country": "A String", # The country of the address.
              "postalCode": "A String", # The postal code of the address.
              "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
              "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
              "metadata": { # Metadata about a field. # Metadata about the address.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "nicknames": [ # The person's nicknames.
            { # A person's nickname.
              "type": "A String", # The type of the nickname.
              "value": "A String", # The nickname.
              "metadata": { # Metadata about a field. # Metadata about the nickname.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "occupations": [ # The person's occupations.
            { # A person's occupation.
              "value": "A String", # The occupation; for example, `carpenter`.
              "metadata": { # Metadata about a field. # Metadata about the occupation.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "braggingRights": [ # The person's bragging rights.
            { # A person's bragging rights.
              "value": "A String", # The bragging rights; for example, `climbed mount everest`.
              "metadata": { # Metadata about a field. # Metadata about the bragging rights.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "names": [ # The person's names.
            { # A person's name. If the name is a mononym, the family name is empty.
              "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
              "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
              "phoneticFamilyName": "A String", # The family name spelled as it sounds.
              "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
              "middleName": "A String", # The middle name(s).
              "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
              "familyName": "A String", # The family name.
              "phoneticGivenName": "A String", # The given name spelled as it sounds.
              "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
              "givenName": "A String", # The given name.
              "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
              "metadata": { # Metadata about a field. # Metadata about the name.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
          "birthdays": [ # The person's birthdays.
            { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
              "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
                "month": 42, # Month of year. Must be from 1 to 12.
                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
              },
              "text": "A String", # A free-form string representing the user's birthday.
              "metadata": { # Metadata about a field. # Metadata about the birthday.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "relations": [ # The person's relations.
            { # A person's relation to another person.
              "person": "A String", # The name of the other person this relation refers to.
              "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
              "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
              "metadata": { # Metadata about a field. # Metadata about the relation.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
          "relationshipStatuses": [ # The person's relationship statuses.
            { # A person's relationship status.
              "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
              "metadata": { # Metadata about a field. # Metadata about the relationship status.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "skills": [ # The person's skills.
            { # A skill that the person has.
              "value": "A String", # The skill; for example, `underwater basket weaving`.
              "metadata": { # Metadata about a field. # Metadata about the skill.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "imClients": [ # The person's instant messaging clients.
            { # A person's instant messaging client.
              "username": "A String", # The user name used in the IM client.
              "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
              "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
              "metadata": { # Metadata about a field. # Metadata about the IM client.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "events": [ # The person's events.
            { # An event related to the person.
              "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
                "month": 42, # Month of year. Must be from 1 to 12.
                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
              },
              "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
              "metadata": { # Metadata about a field. # Metadata about the event.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "metadata": { # Metadata about a person. # Metadata about the person.
            "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
              "A String",
            ],
            "sources": [ # The sources of data for the person.
              { # The source of a field.
                "type": "A String", # The source type.
                "id": "A String", # A unique identifier within the source type generated by the server.
              },
            ],
            "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
            "objectType": "A String", # The type of the person object.
          },
          "interests": [ # The person's interests.
            { # One of the person's interests.
              "value": "A String", # The interest; for example, `stargazing`.
              "metadata": { # Metadata about a field. # Metadata about the interest.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "photos": [ # The person's photos.
            { # A person's photo. A picture shown next to the person's name to help others recognize the person.
              "url": "A String", # The URL of the photo.
              "metadata": { # Metadata about a field. # Metadata about the photo.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "residences": [ # The person's residences.
            { # A person's past or current residence.
              "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
              "value": "A String", # The address of the residence.
              "metadata": { # Metadata about a field. # Metadata about the residence.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "relationshipInterests": [ # The kind of relationship the person is looking for.
            { # The kind of relationship the person is looking for.
              "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
              "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
              "metadata": { # Metadata about a field. # Metadata about the relationship interest.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "coverPhotos": [ # The person's cover photos.
            { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
              "url": "A String", # The URL of the cover photo.
              "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
              "metadata": { # Metadata about a field. # Metadata about the cover photo.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "locales": [ # The person's locale preferences.
            { # A person's locale preference.
              "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
              "metadata": { # Metadata about a field. # Metadata about the locale.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "organizations": [ # The person's past or current organizations.
            { # A person's past or current organization. Overlapping date ranges are permitted.
              "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
              "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
                "month": 42, # Month of year. Must be from 1 to 12.
                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
              },
              "name": "A String", # The name of the organization.
              "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
                "month": 42, # Month of year. Must be from 1 to 12.
                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
              },
              "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
              "title": "A String", # The person's job title at the organization.
              "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
              "jobDescription": "A String", # The person's job description at the organization.
              "location": "A String", # The location of the organization office the person works at.
              "department": "A String", # The person's department at the organization.
              "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
              "phoneticName": "A String", # The phonetic name of the organization.
              "metadata": { # Metadata about a field. # Metadata about the organization.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "biographies": [ # The person's biographies.
            { # A person's short biography.
              "value": "A String", # The short biography.
              "metadata": { # Metadata about a field. # Metadata about the biography.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "memberships": [ # The person's group memberships.
            { # A person's membership in a group.
              "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
                "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
              },
              "domainMembership": { # A Google Apps Domain membership. # The domain membership.
                "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
              },
              "metadata": { # Metadata about a field. # Metadata about the membership.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "taglines": [ # The person's taglines.
            { # A brief one-line description of the person.
              "value": "A String", # The tagline.
              "metadata": { # Metadata about a field. # Metadata about the tagline.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "urls": [ # The person's associated URLs.
            { # A person's associated URLs.
              "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
              "value": "A String", # The URL.
              "metadata": { # Metadata about a field. # Metadata about the URL.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "ageRange": "A String", # The person's age range.
          "genders": [ # The person's genders.
            { # A person's gender.
              "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
              "metadata": { # Metadata about a field. # Metadata about the gender.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
          "emailAddresses": [ # The person's email addresses.
            { # A person's email address.
              "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
              "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
              "value": "A String", # The email address.
              "metadata": { # Metadata about a field. # Metadata about the email address.
                "source": { # The source of a field. # The source of the field.
                  "type": "A String", # The source type.
                  "id": "A String", # A unique identifier within the source type generated by the server.
                },
                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
              },
            },
          ],
        },
        "httpStatusCode": 42, # [HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.avails.html000066400000000000000000000366211300622755700302550ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . avails

Instance Methods

get(accountId, availId, x__xgafv=None)

Get an Avail given its avail group id and avail id.

list(accountId, pphNames=None, pageSize=None, territories=None, altIds=None, x__xgafv=None, title=None, studioNames=None, pageToken=None, videoIds=None, altId=None)

List Avails owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId, availId, x__xgafv=None) 
Get an Avail given its avail group id and avail id.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  availId: string, REQUIRED. Avail ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An Avail describes the Availability Window of a specific Edit in a given country, which means the period Google is allowed to sell or rent the Edit. Avails are exposed in EMA format Version 1.6b (available at http://www.movielabs.com/md/avails/) Studios can see the Avails for the Titles they own. Post-production houses cannot see any Avails.
    "pphNames": [ # Name of the post-production houses that manage the Avail. Not part of EMA Specs.
      "A String",
    ],
    "licenseType": "A String", # Type of transaction.
    "captionIncluded": True or False, # Communicating if caption file will be delivered.
    "releaseDate": "A String", # Release date of the Title in earliest released territory. Typically it is just the year, but it is free-form as per EMA spec. Examples: "1979", "Oct 2014"
    "episodeAltId": "A String", # Other identifier referring to the episode, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1_3".
    "episodeTitleInternalAlias": "A String", # OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV Avails. Example: "Coding at Google".
    "availId": "A String", # ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs.
    "end": "A String", # End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end date is available. Example: "2019-02-17"
    "altId": "A String", # Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006"
    "seriesAltId": "A String", # Other identifier referring to the series, as defined by partner. Only available on TV avails. Example: "rs_googlers".
    "start": "A String", # Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: "2013-05-14".
    "titleInternalAlias": "A String", # Title used by involved parties to refer to this content. Example: "Googlers, The". Only available on Movie Avails.
    "seasonTitleInternalAlias": "A String", # Title used by involved parties to refer to this season. Only available on TV Avails. Example: "Googlers, The".
    "territory": "A String", # ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use Territory in lieu of Country to comply with EMA specifications. But please note that Territory and Country identify the same thing. Example: "US".
    "productId": "A String", # Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-6"
    "storeLanguage": "A String", # Spoken language of the intended audience. Language shall be encoded in accordance with RFC 5646. Example: "fr".
    "seasonNumber": "A String", # The number assigned to the season within a series. Only available on TV Avails. Example: "1".
    "episodeNumber": "A String", # The number assigned to the episode within a season. Only available on TV Avails. Example: "3".
    "formatProfile": "A String", # Indicates the format profile covered by the transaction.
    "priceValue": "A String", # Value to be applied to the pricing type. Example: "4" or "2.99"
    "videoId": "A String", # Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA Specs. Example: 'gtry456_xc'
    "ratingReason": "A String", # Value representing the rating reason. Rating reasons should be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) and comma-separated for inclusion of multiple reasons. Example: "L, S, V"
    "captionExemption": "A String", # Communicating an exempt category as defined by FCC regulations. It is not required for non-US Avails. Example: "1"
    "workType": "A String", # Work type as enumerated in EMA.
    "ratingValue": "A String", # Value representing the rating. Ratings should be formatted as per http://www.movielabs.com/md/ratings/ Example: "PG"
    "displayName": "A String", # The name of the studio that owns the Edit referred in the Avail. This is the equivalent of `studio_name` in other resources, but it follows the EMA nomenclature. Example: "Google Films".
    "seasonAltId": "A String", # Other identifier referring to the season, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1".
    "contentId": "A String", # Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
    "ratingSystem": "A String", # Rating system applied to the version of title within territory of Avail. Rating systems should be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) Example: "MPAA"
    "encodeId": "A String", # Manifestation Identifier. This should be the Manifestation Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-7"
    "seriesTitleInternalAlias": "A String", # Title used by involved parties to refer to this series. Only available on TV Avails. Example: "Googlers, The".
    "suppressionLiftDate": "A String", # First date an Edit could be publically announced as becoming available at a specific future date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY-MM-DD. Only available for pre-orders. Example: "2012-12-10"
    "priceType": "A String", # Type of pricing that should be applied to this Avail based on how the partner classify them. Example: "Tier", "WSP", "SRP", or "Category".
  }
list(accountId, pphNames=None, pageSize=None, territories=None, altIds=None, x__xgafv=None, title=None, studioNames=None, pageToken=None, videoIds=None, altId=None) 
List Avails owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  pphNames: string, See _List methods rules_ for info about this field. (repeated)
  pageSize: integer, See _List methods rules_ for info about this field.
  territories: string, Filter Avails that match (case-insensitive) any of the given country codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us"). (repeated)
  altIds: string, Filter Avails that match (case-insensitive) any of the given partner-specific custom ids. (repeated)
  x__xgafv: string, V1 error format.
  title: string, Filter that matches Avails with a `title_internal_alias`, `series_title_internal_alias`, `season_title_internal_alias`, or `episode_title_internal_alias` that contains the given case-insensitive title.
  studioNames: string, See _List methods rules_ for info about this field. (repeated)
  pageToken: string, See _List methods rules_ for info about this field.
  videoIds: string, Filter Avails that match any of the given `video_id`s. (repeated)
  altId: string, Filter Avails that match a case-insensitive, partner-specific custom id. NOTE: this field is deprecated and will be removed on V2; `alt_ids` should be used instead.

Returns:
  An object of the form:

    { # Response to the 'ListAvails' method.
    "nextPageToken": "A String", # See _List methods rules_ for info about this field.
    "totalSize": 42, # See _List methods rules_ for more information about this field.
    "avails": [ # List of Avails that match the request criteria.
      { # An Avail describes the Availability Window of a specific Edit in a given country, which means the period Google is allowed to sell or rent the Edit. Avails are exposed in EMA format Version 1.6b (available at http://www.movielabs.com/md/avails/) Studios can see the Avails for the Titles they own. Post-production houses cannot see any Avails.
        "pphNames": [ # Name of the post-production houses that manage the Avail. Not part of EMA Specs.
          "A String",
        ],
        "licenseType": "A String", # Type of transaction.
        "captionIncluded": True or False, # Communicating if caption file will be delivered.
        "releaseDate": "A String", # Release date of the Title in earliest released territory. Typically it is just the year, but it is free-form as per EMA spec. Examples: "1979", "Oct 2014"
        "episodeAltId": "A String", # Other identifier referring to the episode, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1_3".
        "episodeTitleInternalAlias": "A String", # OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV Avails. Example: "Coding at Google".
        "availId": "A String", # ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs.
        "end": "A String", # End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end date is available. Example: "2019-02-17"
        "altId": "A String", # Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006"
        "seriesAltId": "A String", # Other identifier referring to the series, as defined by partner. Only available on TV avails. Example: "rs_googlers".
        "start": "A String", # Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: "2013-05-14".
        "titleInternalAlias": "A String", # Title used by involved parties to refer to this content. Example: "Googlers, The". Only available on Movie Avails.
        "seasonTitleInternalAlias": "A String", # Title used by involved parties to refer to this season. Only available on TV Avails. Example: "Googlers, The".
        "territory": "A String", # ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use Territory in lieu of Country to comply with EMA specifications. But please note that Territory and Country identify the same thing. Example: "US".
        "productId": "A String", # Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-6"
        "storeLanguage": "A String", # Spoken language of the intended audience. Language shall be encoded in accordance with RFC 5646. Example: "fr".
        "seasonNumber": "A String", # The number assigned to the season within a series. Only available on TV Avails. Example: "1".
        "episodeNumber": "A String", # The number assigned to the episode within a season. Only available on TV Avails. Example: "3".
        "formatProfile": "A String", # Indicates the format profile covered by the transaction.
        "priceValue": "A String", # Value to be applied to the pricing type. Example: "4" or "2.99"
        "videoId": "A String", # Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA Specs. Example: 'gtry456_xc'
        "ratingReason": "A String", # Value representing the rating reason. Rating reasons should be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) and comma-separated for inclusion of multiple reasons. Example: "L, S, V"
        "captionExemption": "A String", # Communicating an exempt category as defined by FCC regulations. It is not required for non-US Avails. Example: "1"
        "workType": "A String", # Work type as enumerated in EMA.
        "ratingValue": "A String", # Value representing the rating. Ratings should be formatted as per http://www.movielabs.com/md/ratings/ Example: "PG"
        "displayName": "A String", # The name of the studio that owns the Edit referred in the Avail. This is the equivalent of `studio_name` in other resources, but it follows the EMA nomenclature. Example: "Google Films".
        "seasonAltId": "A String", # Other identifier referring to the season, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1".
        "contentId": "A String", # Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
        "ratingSystem": "A String", # Rating system applied to the version of title within territory of Avail. Rating systems should be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) Example: "MPAA"
        "encodeId": "A String", # Manifestation Identifier. This should be the Manifestation Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-7"
        "seriesTitleInternalAlias": "A String", # Title used by involved parties to refer to this series. Only available on TV Avails. Example: "Googlers, The".
        "suppressionLiftDate": "A String", # First date an Edit could be publically announced as becoming available at a specific future date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY-MM-DD. Only available for pre-orders. Example: "2012-12-10"
        "priceType": "A String", # Type of pricing that should be applied to this Avail based on how the partner classify them. Example: "Tier", "WSP", "SRP", or "Category".
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.components.html000066400000000000000000000165371300622755700311670ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . components

Instance Methods

type()

Returns the type Resource.

list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, playableSequenceId=None, studioNames=None, filename=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, presentationId=None, inventoryId=None, altCutId=None, elId=None)

List Components owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, playableSequenceId=None, studioNames=None, filename=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, presentationId=None, inventoryId=None, altCutId=None, elId=None) 
List Components owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  pphNames: string, See _List methods rules_ for info about this field. (repeated)
  pageSize: integer, See _List methods rules_ for info about this field.
  editLevelEidr: string, Filter Components that match a given edit-level EIDR.
  x__xgafv: string, V1 error format.
  playableSequenceId: string, PlayableSequenceID available in Common Manifest.
  studioNames: string, See _List methods rules_ for info about this field. (repeated)
  filename: string, Filter Components that match a case-insensitive substring of the physical name of the delivered file.
  pageToken: string, See _List methods rules_ for info about this field.
  customId: string, Filter Components that match a case-insensitive partner-specific custom id.
  status: string, Filter Components that match one of the given status. (repeated)
  titleLevelEidr: string, Filter Components that match a given title-level EIDR.
  presentationId: string, PresentationID available in Common Manifest.
  inventoryId: string, InventoryID available in Common Manifest.
  altCutId: string, Filter Components that match a case-insensitive, partner-specific Alternative Cut ID.
  elId: string, Experience ID, as defined by Google.

Returns:
  An object of the form:

    { # Response to the 'ListComponents' method.
    "nextPageToken": "A String", # See _List methods rules_ for info about this field.
    "totalSize": 42, # See _List methods rules_ for more information about this field.
    "components": [ # List of Components that match the request criteria.
      { # A Component is an element (audio, video, subtitle, artwork, trailer, etc...) that is used in a set of ExperienceLocales. A Component is owned by a Studio and managed either by the Studio itself or by one Post-Production House. Each Component is identified by a `component_id` and its `type`.
        "altCutIds": [ # List of Alternative Cut IDs, sometimes available in lieu of the main Edit-level EIDR IDs. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
          "A String",
        ],
        "processingErrors": [ # Processing errors during XML file parsing. Example: 'Invalid input file'
          "A String",
        ],
        "studioName": "A String", # Name of the studio that owns the Component.
        "rejectionNote": "A String", # Notes explaining why a Component has been rejected.
        "titleLevelEidrs": [ # List of Title-level EIDR IDs. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
          "A String",
        ],
        "playableUnitType": "A String", # Type of the playable unit for which the Component is intended.
        "receivedTime": "A String", # Timestamp when the Component was received.
        "filename": "A String", # File name of the Component when delivered.
        "priority": 3.14, # Component priority, as defined by Google. The higher the value, the higher the priority.
        "editLevelEidrs": [ # List of Edit-level EIDR IDs. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
          "A String",
        ],
        "type": "A String", # Type of the Component. Example: AUDIO_51
        "componentId": "A String", # ID internally generated by Google to uniquely identify the Component. Example: 'wteyrc_647xc'
        "status": "A String", # High-level status of the Component.
        "statusDetail": "A String", # Detailed status of the Component
        "approvedTime": "A String", # Timestamp when the Component was approved.
        "elIds": [ # IDs internally generated by Google to uniquely identify the ExperienceLocales for which the Component is used. Example: 'KRZiVjY9h7t'
          "A String",
        ],
        "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
        "language": "A String", # Language of the component, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
        "componentDetailType": "A String", # Detail about the type of the Component.
        "customIds": [ # List of custom IDs (defined by the partner) linked to the ExperienceLocale using this Component. Example: "R86241"
          "A String",
        ],
        "pphName": "A String", # Name of the post-production house that manages the Component.
        "normalizedPriority": "A String", # A simpler representation of the priority.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.components.type.html000066400000000000000000000107331300622755700321370ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . components . type

Instance Methods

get(accountId, componentId, type, x__xgafv=None)

Get a Component given its id.

Method Details

get(accountId, componentId, type, x__xgafv=None) 
Get a Component given its id.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  componentId: string, REQUIRED. Component ID. (required)
  type: string, REQUIRED. Component Type. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A Component is an element (audio, video, subtitle, artwork, trailer, etc...) that is used in a set of ExperienceLocales. A Component is owned by a Studio and managed either by the Studio itself or by one Post-Production House. Each Component is identified by a `component_id` and its `type`.
    "altCutIds": [ # List of Alternative Cut IDs, sometimes available in lieu of the main Edit-level EIDR IDs. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
      "A String",
    ],
    "processingErrors": [ # Processing errors during XML file parsing. Example: 'Invalid input file'
      "A String",
    ],
    "studioName": "A String", # Name of the studio that owns the Component.
    "rejectionNote": "A String", # Notes explaining why a Component has been rejected.
    "titleLevelEidrs": [ # List of Title-level EIDR IDs. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
      "A String",
    ],
    "playableUnitType": "A String", # Type of the playable unit for which the Component is intended.
    "receivedTime": "A String", # Timestamp when the Component was received.
    "filename": "A String", # File name of the Component when delivered.
    "priority": 3.14, # Component priority, as defined by Google. The higher the value, the higher the priority.
    "editLevelEidrs": [ # List of Edit-level EIDR IDs. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
      "A String",
    ],
    "type": "A String", # Type of the Component. Example: AUDIO_51
    "componentId": "A String", # ID internally generated by Google to uniquely identify the Component. Example: 'wteyrc_647xc'
    "status": "A String", # High-level status of the Component.
    "statusDetail": "A String", # Detailed status of the Component
    "approvedTime": "A String", # Timestamp when the Component was approved.
    "elIds": [ # IDs internally generated by Google to uniquely identify the ExperienceLocales for which the Component is used. Example: 'KRZiVjY9h7t'
      "A String",
    ],
    "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
    "language": "A String", # Language of the component, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
    "componentDetailType": "A String", # Detail about the type of the Component.
    "customIds": [ # List of custom IDs (defined by the partner) linked to the ExperienceLocale using this Component. Example: "R86241"
      "A String",
    ],
    "pphName": "A String", # Name of the post-production house that manages the Component.
    "normalizedPriority": "A String", # A simpler representation of the priority.
  }
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.experienceLocales.html000066400000000000000000000255171300622755700324320ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . experienceLocales

Instance Methods

get(accountId, elId, x__xgafv=None)

Get an ExperienceLocale given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.

list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, altCutId=None)

List ExperienceLocales owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId, elId, x__xgafv=None) 
Get an ExperienceLocale given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  elId: string, REQUIRED. ExperienceLocale ID, as defined by Google. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An ExperienceLocale tracks the fulfillment of a Title in a country using a specific language, when delivered using component-based delivery. For example, a Title in Switzerland might have 3 ExperienceLocales: they both share the same country ("CH"), but each has different languages ("de", "fr", and "it"). Each ExperienceLocale is uniquely identified by an `el_id`, which is generated by Google. Externally, an ExperienceLocale can also be identified by partners using its EIDR IDs, AltCutID or `custom_id` (when provided).
    "pphNames": [ # Name of the post-production houses that manage the ExperienceLocale.
      "A String",
    ],
    "channelId": "A String", # YouTube Channel ID linked to the ExperienceLocale. Example: "UCRG64darCZhb".
    "studioName": "A String", # Name of the studio that owns the ExperienceLocale.
    "editLevelEidr": "A String", # Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
    "playableSequenceId": "A String", # PlayableSequenceID as defined in the EMA specs.
    "presentationId": "A String", # PresentationID as defined in the EMA specs.
    "priority": 3.14, # ExperienceLocale priority, as defined by Google. The higher the value, the higher the priority. Example: 90
    "type": "A String", # Type of the Edit linked to the ExperienceLocale.
    "status": "A String", # High-level status of the ExperienceLocale.
    "titleLevelEidr": "A String", # Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
    "trailerId": "A String", # Trailer ID, as defined by Google, linked to the trailer video in the ExperienceLocale. Example: 'gtry457_tr'.
    "videoId": "A String", # Video ID, as defined by Google, linked to the feature video in the ExperienceLocale. Example: 'gtry456_xc'.
    "approvedTime": "A String", # Timestamp when the ExperienceLocale was approved.
    "inventoryId": "A String", # InventoryID as defined in the EMA specs.
    "altCutId": "A String", # Alternative Cut ID, sometimes available in lieu of the main Edit-level EIDR ID. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
    "earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails linked to this ExperienceLocale.
    "elId": "A String", # ID internally generated by Google to uniquely identify a ExperienceLocale. Example: 'KRZiVjY9h7t'
    "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
    "language": "A String", # Language of the ExperienceLocale, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
    "country": "A String", # Country where the ExperienceLocale is available, using the "ISO 3166-1 alpha-2" format. Example: "US".
    "customIds": [ # List of custom IDs (defined by the partner) linked to this ExperienceLocale. Example: "R86241"
      "A String",
    ],
    "normalizedPriority": "A String", # A simpler representation of the priority.
    "createdTime": "A String", # Timestamp when the ExperienceLocale was created.
  }
list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, altCutId=None) 
List ExperienceLocales owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  pphNames: string, See _List methods rules_ for info about this field. (repeated)
  pageSize: integer, See _List methods rules_ for info about this field.
  editLevelEidr: string, Filter ExperienceLocales that match a given edit-level EIDR.
  x__xgafv: string, V1 error format.
  studioNames: string, See _List methods rules_ for info about this field. (repeated)
  pageToken: string, See _List methods rules_ for info about this field.
  customId: string, Filter ExperienceLocales that match a case-insensitive, partner-specific custom id.
  status: string, Filter ExperienceLocales that match one of the given status. (repeated)
  titleLevelEidr: string, Filter ExperienceLocales that match a given title-level EIDR.
  altCutId: string, Filter ExperienceLocales that match a case-insensitive, partner-specific Alternative Cut ID.

Returns:
  An object of the form:

    { # Response to the 'ListExperienceLocales' method.
    "nextPageToken": "A String", # See _List methods rules_ for info about this field.
    "totalSize": 42, # See _List methods rules_ for more information about this field.
    "experienceLocales": [ # List of ExperienceLocales that match the request criteria.
      { # An ExperienceLocale tracks the fulfillment of a Title in a country using a specific language, when delivered using component-based delivery. For example, a Title in Switzerland might have 3 ExperienceLocales: they both share the same country ("CH"), but each has different languages ("de", "fr", and "it"). Each ExperienceLocale is uniquely identified by an `el_id`, which is generated by Google. Externally, an ExperienceLocale can also be identified by partners using its EIDR IDs, AltCutID or `custom_id` (when provided).
        "pphNames": [ # Name of the post-production houses that manage the ExperienceLocale.
          "A String",
        ],
        "channelId": "A String", # YouTube Channel ID linked to the ExperienceLocale. Example: "UCRG64darCZhb".
        "studioName": "A String", # Name of the studio that owns the ExperienceLocale.
        "editLevelEidr": "A String", # Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
        "playableSequenceId": "A String", # PlayableSequenceID as defined in the EMA specs.
        "presentationId": "A String", # PresentationID as defined in the EMA specs.
        "priority": 3.14, # ExperienceLocale priority, as defined by Google. The higher the value, the higher the priority. Example: 90
        "type": "A String", # Type of the Edit linked to the ExperienceLocale.
        "status": "A String", # High-level status of the ExperienceLocale.
        "titleLevelEidr": "A String", # Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
        "trailerId": "A String", # Trailer ID, as defined by Google, linked to the trailer video in the ExperienceLocale. Example: 'gtry457_tr'.
        "videoId": "A String", # Video ID, as defined by Google, linked to the feature video in the ExperienceLocale. Example: 'gtry456_xc'.
        "approvedTime": "A String", # Timestamp when the ExperienceLocale was approved.
        "inventoryId": "A String", # InventoryID as defined in the EMA specs.
        "altCutId": "A String", # Alternative Cut ID, sometimes available in lieu of the main Edit-level EIDR ID. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
        "earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails linked to this ExperienceLocale.
        "elId": "A String", # ID internally generated by Google to uniquely identify a ExperienceLocale. Example: 'KRZiVjY9h7t'
        "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
        "language": "A String", # Language of the ExperienceLocale, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
        "country": "A String", # Country where the ExperienceLocale is available, using the "ISO 3166-1 alpha-2" format. Example: "US".
        "customIds": [ # List of custom IDs (defined by the partner) linked to this ExperienceLocale. Example: "R86241"
          "A String",
        ],
        "normalizedPriority": "A String", # A simpler representation of the priority.
        "createdTime": "A String", # Timestamp when the ExperienceLocale was created.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.html000066400000000000000000000037121300622755700267720ustar00rootroot00000000000000

Google Play Movies Partner API . accounts

Instance Methods

avails()

Returns the avails Resource.

components()

Returns the components Resource.

experienceLocales()

Returns the experienceLocales Resource.

orders()

Returns the orders Resource.

storeInfos()

Returns the storeInfos Resource.

google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.orders.html000066400000000000000000000242321300622755700302670ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . orders

Instance Methods

get(accountId, orderId, x__xgafv=None)

Get an Order given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.

list(accountId, pphNames=None, pageSize=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, videoIds=None, name=None)

List Orders owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId, orderId, x__xgafv=None) 
Get an Order given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  orderId: string, REQUIRED. Order ID. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An Order tracks the fulfillment of an Edit when delivered using the legacy, non-component-based delivery. Each Order is uniquely identified by an `order_id`, which is generated by Google. Externally, Orders can also be identified by partners using its `custom_id` (when provided).
    "status": "A String", # High-level status of the order.
    "channelId": "A String", # YouTube Channel ID that should be used to fulfill the Order. Example: "UCRG64darCZhb".
    "studioName": "A String", # Name of the studio that owns the Edit ordered.
    "rejectionNote": "A String", # Field explaining why an Order has been rejected. Example: "Trailer audio is 2ch mono, please re-deliver in stereo".
    "episodeName": "A String", # Default Episode name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - Pilot".
    "receivedTime": "A String", # Timestamp when the Order was fulfilled.
    "priority": 3.14, # Order priority, as defined by Google. The higher the value, the higher the priority. Example: 90
    "customId": "A String", # ID that can be used to externally identify an Order. This ID is provided by partners when submitting the Avails. Example: 'GOOGLER_2006'
    "channelName": "A String", # YouTube Channel Name that should be used to fulfill the Order. Example: "Google_channel".
    "type": "A String", # Type of the Edit linked to the Order.
    "orderId": "A String", # ID internally generated by Google to uniquely identify an Order. Example: 'abcde12_x'
    "videoId": "A String", # Google-generated ID identifying the video linked to this Order, once delivered. Example: 'gtry456_xc'.
    "statusDetail": "A String", # Detailed status of the order
    "approvedTime": "A String", # Timestamp when the Order was approved.
    "earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails linked to this Order.
    "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
    "countries": [ # Countries where the Order is available, using the "ISO 3166-1 alpha-2" format (example: "US").
      "A String",
    ],
    "normalizedPriority": "A String", # A simpler representation of the priority.
    "orderedTime": "A String", # Timestamp when the Order was created.
    "pphName": "A String", # Name of the post-production house that manages the Edit ordered.
    "seasonName": "A String", # Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".
    "legacyPriority": "A String", # Legacy Order priority, as defined by Google. Example: 'P0'
    "showName": "A String", # Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".
  }
list(accountId, pphNames=None, pageSize=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, videoIds=None, name=None) 
List Orders owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  pphNames: string, See _List methods rules_ for info about this field. (repeated)
  pageSize: integer, See _List methods rules_ for info about this field.
  x__xgafv: string, V1 error format.
  studioNames: string, See _List methods rules_ for info about this field. (repeated)
  pageToken: string, See _List methods rules_ for info about this field.
  customId: string, Filter Orders that match a case-insensitive, partner-specific custom id.
  status: string, Filter Orders that match one of the given status. (repeated)
  videoIds: string, Filter Orders that match any of the given `video_id`s. (repeated)
  name: string, Filter that matches Orders with a `name`, `show`, `season` or `episode` that contains the given case-insensitive name.

Returns:
  An object of the form:

    { # Response to the 'ListOrders' method.
    "nextPageToken": "A String", # See _List methods rules_ for info about this field.
    "totalSize": 42, # See _List methods rules_ for more information about this field.
    "orders": [ # List of Orders that match the request criteria.
      { # An Order tracks the fulfillment of an Edit when delivered using the legacy, non-component-based delivery. Each Order is uniquely identified by an `order_id`, which is generated by Google. Externally, Orders can also be identified by partners using its `custom_id` (when provided).
        "status": "A String", # High-level status of the order.
        "channelId": "A String", # YouTube Channel ID that should be used to fulfill the Order. Example: "UCRG64darCZhb".
        "studioName": "A String", # Name of the studio that owns the Edit ordered.
        "rejectionNote": "A String", # Field explaining why an Order has been rejected. Example: "Trailer audio is 2ch mono, please re-deliver in stereo".
        "episodeName": "A String", # Default Episode name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - Pilot".
        "receivedTime": "A String", # Timestamp when the Order was fulfilled.
        "priority": 3.14, # Order priority, as defined by Google. The higher the value, the higher the priority. Example: 90
        "customId": "A String", # ID that can be used to externally identify an Order. This ID is provided by partners when submitting the Avails. Example: 'GOOGLER_2006'
        "channelName": "A String", # YouTube Channel Name that should be used to fulfill the Order. Example: "Google_channel".
        "type": "A String", # Type of the Edit linked to the Order.
        "orderId": "A String", # ID internally generated by Google to uniquely identify an Order. Example: 'abcde12_x'
        "videoId": "A String", # Google-generated ID identifying the video linked to this Order, once delivered. Example: 'gtry456_xc'.
        "statusDetail": "A String", # Detailed status of the order
        "approvedTime": "A String", # Timestamp when the Order was approved.
        "earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails linked to this Order.
        "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
        "countries": [ # Countries where the Order is available, using the "ISO 3166-1 alpha-2" format (example: "US").
          "A String",
        ],
        "normalizedPriority": "A String", # A simpler representation of the priority.
        "orderedTime": "A String", # Timestamp when the Order was created.
        "pphName": "A String", # Name of the post-production house that manages the Edit ordered.
        "seasonName": "A String", # Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".
        "legacyPriority": "A String", # Legacy Order priority, as defined by Google. Example: 'P0'
        "showName": "A String", # Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.storeInfos.country.html000066400000000000000000000122011300622755700326170ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . storeInfos . country

Instance Methods

get(accountId, videoId, country, x__xgafv=None)

Get a StoreInfo given its video id and country. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.

Method Details

get(accountId, videoId, country, x__xgafv=None) 
Get a StoreInfo given its video id and country. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  videoId: string, REQUIRED. Video ID. (required)
  country: string, REQUIRED. Edit country. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Information about a playable sequence (video) associated with an Edit and available at the Google Play Store. Internally, each StoreInfo is uniquely identified by a `video_id` and `country`. Externally, Title-level EIDR or Edit-level EIDR, if provided, can also be used to identify a specific title or edit in a country.
    "pphNames": [ # Name of the post-production houses that manage the Edit.
      "A String",
    ],
    "hasEstOffer": True or False, # Whether the Edit has a EST offer.
    "studioName": "A String", # Name of the studio that owns the Edit ordered.
    "hasHdOffer": True or False, # Whether the Edit has a HD offer.
    "editLevelEidr": "A String", # Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
    "episodeNumber": "A String", # The number assigned to the episode within a season. Only available on TV Edits. Example: "1".
    "mid": "A String", # Knowledge Graph ID associated to this Edit, if available. This ID links the Edit to its knowledge entity, externally accessible at http://freebase.com. In the absense of Title EIDR or Edit EIDR, this ID helps link together multiple Edits across countries. Example: '/m/0ffx29'
    "hasAudio51": True or False, # Whether the Edit has a 5.1 channel audio track.
    "hasInfoCards": True or False, # Whether the Edit has info cards.
    "type": "A String", # Edit type, like Movie, Episode or Season.
    "seasonId": "A String", # Google-generated ID identifying the season linked to the Edit. Only available for TV Edits. Example: 'ster23ex'
    "titleLevelEidr": "A String", # Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
    "hasSdOffer": True or False, # Whether the Edit has a SD offer.
    "seasonNumber": "A String", # The number assigned to the season within a show. Only available on TV Edits. Example: "1".
    "liveTime": "A String", # Timestamp when the Edit went live on the Store.
    "trailerId": "A String", # Google-generated ID identifying the trailer linked to the Edit. Example: 'bhd_4e_cx'
    "videoId": "A String", # Google-generated ID identifying the video linked to the Edit. Example: 'gtry456_xc'
    "subtitles": [ # Subtitles available for this Edit.
      "A String",
    ],
    "showId": "A String", # Google-generated ID identifying the show linked to the Edit. Only available for TV Edits. Example: 'et2hsue_x'
    "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
    "country": "A String", # Country where Edit is available in ISO 3166-1 alpha-2 country code. Example: "US".
    "seasonName": "A String", # Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".
    "audioTracks": [ # Audio tracks available for this Edit.
      "A String",
    ],
    "hasVodOffer": True or False, # Whether the Edit has a VOD offer.
    "showName": "A String", # Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".
  }
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.accounts.storeInfos.html000066400000000000000000000167461300622755700311370ustar00rootroot00000000000000

Google Play Movies Partner API . accounts . storeInfos

Instance Methods

country()

Returns the country Resource.

list(accountId, pphNames=None, pageSize=None, x__xgafv=None, seasonIds=None, studioNames=None, pageToken=None, videoId=None, videoIds=None, name=None, countries=None, mids=None)

List StoreInfos owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(accountId, pphNames=None, pageSize=None, x__xgafv=None, seasonIds=None, studioNames=None, pageToken=None, videoId=None, videoIds=None, name=None, countries=None, mids=None) 
List StoreInfos owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.

Args:
  accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
  pphNames: string, See _List methods rules_ for info about this field. (repeated)
  pageSize: integer, See _List methods rules_ for info about this field.
  x__xgafv: string, V1 error format.
  seasonIds: string, Filter StoreInfos that match any of the given `season_id`s. (repeated)
  studioNames: string, See _List methods rules_ for info about this field. (repeated)
  pageToken: string, See _List methods rules_ for info about this field.
  videoId: string, Filter StoreInfos that match a given `video_id`. NOTE: this field is deprecated and will be removed on V2; `video_ids` should be used instead.
  videoIds: string, Filter StoreInfos that match any of the given `video_id`s. (repeated)
  name: string, Filter that matches StoreInfos with a `name` or `show_name` that contains the given case-insensitive name.
  countries: string, Filter StoreInfos that match (case-insensitive) any of the given country codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us"). (repeated)
  mids: string, Filter StoreInfos that match any of the given `mid`s. (repeated)

Returns:
  An object of the form:

    { # Response to the 'ListStoreInfos' method.
    "storeInfos": [ # List of StoreInfos that match the request criteria.
      { # Information about a playable sequence (video) associated with an Edit and available at the Google Play Store. Internally, each StoreInfo is uniquely identified by a `video_id` and `country`. Externally, Title-level EIDR or Edit-level EIDR, if provided, can also be used to identify a specific title or edit in a country.
        "pphNames": [ # Name of the post-production houses that manage the Edit.
          "A String",
        ],
        "hasEstOffer": True or False, # Whether the Edit has a EST offer.
        "studioName": "A String", # Name of the studio that owns the Edit ordered.
        "hasHdOffer": True or False, # Whether the Edit has a HD offer.
        "editLevelEidr": "A String", # Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
        "episodeNumber": "A String", # The number assigned to the episode within a season. Only available on TV Edits. Example: "1".
        "mid": "A String", # Knowledge Graph ID associated to this Edit, if available. This ID links the Edit to its knowledge entity, externally accessible at http://freebase.com. In the absense of Title EIDR or Edit EIDR, this ID helps link together multiple Edits across countries. Example: '/m/0ffx29'
        "hasAudio51": True or False, # Whether the Edit has a 5.1 channel audio track.
        "hasInfoCards": True or False, # Whether the Edit has info cards.
        "type": "A String", # Edit type, like Movie, Episode or Season.
        "seasonId": "A String", # Google-generated ID identifying the season linked to the Edit. Only available for TV Edits. Example: 'ster23ex'
        "titleLevelEidr": "A String", # Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
        "hasSdOffer": True or False, # Whether the Edit has a SD offer.
        "seasonNumber": "A String", # The number assigned to the season within a show. Only available on TV Edits. Example: "1".
        "liveTime": "A String", # Timestamp when the Edit went live on the Store.
        "trailerId": "A String", # Google-generated ID identifying the trailer linked to the Edit. Example: 'bhd_4e_cx'
        "videoId": "A String", # Google-generated ID identifying the video linked to the Edit. Example: 'gtry456_xc'
        "subtitles": [ # Subtitles available for this Edit.
          "A String",
        ],
        "showId": "A String", # Google-generated ID identifying the show linked to the Edit. Only available for TV Edits. Example: 'et2hsue_x'
        "name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
        "country": "A String", # Country where Edit is available in ISO 3166-1 alpha-2 country code. Example: "US".
        "seasonName": "A String", # Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".
        "audioTracks": [ # Audio tracks available for this Edit.
          "A String",
        ],
        "hasVodOffer": True or False, # Whether the Edit has a VOD offer.
        "showName": "A String", # Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".
      },
    ],
    "nextPageToken": "A String", # See 'List methods rules' for info about this field.
    "totalSize": 42, # See _List methods rules_ for more information about this field.
  }
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.
google-api-python-client-1.5.5/docs/dyn/playmoviespartner_v1.html000066400000000000000000000041611300622755700251530ustar00rootroot00000000000000

Google Play Movies Partner API

Instance Methods

accounts()

Returns the accounts Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.activities.html000066400000000000000000001373141300622755700260370ustar00rootroot00000000000000

Google+ Domains API . activities

Instance Methods

get(activityId)

Get an activity.

insert(userId, body, preview=None)

Create a new activity for the authenticated user.

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.

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.
          {
            "previewThumbnails": [ # When previewing, these are the optional thumbnails for the post. When posting an article, choose one by setting the attachment.image.url property. If you don't choose one, one will be chosen for you.
              {
                "url": "A String", # URL of the thumbnail image.
              },
            ],
            "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 of 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 of 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, which 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.
          "displayName": "A String", # The original actor's name, which is suitable for display.
          "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.
          },
          "clientSpecificActorInfo": { # Actor info specific to particular clients.
            "youtubeActorInfo": { # Actor info specific to YouTube clients.
              "channelId": "A String", # ID of the YouTube channel owned by the Actor.
            },
          },
          "verification": { # Verification status of actor.
            "adHocVerified": "A String", # Verification for one-time or manual processes.
          },
          "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.
        "statusForViewer": { # Status of the activity as seen by the viewer.
          "canPlusone": True or False, # Whether the viewer can +1 the activity.
          "canUpdate": True or False, # Whether the viewer can edit or delete the activity.
          "isPlusOned": True or False, # Whether the viewer has +1'd the activity.
          "resharingDisabled": True or False, # Whether reshares are disabled for the activity.
          "canComment": True or False, # Whether the viewer can comment on the activity.
        },
        "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.
        "displayName": "A String", # The name of the actor, suitable for display.
        "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.
        },
        "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
        },
        "clientSpecificActorInfo": { # Actor info specific to particular clients.
          "youtubeActorInfo": { # Actor info specific to YouTube clients.
            "channelId": "A String", # ID of the YouTube channel owned by the Actor.
          },
        },
        "verification": { # Verification status of actor.
          "adHocVerified": "A String", # Verification for one-time or manual processes.
        },
        "id": "A String", # The ID of the actor's Person resource.
      },
      "id": "A String", # The ID of this activity.
      "access": { # Identifies who has access to see this activity.
        "items": [ # The list of access entries.
          {
            "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
                # - "person" - Access to an individual.
                # - "circle" - Access to members of a circle.
                # - "myCircles" - Access to members of all the person's circles.
                # - "extendedCircles" - Access to members of all the 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.
        "domainRestricted": True or False, # Whether access is restricted to the domain.
      },
      "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.
        "id": "A String", # The id 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 crosspost 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.
    }
insert(userId, body, preview=None) 
Create a new activity for the authenticated user.

Args:
  userId: string, The ID of the user to create the activity on behalf of. Its value should be "me", to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "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.
        {
          "previewThumbnails": [ # When previewing, these are the optional thumbnails for the post. When posting an article, choose one by setting the attachment.image.url property. If you don't choose one, one will be chosen for you.
            {
              "url": "A String", # URL of the thumbnail image.
            },
          ],
          "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 of 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 of 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, which 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.
        "displayName": "A String", # The original actor's name, which is suitable for display.
        "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.
        },
        "clientSpecificActorInfo": { # Actor info specific to particular clients.
          "youtubeActorInfo": { # Actor info specific to YouTube clients.
            "channelId": "A String", # ID of the YouTube channel owned by the Actor.
          },
        },
        "verification": { # Verification status of actor.
          "adHocVerified": "A String", # Verification for one-time or manual processes.
        },
        "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.
      "statusForViewer": { # Status of the activity as seen by the viewer.
        "canPlusone": True or False, # Whether the viewer can +1 the activity.
        "canUpdate": True or False, # Whether the viewer can edit or delete the activity.
        "isPlusOned": True or False, # Whether the viewer has +1'd the activity.
        "resharingDisabled": True or False, # Whether reshares are disabled for the activity.
        "canComment": True or False, # Whether the viewer can comment on the activity.
      },
      "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.
      "displayName": "A String", # The name of the actor, suitable for display.
      "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.
      },
      "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
      },
      "clientSpecificActorInfo": { # Actor info specific to particular clients.
        "youtubeActorInfo": { # Actor info specific to YouTube clients.
          "channelId": "A String", # ID of the YouTube channel owned by the Actor.
        },
      },
      "verification": { # Verification status of actor.
        "adHocVerified": "A String", # Verification for one-time or manual processes.
      },
      "id": "A String", # The ID of the actor's Person resource.
    },
    "id": "A String", # The ID of this activity.
    "access": { # Identifies who has access to see this activity.
      "items": [ # The list of access entries.
        {
          "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
              # - "person" - Access to an individual.
              # - "circle" - Access to members of a circle.
              # - "myCircles" - Access to members of all the person's circles.
              # - "extendedCircles" - Access to members of all the 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.
      "domainRestricted": True or False, # Whether access is restricted to the domain.
    },
    "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.
      "id": "A String", # The id 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 crosspost 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.
  }

  preview: boolean, If "true", extract the potential media attachments for a URL. The response will include all possible attachments for a URL, including video, photos, and articles based on the content of the page.

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.
          {
            "previewThumbnails": [ # When previewing, these are the optional thumbnails for the post. When posting an article, choose one by setting the attachment.image.url property. If you don't choose one, one will be chosen for you.
              {
                "url": "A String", # URL of the thumbnail image.
              },
            ],
            "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 of 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 of 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, which 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.
          "displayName": "A String", # The original actor's name, which is suitable for display.
          "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.
          },
          "clientSpecificActorInfo": { # Actor info specific to particular clients.
            "youtubeActorInfo": { # Actor info specific to YouTube clients.
              "channelId": "A String", # ID of the YouTube channel owned by the Actor.
            },
          },
          "verification": { # Verification status of actor.
            "adHocVerified": "A String", # Verification for one-time or manual processes.
          },
          "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.
        "statusForViewer": { # Status of the activity as seen by the viewer.
          "canPlusone": True or False, # Whether the viewer can +1 the activity.
          "canUpdate": True or False, # Whether the viewer can edit or delete the activity.
          "isPlusOned": True or False, # Whether the viewer has +1'd the activity.
          "resharingDisabled": True or False, # Whether reshares are disabled for the activity.
          "canComment": True or False, # Whether the viewer can comment on the activity.
        },
        "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.
        "displayName": "A String", # The name of the actor, suitable for display.
        "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.
        },
        "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
        },
        "clientSpecificActorInfo": { # Actor info specific to particular clients.
          "youtubeActorInfo": { # Actor info specific to YouTube clients.
            "channelId": "A String", # ID of the YouTube channel owned by the Actor.
          },
        },
        "verification": { # Verification status of actor.
          "adHocVerified": "A String", # Verification for one-time or manual processes.
        },
        "id": "A String", # The ID of the actor's Person resource.
      },
      "id": "A String", # The ID of this activity.
      "access": { # Identifies who has access to see this activity.
        "items": [ # The list of access entries.
          {
            "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
                # - "person" - Access to an individual.
                # - "circle" - Access to members of a circle.
                # - "myCircles" - Access to members of all the person's circles.
                # - "extendedCircles" - Access to members of all the 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.
        "domainRestricted": True or False, # Whether access is restricted to the domain.
      },
      "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.
        "id": "A String", # The id 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 crosspost 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
      user - All activities created by the specified user that the authenticated user is authorized to view.
  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, which is a truncated portion of the content.
    "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.
              {
                "previewThumbnails": [ # When previewing, these are the optional thumbnails for the post. When posting an article, choose one by setting the attachment.image.url property. If you don't choose one, one will be chosen for you.
                  {
                    "url": "A String", # URL of the thumbnail image.
                  },
                ],
                "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 of 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 of 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, which 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.
              "displayName": "A String", # The original actor's name, which is suitable for display.
              "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.
              },
              "clientSpecificActorInfo": { # Actor info specific to particular clients.
                "youtubeActorInfo": { # Actor info specific to YouTube clients.
                  "channelId": "A String", # ID of the YouTube channel owned by the Actor.
                },
              },
              "verification": { # Verification status of actor.
                "adHocVerified": "A String", # Verification for one-time or manual processes.
              },
              "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.
            "statusForViewer": { # Status of the activity as seen by the viewer.
              "canPlusone": True or False, # Whether the viewer can +1 the activity.
              "canUpdate": True or False, # Whether the viewer can edit or delete the activity.
              "isPlusOned": True or False, # Whether the viewer has +1'd the activity.
              "resharingDisabled": True or False, # Whether reshares are disabled for the activity.
              "canComment": True or False, # Whether the viewer can comment on the activity.
            },
            "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.
            "displayName": "A String", # The name of the actor, suitable for display.
            "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.
            },
            "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
            },
            "clientSpecificActorInfo": { # Actor info specific to particular clients.
              "youtubeActorInfo": { # Actor info specific to YouTube clients.
                "channelId": "A String", # ID of the YouTube channel owned by the Actor.
              },
            },
            "verification": { # Verification status of actor.
              "adHocVerified": "A String", # Verification for one-time or manual processes.
            },
            "id": "A String", # The ID of the actor's Person resource.
          },
          "id": "A String", # The ID of this activity.
          "access": { # Identifies who has access to see this activity.
            "items": [ # The list of access entries.
              {
                "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
                    # - "person" - Access to an individual.
                    # - "circle" - Access to members of a circle.
                    # - "myCircles" - Access to members of all the person's circles.
                    # - "extendedCircles" - Access to members of all the 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.
            "domainRestricted": True or False, # Whether access is restricted to the domain.
          },
          "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.
            "id": "A String", # The id 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 crosspost 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.
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.audiences.html000066400000000000000000000114311300622755700256220ustar00rootroot00000000000000

Google+ Domains API . audiences

Instance Methods

list(userId, pageToken=None, maxResults=None)

List all of the audiences to which a user can share.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(userId, pageToken=None, maxResults=None) 
List all of the audiences to which a user can share.

Args:
  userId: string, The ID of the user to get audiences for. The special value "me" can be used to indicate the authenticated user. (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 circles 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.
    "items": [ # The audiences in this result.
      {
        "memberCount": 42, # The number of people in this circle. This only applies if entity_type is CIRCLE.
        "item": { # The access control list entry.
          "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 all the 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#audience", # Identifies this resource as an audience. Value: "plus#audience".
        "etag": "A String", # ETag of this response for caching purposes.
        "visibility": "A String", # The circle members' visibility as chosen by the owner of the circle. This only applies for items with "item.type" equals "circle". Possible values are:
            # - "public" - Members are visible to the public.
            # - "limited" - Members are visible to a limited audience.
            # - "private" - Members are visible to the owner only.
      },
    ],
    "kind": "plus#audiencesFeed", # Identifies this resource as a collection of audiences. Value: "plus#audienceFeed".
    "etag": "A String", # ETag of this response for caching purposes.
    "totalItems": 42, # The total number of ACL entries. The number of entries in this response may be smaller due to paging.
  }
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.
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.circles.html000066400000000000000000000271561300622755700253210ustar00rootroot00000000000000

Google+ Domains API . circles

Instance Methods

addPeople(circleId, userId=None, email=None)

Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More.

get(circleId)

Get a circle.

insert(userId, body)

Create a new circle for the authenticated user.

list(userId, pageToken=None, maxResults=None)

List all of the circles for a user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(circleId, body)

Update a circle's description. This method supports patch semantics.

remove(circleId)

Delete a circle.

removePeople(circleId, userId=None, email=None)

Remove a person from a circle.

update(circleId, body)

Update a circle's description.

Method Details

addPeople(circleId, userId=None, email=None) 
Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More.

Args:
  circleId: string, The ID of the circle to add the person to. (required)
  userId: string, IDs of the people to add to the circle. Optional, can be repeated. (repeated)
  email: string, Email of the people to add to the circle. Optional, can be repeated. (repeated)

Returns:
  An object of the form:

    {
      "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
      "displayName": "A String", # The circle name.
      "description": "A String", # The description of this circle.
      "people": { # The people in this circle.
        "totalItems": 42, # The total number of people in this circle.
      },
      "etag": "A String", # ETag of this response for caching purposes.
      "id": "A String", # The ID of the circle.
      "selfLink": "A String", # Link to this circle resource
    }
get(circleId) 
Get a circle.

Args:
  circleId: string, The ID of the circle to get. (required)

Returns:
  An object of the form:

    {
      "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
      "displayName": "A String", # The circle name.
      "description": "A String", # The description of this circle.
      "people": { # The people in this circle.
        "totalItems": 42, # The total number of people in this circle.
      },
      "etag": "A String", # ETag of this response for caching purposes.
      "id": "A String", # The ID of the circle.
      "selfLink": "A String", # Link to this circle resource
    }
insert(userId, body) 
Create a new circle for the authenticated user.

Args:
  userId: string, The ID of the user to create the circle on behalf of. The value "me" can be used to indicate the authenticated user. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
    "displayName": "A String", # The circle name.
    "description": "A String", # The description of this circle.
    "people": { # The people in this circle.
      "totalItems": 42, # The total number of people in this circle.
    },
    "etag": "A String", # ETag of this response for caching purposes.
    "id": "A String", # The ID of the circle.
    "selfLink": "A String", # Link to this circle resource
  }


Returns:
  An object of the form:

    {
      "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
      "displayName": "A String", # The circle name.
      "description": "A String", # The description of this circle.
      "people": { # The people in this circle.
        "totalItems": 42, # The total number of people in this circle.
      },
      "etag": "A String", # ETag of this response for caching purposes.
      "id": "A String", # The ID of the circle.
      "selfLink": "A String", # Link to this circle resource
    }
list(userId, pageToken=None, maxResults=None) 
List all of the circles for a user.

Args:
  userId: string, The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. (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 circles 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#circleFeed", # Identifies this resource as a collection of circles. Value: "plus#circleFeed".
    "title": "A String", # The title of this list of resources.
    "items": [ # The circles in this page of results.
      {
          "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
          "displayName": "A String", # The circle name.
          "description": "A String", # The description of this circle.
          "people": { # The people in this circle.
            "totalItems": 42, # The total number of people in this circle.
          },
          "etag": "A String", # ETag of this response for caching purposes.
          "id": "A String", # The ID of the circle.
          "selfLink": "A String", # Link to this circle resource
        },
    ],
    "nextLink": "A String", # Link to the next page of circles.
    "etag": "A String", # ETag of this response for caching purposes.
    "totalItems": 42, # The total number of circles. The number of circles in this response may be smaller due to paging.
    "selfLink": "A String", # Link to this page of circles.
  }
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(circleId, body) 
Update a circle's description. This method supports patch semantics.

Args:
  circleId: string, The ID of the circle to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
    "displayName": "A String", # The circle name.
    "description": "A String", # The description of this circle.
    "people": { # The people in this circle.
      "totalItems": 42, # The total number of people in this circle.
    },
    "etag": "A String", # ETag of this response for caching purposes.
    "id": "A String", # The ID of the circle.
    "selfLink": "A String", # Link to this circle resource
  }


Returns:
  An object of the form:

    {
      "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
      "displayName": "A String", # The circle name.
      "description": "A String", # The description of this circle.
      "people": { # The people in this circle.
        "totalItems": 42, # The total number of people in this circle.
      },
      "etag": "A String", # ETag of this response for caching purposes.
      "id": "A String", # The ID of the circle.
      "selfLink": "A String", # Link to this circle resource
    }
remove(circleId) 
Delete a circle.

Args:
  circleId: string, The ID of the circle to delete. (required)
removePeople(circleId, userId=None, email=None) 
Remove a person from a circle.

Args:
  circleId: string, The ID of the circle to remove the person from. (required)
  userId: string, IDs of the people to remove from the circle. Optional, can be repeated. (repeated)
  email: string, Email of the people to add to the circle. Optional, can be repeated. (repeated)
update(circleId, body) 
Update a circle's description.

Args:
  circleId: string, The ID of the circle to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
    "displayName": "A String", # The circle name.
    "description": "A String", # The description of this circle.
    "people": { # The people in this circle.
      "totalItems": 42, # The total number of people in this circle.
    },
    "etag": "A String", # ETag of this response for caching purposes.
    "id": "A String", # The ID of the circle.
    "selfLink": "A String", # Link to this circle resource
  }


Returns:
  An object of the form:

    {
      "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
      "displayName": "A String", # The circle name.
      "description": "A String", # The description of this circle.
      "people": { # The people in this circle.
        "totalItems": 42, # The total number of people in this circle.
      },
      "etag": "A String", # ETag of this response for caching purposes.
      "id": "A String", # The ID of the circle.
      "selfLink": "A String", # Link to this circle resource
    }
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.comments.html000066400000000000000000000343351300622755700255170ustar00rootroot00000000000000

Google+ Domains API . comments

Instance Methods

get(commentId)

Get a comment.

insert(activityId, body)

Create a new comment in reply to an activity.

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.
        "displayName": "A String", # The name of this actor, suitable for display.
        "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
        },
        "clientSpecificActorInfo": { # Actor info specific to particular clients.
          "youtubeActorInfo": { # Actor info specific to YouTube clients.
            "channelId": "A String", # ID of the YouTube channel owned by the Actor.
          },
        },
        "verification": { # Verification status of actor.
          "adHocVerified": "A String", # Verification for one-time or manual processes.
        },
        "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.
    }
insert(activityId, body) 
Create a new comment in reply to an activity.

Args:
  activityId: string, The ID of the activity to reply to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "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.
      "displayName": "A String", # The name of this actor, suitable for display.
      "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
      },
      "clientSpecificActorInfo": { # Actor info specific to particular clients.
        "youtubeActorInfo": { # Actor info specific to YouTube clients.
          "channelId": "A String", # ID of the YouTube channel owned by the Actor.
        },
      },
      "verification": { # Verification status of actor.
        "adHocVerified": "A String", # Verification for one-time or manual processes.
      },
      "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.
  }


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.
        "displayName": "A String", # The name of this actor, suitable for display.
        "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
        },
        "clientSpecificActorInfo": { # Actor info specific to particular clients.
          "youtubeActorInfo": { # Actor info specific to YouTube clients.
            "channelId": "A String", # ID of the YouTube channel owned by the Actor.
          },
        },
        "verification": { # Verification status of actor.
          "adHocVerified": "A String", # Verification for one-time or manual processes.
        },
        "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.
            "displayName": "A String", # The name of this actor, suitable for display.
            "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
            },
            "clientSpecificActorInfo": { # Actor info specific to particular clients.
              "youtubeActorInfo": { # Actor info specific to YouTube clients.
                "channelId": "A String", # ID of the YouTube channel owned by the Actor.
              },
            },
            "verification": { # Verification status of actor.
              "adHocVerified": "A String", # Verification for one-time or manual processes.
            },
            "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.
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.html000066400000000000000000000055301300622755700236660ustar00rootroot00000000000000

Google+ Domains API

Instance Methods

activities()

Returns the activities Resource.

audiences()

Returns the audiences Resource.

circles()

Returns the circles Resource.

comments()

Returns the comments Resource.

media()

Returns the media Resource.

people()

Returns the people Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.media.html000066400000000000000000000170271300622755700247500ustar00rootroot00000000000000

Google+ Domains API . media

Instance Methods

insert(userId, collection, body=None, media_body=None)

Add a new media item to an album. The current upload size limitations are 36MB for a photo and 1GB for a video. Uploads do not count against quota if photos are less than 2048 pixels on their longest side or videos are less than 15 minutes in length.

Method Details

insert(userId, collection, body=None, media_body=None) 
Add a new media item to an album. The current upload size limitations are 36MB for a photo and 1GB for a video. Uploads do not count against quota if photos are less than 2048 pixels on their longest side or videos are less than 15 minutes in length.

Args:
  userId: string, The ID of the user to create the activity on behalf of. (required)
  collection: string, A parameter (required)
    Allowed values
      cloud - Upload the media to share on Google+.
  body: object, The request body.
    The object takes the form of:

{
    "kind": "plus#media", # The type of resource.
    "displayName": "A String", # The display name for this media.
    "exif": { # Exif information of the media item.
      "time": "A String", # The time the media was captured. Formatted as an RFC 3339 timestamp.
    },
    "author": { # The person who uploaded this media.
      "url": "A String", # A link to the author's Google profile.
      "image": { # The author's Google profile image.
        "url": "A String", # The URL of the author's profile photo. To resize 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 author's name.
      "id": "A String", # ID of the author.
    },
    "url": "A String", # The URL for the page that hosts this media.
    "mediaUrl": "A String", # The URL of this photo or video's still image.
    "videoStatus": "A String", # The encoding status of this video. Possible values are:
        # - "UPLOADING" - Not all the video bytes have been received.
        # - "PENDING" - Video not yet processed.
        # - "FAILED" - Video processing failed.
        # - "READY" - A single video stream is playable.
        # - "FINAL" - All video streams are playable.
    "updated": "A String", # The time at which this media was last updated. This includes changes to media metadata. Formatted as an RFC 3339 timestamp.
    "summary": "A String", # A description, or caption, for this media.
    "height": 42, # The height in pixels of the original image.
    "videoDuration": "A String", # The duration in milliseconds of this video.
    "sizeBytes": "A String", # The size in bytes of this video.
    "etag": "A String", # ETag of this response for caching purposes.
    "streams": [ # The list of video streams for this video. There might be several different streams available for a single video, either Flash or MPEG, of various sizes
      {
        "url": "A String", # URL of the video stream.
        "width": 42, # The width, in pixels, of the video resource.
        "type": "A String", # MIME type of the video stream.
        "height": 42, # The height, in pixels, of the video resource.
      },
    ],
    "width": 42, # The width in pixels of the original image.
    "published": "A String", # The time at which this media was uploaded. Formatted as an RFC 3339 timestamp.
    "mediaCreatedTime": "A String", # The time at which this media was originally created in UTC. Formatted as an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z
    "id": "A String", # ID of this media, which is generated by the API.
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Returns:
  An object of the form:

    {
      "kind": "plus#media", # The type of resource.
      "displayName": "A String", # The display name for this media.
      "exif": { # Exif information of the media item.
        "time": "A String", # The time the media was captured. Formatted as an RFC 3339 timestamp.
      },
      "author": { # The person who uploaded this media.
        "url": "A String", # A link to the author's Google profile.
        "image": { # The author's Google profile image.
          "url": "A String", # The URL of the author's profile photo. To resize 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 author's name.
        "id": "A String", # ID of the author.
      },
      "url": "A String", # The URL for the page that hosts this media.
      "mediaUrl": "A String", # The URL of this photo or video's still image.
      "videoStatus": "A String", # The encoding status of this video. Possible values are:
          # - "UPLOADING" - Not all the video bytes have been received.
          # - "PENDING" - Video not yet processed.
          # - "FAILED" - Video processing failed.
          # - "READY" - A single video stream is playable.
          # - "FINAL" - All video streams are playable.
      "updated": "A String", # The time at which this media was last updated. This includes changes to media metadata. Formatted as an RFC 3339 timestamp.
      "summary": "A String", # A description, or caption, for this media.
      "height": 42, # The height in pixels of the original image.
      "videoDuration": "A String", # The duration in milliseconds of this video.
      "sizeBytes": "A String", # The size in bytes of this video.
      "etag": "A String", # ETag of this response for caching purposes.
      "streams": [ # The list of video streams for this video. There might be several different streams available for a single video, either Flash or MPEG, of various sizes
        {
          "url": "A String", # URL of the video stream.
          "width": 42, # The width, in pixels, of the video resource.
          "type": "A String", # MIME type of the video stream.
          "height": 42, # The height, in pixels, of the video resource.
        },
      ],
      "width": 42, # The width in pixels of the original image.
      "published": "A String", # The time at which this media was uploaded. Formatted as an RFC 3339 timestamp.
      "mediaCreatedTime": "A String", # The time at which this media was originally created in UTC. Formatted as an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z
      "id": "A String", # ID of this media, which is generated by the API.
    }
google-api-python-client-1.5.5/docs/dyn/plusDomains_v1.people.html000066400000000000000000001144721300622755700251570ustar00rootroot00000000000000

Google+ Domains API . people

Instance Methods

get(userId)

Get a person's profile.

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.

listByCircle(circleId, pageToken=None, maxResults=None)

List all of the people who are members of a circle.

listByCircle_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(userId) 
Get a person's profile.

Args:
  userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)

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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
      "isDefault": True or False, # Whether the person's profile photo is the default one
    },
    "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
    "id": "A String", # The ID of this person.
    "occupation": "A String", # The occupation of this person.
    "verified": True or False, # Whether the person or Google+ Page has been verified.
    "tagline": "A String", # The brief description (tagline) of this person.
    "currentLocation": "A String", # (this field is not currently used)
    "etag": "A String", # ETag of this response for caching purposes.
    "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
    "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.
    "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.
    "aboutMe": "A String", # A short biography for this person.
    "placesLived": [ # A list of places where this person has lived.
      {
        "primary": True or False, # If "true", this place of residence is this person's primary residence.
        "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
      },
    ],
    "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
    "nickname": "A String", # The nickname of this person.
    "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
      {
        "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
            # - "account" - Google account email address.
            # - "home" - Home email address.
            # - "work" - Work email address.
            # - "other" - Other.
        "value": "A String", # The email address.
      },
    ],
    "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.
      },
    ],
    "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
    "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.
    },
    "skills": "A String", # The person's skills.
    "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 cover image and the actual displayed cover image. Only valid for banner layout.
        "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
      },
      "coverPhoto": { # The person's primary cover image.
        "url": "A String", # The URL of the image.
        "width": 42, # The width of the image.
        "height": 42, # The height of the image.
      },
    },
    "url": "A String", # The URL of this person's profile.
    "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'd 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.
      },
    ],
  }
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
      circled - The list of people who this user has added to one or more circles.
  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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          "isDefault": True or False, # Whether the person's profile photo is the default one
        },
        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
        "id": "A String", # The ID of this person.
        "occupation": "A String", # The occupation of this person.
        "verified": True or False, # Whether the person or Google+ Page has been verified.
        "tagline": "A String", # The brief description (tagline) of this person.
        "currentLocation": "A String", # (this field is not currently used)
        "etag": "A String", # ETag of this response for caching purposes.
        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
        "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.
        "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.
        "aboutMe": "A String", # A short biography for this person.
        "placesLived": [ # A list of places where this person has lived.
          {
            "primary": True or False, # If "true", this place of residence is this person's primary residence.
            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
          },
        ],
        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
        "nickname": "A String", # The nickname of this person.
        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
          {
            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
                # - "account" - Google account email address.
                # - "home" - Home email address.
                # - "work" - Work email address.
                # - "other" - Other.
            "value": "A String", # The email address.
          },
        ],
        "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.
          },
        ],
        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
        "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.
        },
        "skills": "A String", # The person's skills.
        "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 cover image and the actual displayed cover image. Only valid for banner layout.
            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
          },
          "coverPhoto": { # The person's primary cover image.
            "url": "A String", # The URL of the image.
            "width": 42, # The width of the image.
            "height": 42, # The height of the image.
          },
        },
        "url": "A String", # The URL of this person's profile.
        "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'd 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.
          },
        ],
      },
    ],
    "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.
      sharedto - List all people who this activity was shared to.
  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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          "isDefault": True or False, # Whether the person's profile photo is the default one
        },
        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
        "id": "A String", # The ID of this person.
        "occupation": "A String", # The occupation of this person.
        "verified": True or False, # Whether the person or Google+ Page has been verified.
        "tagline": "A String", # The brief description (tagline) of this person.
        "currentLocation": "A String", # (this field is not currently used)
        "etag": "A String", # ETag of this response for caching purposes.
        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
        "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.
        "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.
        "aboutMe": "A String", # A short biography for this person.
        "placesLived": [ # A list of places where this person has lived.
          {
            "primary": True or False, # If "true", this place of residence is this person's primary residence.
            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
          },
        ],
        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
        "nickname": "A String", # The nickname of this person.
        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
          {
            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
                # - "account" - Google account email address.
                # - "home" - Home email address.
                # - "work" - Work email address.
                # - "other" - Other.
            "value": "A String", # The email address.
          },
        ],
        "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.
          },
        ],
        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
        "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.
        },
        "skills": "A String", # The person's skills.
        "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 cover image and the actual displayed cover image. Only valid for banner layout.
            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
          },
          "coverPhoto": { # The person's primary cover image.
            "url": "A String", # The URL of the image.
            "width": 42, # The width of the image.
            "height": 42, # The height of the image.
          },
        },
        "url": "A String", # The URL of this person's profile.
        "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'd 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.
          },
        ],
      },
    ],
    "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.
listByCircle(circleId, pageToken=None, maxResults=None) 
List all of the people who are members of a circle.

Args:
  circleId: string, The ID of the circle to get the members of. (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 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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          "isDefault": True or False, # Whether the person's profile photo is the default one
        },
        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
        "id": "A String", # The ID of this person.
        "occupation": "A String", # The occupation of this person.
        "verified": True or False, # Whether the person or Google+ Page has been verified.
        "tagline": "A String", # The brief description (tagline) of this person.
        "currentLocation": "A String", # (this field is not currently used)
        "etag": "A String", # ETag of this response for caching purposes.
        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
        "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.
        "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.
        "aboutMe": "A String", # A short biography for this person.
        "placesLived": [ # A list of places where this person has lived.
          {
            "primary": True or False, # If "true", this place of residence is this person's primary residence.
            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
          },
        ],
        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
        "nickname": "A String", # The nickname of this person.
        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
          {
            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
                # - "account" - Google account email address.
                # - "home" - Home email address.
                # - "work" - Work email address.
                # - "other" - Other.
            "value": "A String", # The email address.
          },
        ],
        "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.
          },
        ],
        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
        "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.
        },
        "skills": "A String", # The person's skills.
        "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 cover image and the actual displayed cover image. Only valid for banner layout.
            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
          },
          "coverPhoto": { # The person's primary cover image.
            "url": "A String", # The URL of the image.
            "width": 42, # The width of the image.
            "height": 42, # The height of the image.
          },
        },
        "url": "A String", # The URL of this person's profile.
        "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'd 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.
          },
        ],
      },
    ],
    "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.
  }
listByCircle_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.
google-api-python-client-1.5.5/docs/dyn/plus_v1.activities.html000066400000000000000000001102071300622755700245140ustar00rootroot00000000000000

Google+ API . activities

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 of 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 of 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, which 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.
        "displayName": "A String", # The original actor's name, which is suitable for display.
        "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.
        },
        "clientSpecificActorInfo": { # Actor info specific to particular clients.
          "youtubeActorInfo": { # Actor info specific to YouTube clients.
            "channelId": "A String", # ID of the YouTube channel owned by the Actor.
          },
        },
        "verification": { # Verification status of actor.
          "adHocVerified": "A String", # Verification for one-time or manual processes.
        },
        "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.
      "displayName": "A String", # The name of the actor, suitable for display.
      "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.
      },
      "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
      },
      "clientSpecificActorInfo": { # Actor info specific to particular clients.
        "youtubeActorInfo": { # Actor info specific to YouTube clients.
          "channelId": "A String", # ID of the YouTube channel owned by the Actor.
        },
      },
      "verification": { # Verification status of actor.
        "adHocVerified": "A String", # Verification for one-time or manual processes.
      },
      "id": "A String", # The ID of the actor's Person resource.
    },
    "id": "A String", # The ID of this activity.
    "access": { # Identifies who has access to see this activity.
      "items": [ # The list of access entries.
        {
          "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
              # - "person" - Access to an individual.
              # - "circle" - Access to members of a circle.
              # - "myCircles" - Access to members of all the person's circles.
              # - "extendedCircles" - Access to members of all the 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.
      "id": "A String", # The id 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 crosspost 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, which is a truncated portion of the content.
    "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 of 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 of 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, which 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.
            "displayName": "A String", # The original actor's name, which is suitable for display.
            "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.
            },
            "clientSpecificActorInfo": { # Actor info specific to particular clients.
              "youtubeActorInfo": { # Actor info specific to YouTube clients.
                "channelId": "A String", # ID of the YouTube channel owned by the Actor.
              },
            },
            "verification": { # Verification status of actor.
              "adHocVerified": "A String", # Verification for one-time or manual processes.
            },
            "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.
          "displayName": "A String", # The name of the actor, suitable for display.
          "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.
          },
          "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          },
          "clientSpecificActorInfo": { # Actor info specific to particular clients.
            "youtubeActorInfo": { # Actor info specific to YouTube clients.
              "channelId": "A String", # ID of the YouTube channel owned by the Actor.
            },
          },
          "verification": { # Verification status of actor.
            "adHocVerified": "A String", # Verification for one-time or manual processes.
          },
          "id": "A String", # The ID of the actor's Person resource.
        },
        "id": "A String", # The ID of this activity.
        "access": { # Identifies who has access to see this activity.
          "items": [ # The list of access entries.
            {
              "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
                  # - "person" - Access to an individual.
                  # - "circle" - Access to members of a circle.
                  # - "myCircles" - Access to members of all the person's circles.
                  # - "extendedCircles" - Access to members of all the 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.
          "id": "A String", # The id 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 crosspost 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, which is a truncated portion of the content.
    "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 of 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 of 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, which 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.
            "displayName": "A String", # The original actor's name, which is suitable for display.
            "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.
            },
            "clientSpecificActorInfo": { # Actor info specific to particular clients.
              "youtubeActorInfo": { # Actor info specific to YouTube clients.
                "channelId": "A String", # ID of the YouTube channel owned by the Actor.
              },
            },
            "verification": { # Verification status of actor.
              "adHocVerified": "A String", # Verification for one-time or manual processes.
            },
            "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.
          "displayName": "A String", # The name of the actor, suitable for display.
          "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.
          },
          "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          },
          "clientSpecificActorInfo": { # Actor info specific to particular clients.
            "youtubeActorInfo": { # Actor info specific to YouTube clients.
              "channelId": "A String", # ID of the YouTube channel owned by the Actor.
            },
          },
          "verification": { # Verification status of actor.
            "adHocVerified": "A String", # Verification for one-time or manual processes.
          },
          "id": "A String", # The ID of the actor's Person resource.
        },
        "id": "A String", # The ID of this activity.
        "access": { # Identifies who has access to see this activity.
          "items": [ # The list of access entries.
            {
              "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
                  # - "person" - Access to an individual.
                  # - "circle" - Access to members of a circle.
                  # - "myCircles" - Access to members of all the person's circles.
                  # - "extendedCircles" - Access to members of all the 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.
          "id": "A String", # The id 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 crosspost 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.
google-api-python-client-1.5.5/docs/dyn/plus_v1.comments.html000066400000000000000000000213731300622755700242020ustar00rootroot00000000000000

Google+ API . comments

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.
      "displayName": "A String", # The name of this actor, suitable for display.
      "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
      },
      "clientSpecificActorInfo": { # Actor info specific to particular clients.
        "youtubeActorInfo": { # Actor info specific to YouTube clients.
          "channelId": "A String", # ID of the YouTube channel owned by the Actor.
        },
      },
      "verification": { # Verification status of actor.
        "adHocVerified": "A String", # Verification for one-time or manual processes.
      },
      "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.
          "displayName": "A String", # The name of this actor, suitable for display.
          "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          },
          "clientSpecificActorInfo": { # Actor info specific to particular clients.
            "youtubeActorInfo": { # Actor info specific to YouTube clients.
              "channelId": "A String", # ID of the YouTube channel owned by the Actor.
            },
          },
          "verification": { # Verification status of actor.
            "adHocVerified": "A String", # Verification for one-time or manual processes.
          },
          "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.
google-api-python-client-1.5.5/docs/dyn/plus_v1.html000066400000000000000000000045541300622755700223600ustar00rootroot00000000000000

Google+ API

Instance Methods

activities()

Returns the activities Resource.

comments()

Returns the comments Resource.

people()

Returns the people Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/plus_v1.people.html000066400000000000000000001226321300622755700236410ustar00rootroot00000000000000

Google+ API . people

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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
      "isDefault": True or False, # Whether the person's profile photo is the default one
    },
    "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
    "id": "A String", # The ID of this person.
    "occupation": "A String", # The occupation of this person.
    "verified": True or False, # Whether the person or Google+ Page has been verified.
    "tagline": "A String", # The brief description (tagline) of this person.
    "currentLocation": "A String", # (this field is not currently used)
    "etag": "A String", # ETag of this response for caching purposes.
    "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
    "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.
    "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.
    "aboutMe": "A String", # A short biography for this person.
    "placesLived": [ # A list of places where this person has lived.
      {
        "primary": True or False, # If "true", this place of residence is this person's primary residence.
        "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
      },
    ],
    "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
    "nickname": "A String", # The nickname of this person.
    "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
      {
        "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
            # - "account" - Google account email address.
            # - "home" - Home email address.
            # - "work" - Work email address.
            # - "other" - Other.
        "value": "A String", # The email address.
      },
    ],
    "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.
      },
    ],
    "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
    "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.
    "skills": "A String", # The person's skills.
    "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 cover image and the actual displayed cover image. Only valid for banner layout.
        "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
      },
      "coverPhoto": { # The person's primary cover image.
        "url": "A String", # The URL of the image.
        "width": 42, # The width of the image.
        "height": 42, # The height of the image.
      },
    },
    "url": "A String", # The URL of this person's profile.
    "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'd 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. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
      "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
          # - "17" - for age 17
          # - "20" - for age 20
      "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
          # - "21" - for age 21
          # - "18" - for age 18
    },
  }
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
      connected - The list of visible people in the authenticated user's circles who also use the requesting app. This list is limited to users who made their app activities visible to the authenticated user.
      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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          "isDefault": True or False, # Whether the person's profile photo is the default one
        },
        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
        "id": "A String", # The ID of this person.
        "occupation": "A String", # The occupation of this person.
        "verified": True or False, # Whether the person or Google+ Page has been verified.
        "tagline": "A String", # The brief description (tagline) of this person.
        "currentLocation": "A String", # (this field is not currently used)
        "etag": "A String", # ETag of this response for caching purposes.
        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
        "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.
        "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.
        "aboutMe": "A String", # A short biography for this person.
        "placesLived": [ # A list of places where this person has lived.
          {
            "primary": True or False, # If "true", this place of residence is this person's primary residence.
            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
          },
        ],
        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
        "nickname": "A String", # The nickname of this person.
        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
          {
            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
                # - "account" - Google account email address.
                # - "home" - Home email address.
                # - "work" - Work email address.
                # - "other" - Other.
            "value": "A String", # The email address.
          },
        ],
        "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.
          },
        ],
        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
        "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.
        "skills": "A String", # The person's skills.
        "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 cover image and the actual displayed cover image. Only valid for banner layout.
            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
          },
          "coverPhoto": { # The person's primary cover image.
            "url": "A String", # The URL of the image.
            "width": 42, # The width of the image.
            "height": 42, # The height of the image.
          },
        },
        "url": "A String", # The URL of this person's profile.
        "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'd 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. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
          "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
              # - "17" - for age 17
              # - "20" - for age 20
          "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
              # - "21" - for age 21
              # - "18" - for age 18
        },
      },
    ],
    "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          "isDefault": True or False, # Whether the person's profile photo is the default one
        },
        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
        "id": "A String", # The ID of this person.
        "occupation": "A String", # The occupation of this person.
        "verified": True or False, # Whether the person or Google+ Page has been verified.
        "tagline": "A String", # The brief description (tagline) of this person.
        "currentLocation": "A String", # (this field is not currently used)
        "etag": "A String", # ETag of this response for caching purposes.
        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
        "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.
        "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.
        "aboutMe": "A String", # A short biography for this person.
        "placesLived": [ # A list of places where this person has lived.
          {
            "primary": True or False, # If "true", this place of residence is this person's primary residence.
            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
          },
        ],
        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
        "nickname": "A String", # The nickname of this person.
        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
          {
            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
                # - "account" - Google account email address.
                # - "home" - Home email address.
                # - "work" - Work email address.
                # - "other" - Other.
            "value": "A String", # The email address.
          },
        ],
        "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.
          },
        ],
        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
        "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.
        "skills": "A String", # The person's skills.
        "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 cover image and the actual displayed cover image. Only valid for banner layout.
            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
          },
          "coverPhoto": { # The person's primary cover image.
            "url": "A String", # The URL of the image.
            "width": 42, # The width of the image.
            "height": 42, # The height of the image.
          },
        },
        "url": "A String", # The URL of this person's profile.
        "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'd 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. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
          "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
              # - "17" - for age 17
              # - "20" - for age 20
          "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
              # - "21" - for age 21
              # - "18" - for age 18
        },
      },
    ],
    "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 resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
          "isDefault": True or False, # Whether the person's profile photo is the default one
        },
        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
        "id": "A String", # The ID of this person.
        "occupation": "A String", # The occupation of this person.
        "verified": True or False, # Whether the person or Google+ Page has been verified.
        "tagline": "A String", # The brief description (tagline) of this person.
        "currentLocation": "A String", # (this field is not currently used)
        "etag": "A String", # ETag of this response for caching purposes.
        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
        "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.
        "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.
        "aboutMe": "A String", # A short biography for this person.
        "placesLived": [ # A list of places where this person has lived.
          {
            "primary": True or False, # If "true", this place of residence is this person's primary residence.
            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
          },
        ],
        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
        "nickname": "A String", # The nickname of this person.
        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
          {
            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
                # - "account" - Google account email address.
                # - "home" - Home email address.
                # - "work" - Work email address.
                # - "other" - Other.
            "value": "A String", # The email address.
          },
        ],
        "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.
          },
        ],
        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
        "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.
        "skills": "A String", # The person's skills.
        "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 cover image and the actual displayed cover image. Only valid for banner layout.
            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
          },
          "coverPhoto": { # The person's primary cover image.
            "url": "A String", # The URL of the image.
            "width": 42, # The width of the image.
            "height": 42, # The height of the image.
          },
        },
        "url": "A String", # The URL of this person's profile.
        "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'd 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. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
          "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
              # - "17" - for age 17
              # - "20" - for age 20
          "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
              # - "21" - for age 21
              # - "18" - for age 18
        },
      },
    ],
    "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.
google-api-python-client-1.5.5/docs/dyn/prediction_v1_2.hostedmodels.html000066400000000000000000000037031300622755700264420ustar00rootroot00000000000000

Prediction API . hostedmodels

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": {
      "csvInstance": [
        "",
      ],
    },
  }


Returns:
  An object of the form:

    {
    "kind": "prediction#output",
    "outputLabel": "A String",
    "id": "A String",
    "outputMulti": [
      {
        "score": 3.14,
        "label": "A String",
      },
    ],
    "outputValue": 3.14,
    "selfLink": "A String",
  }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_2.html000066400000000000000000000060461300622755700237540ustar00rootroot00000000000000

Prediction API

Instance Methods

hostedmodels()

Returns the hostedmodels Resource.

training()

Returns the training Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

predict(data, body)

Submit data and request a prediction

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
predict(data, body) 
Submit data and request a prediction

Args:
  data: string, mybucket%2Fmydata resource in Google Storage (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "input": {
      "csvInstance": [
        "",
      ],
    },
  }


Returns:
  An object of the form:

    {
    "kind": "prediction#output",
    "outputLabel": "A String",
    "id": "A String",
    "outputMulti": [
      {
        "score": 3.14,
        "label": "A String",
      },
    ],
    "outputValue": 3.14,
    "selfLink": "A String",
  }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_2.training.html000066400000000000000000000076201300622755700255650ustar00rootroot00000000000000

Prediction API . training

Instance Methods

delete(data)

Delete a trained model

get(data)

Check training status of your model

insert(body, data=None)

Begin training your model

update(data, body)

Add new data to a trained model

Method Details

delete(data) 
Delete a trained model

Args:
  data: string, mybucket/mydata resource in Google Storage (required)
get(data) 
Check training status of your model

Args:
  data: string, mybucket/mydata resource in Google Storage (required)

Returns:
  An object of the form:

    {
      "selfLink": "A String",
      "kind": "prediction#training",
      "trainingStatus": "A String",
      "id": "A String",
      "modelInfo": {
        "classificationAccuracy": 3.14,
        "meanSquaredError": 3.14,
        "modelType": "A String",
      },
    }
insert(body, data=None) 
Begin training your model

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "selfLink": "A String",
    "kind": "prediction#training",
    "trainingStatus": "A String",
    "id": "A String",
    "modelInfo": {
      "classificationAccuracy": 3.14,
      "meanSquaredError": 3.14,
      "modelType": "A String",
    },
  }

  data: string, mybucket/mydata resource in Google Storage

Returns:
  An object of the form:

    {
      "selfLink": "A String",
      "kind": "prediction#training",
      "trainingStatus": "A String",
      "id": "A String",
      "modelInfo": {
        "classificationAccuracy": 3.14,
        "meanSquaredError": 3.14,
        "modelType": "A String",
      },
    }
update(data, body) 
Add new data to a trained model

Args:
  data: string, mybucket/mydata resource in Google Storage (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "classLabel": "A String", # The true class label of this instance
    "csvInstance": [ # The input features for this instance
      "",
    ],
  }


Returns:
  An object of the form:

    {
      "selfLink": "A String",
      "kind": "prediction#training",
      "trainingStatus": "A String",
      "id": "A String",
      "modelInfo": {
        "classificationAccuracy": 3.14,
        "meanSquaredError": 3.14,
        "modelType": "A String",
      },
    }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_3.hostedmodels.html000066400000000000000000000046131300622755700264440ustar00rootroot00000000000000

Prediction API . hostedmodels

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 [Categorical models only].
    "id": "A String", # The unique name for the predictive model.
    "outputMulti": [ # A list of classes with their estimated probabilities [Categorical models only].
      {
        "score": 3.14, # The probability of the class.
        "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.
  }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_3.html000066400000000000000000000043771300622755700237620ustar00rootroot00000000000000

Prediction API

Instance Methods

hostedmodels()

Returns the hostedmodels Resource.

training()

Returns the training Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/prediction_v1_3.training.html000066400000000000000000000324201300622755700255620ustar00rootroot00000000000000

Prediction API . training

Instance Methods

delete(data)

Delete a trained model

get(data)

Check training status of your model

insert(body)

Begin training your model

predict(data, body)

Submit data and request a prediction

update(data, body)

Add new data to a trained model

Method Details

delete(data) 
Delete a trained model

Args:
  data: string, mybucket/mydata resource in Google Storage (required)
get(data) 
Check training status of your model

Args:
  data: string, mybucket/mydata resource in Google Storage (required)

Returns:
  An object of the form:

    {
      "kind": "prediction#training", # What kind of resource this is.
      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
      "modelInfo": { # Model metadata.
        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
          "a_key": 3.14, # The true class associated with how many instances it had
        },
        "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": { # The true class label.
            "a_key": 3.14, # The pair {predicted_label, count}.
          },
        },
        "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.
        "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
        "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].
      },
      "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 classes 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.
    "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
    "modelInfo": { # Model metadata.
      "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
        "a_key": 3.14, # The true class associated with how many instances it had
      },
      "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": { # The true class label.
          "a_key": 3.14, # The pair {predicted_label, count}.
        },
      },
      "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.
      "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
      "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].
    },
    "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 classes 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.
      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
      "modelInfo": { # Model metadata.
        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
          "a_key": 3.14, # The true class associated with how many instances it had
        },
        "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": { # The true class label.
            "a_key": 3.14, # The pair {predicted_label, count}.
          },
        },
        "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.
        "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
        "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].
      },
      "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 classes to be specified [Categorical models only].
        { # Class label (string).
          "a_key": 3.14,
        },
      ],
    }
predict(data, body) 
Submit data and request a prediction

Args:
  data: string, mybucket/mydata resource in Google Storage (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 [Categorical models only].
    "id": "A String", # The unique name for the predictive model.
    "outputMulti": [ # A list of classes with their estimated probabilities [Categorical models only].
      {
        "score": 3.14, # The probability of the class.
        "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(data, body) 
Add new data to a trained model

Args:
  data: string, mybucket/mydata resource in Google Storage (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "classLabel": "A String", # The true class label of this instance
    "csvInstance": [ # The input features for this instance
      "",
    ],
  }


Returns:
  An object of the form:

    {
      "kind": "prediction#training", # What kind of resource this is.
      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
      "modelInfo": { # Model metadata.
        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
          "a_key": 3.14, # The true class associated with how many instances it had
        },
        "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": { # The true class label.
            "a_key": 3.14, # The pair {predicted_label, count}.
          },
        },
        "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.
        "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
        "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].
      },
      "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 classes to be specified [Categorical models only].
        { # Class label (string).
          "a_key": 3.14,
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_4.hostedmodels.html000066400000000000000000000046371300622755700264530ustar00rootroot00000000000000

Prediction API . hostedmodels

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.
  }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_4.html000066400000000000000000000044161300622755700237550ustar00rootroot00000000000000

Prediction API

Instance Methods

hostedmodels()

Returns the hostedmodels Resource.

trainedmodels()

Returns the trainedmodels Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/prediction_v1_4.trainedmodels.html000066400000000000000000000347211300622755700266100ustar00rootroot00000000000000

Prediction API . trainedmodels

Instance Methods

delete(id)

Delete a trained model.

get(id)

Check training status of your model.

insert(body)

Begin training your model.

predict(id, body)

Submit model id and request a prediction

update(id, body)

Add new data to a trained model.

Method Details

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.
      "storageDataLocation": "A String", # Google storage location of the training data file.
      "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
      "dataAnalysis": { # Data Analysis.
        "warnings": [
          "A String",
        ],
      },
      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
      "modelInfo": { # Model metadata.
        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
          "a_key": 3.14,
        },
        "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
        "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
          "a_key": {
            "a_key": 3.14,
          },
        },
        "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.
      "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.
    "storageDataLocation": "A String", # Google storage location of the training data file.
    "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
    "dataAnalysis": { # Data Analysis.
      "warnings": [
        "A String",
      ],
    },
    "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
    "modelInfo": { # Model metadata.
      "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
        "a_key": 3.14,
      },
      "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
      "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
        "a_key": {
          "a_key": 3.14,
        },
      },
      "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.
    "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.
      "storageDataLocation": "A String", # Google storage location of the training data file.
      "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
      "dataAnalysis": { # Data Analysis.
        "warnings": [
          "A String",
        ],
      },
      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
      "modelInfo": { # Model metadata.
        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
          "a_key": 3.14,
        },
        "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
        "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
          "a_key": {
            "a_key": 3.14,
          },
        },
        "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.
      "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,
        },
      ],
    }
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.
      "storageDataLocation": "A String", # Google storage location of the training data file.
      "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
      "dataAnalysis": { # Data Analysis.
        "warnings": [
          "A String",
        ],
      },
      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
      "modelInfo": { # Model metadata.
        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
          "a_key": 3.14,
        },
        "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
        "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
          "a_key": {
            "a_key": 3.14,
          },
        },
        "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.
      "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,
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_5.hostedmodels.html000066400000000000000000000046371300622755700264540ustar00rootroot00000000000000

Prediction API . hostedmodels

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.
  }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_5.html000066400000000000000000000044161300622755700237560ustar00rootroot00000000000000

Prediction API

Instance Methods

hostedmodels()

Returns the hostedmodels Resource.

trainedmodels()

Returns the trainedmodels Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/prediction_v1_5.trainedmodels.html000066400000000000000000000571231300622755700266120ustar00rootroot00000000000000

Prediction API . trainedmodels

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,
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_6.hostedmodels.html000066400000000000000000000050031300622755700264410ustar00rootroot00000000000000

Prediction API . hostedmodels

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": "A String", # The estimated regression value (Regression models only).
    "selfLink": "A String", # A URL to re-request this resource.
  }
google-api-python-client-1.5.5/docs/dyn/prediction_v1_6.html000066400000000000000000000044161300622755700237570ustar00rootroot00000000000000

Prediction API

Instance Methods

hostedmodels()

Returns the hostedmodels Resource.

trainedmodels()

Returns the trainedmodels Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/prediction_v1_6.trainedmodels.html000066400000000000000000000504751300622755700266160ustar00rootroot00000000000000

Prediction API . trainedmodels

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": "A String", # 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.
  }
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.beaconinfo.html000066400000000000000000000124251300622755700276240ustar00rootroot00000000000000

Google Proximity Beacon API . beaconinfo

Instance Methods

getforobserved(body, x__xgafv=None)

Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/how-tos/authorizing#APIKey) for the application.

Method Details

getforobserved(body, x__xgafv=None) 
Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/how-tos/authorizing#APIKey) for the application.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".
    "observations": [ # The beacons that the client has encountered. At least one must be given.
      { # Represents one beacon observed once.
        "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The ID advertised by the beacon the client has encountered. Clients may submit an Eddystone-EID `advertised_id`. If the client is not authorized to resolve the given Eddystone-EID, no data will be returned for that beacon. Required.
          "type": "A String", # Specifies the identifier type. Required.
          "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
        },
        "telemetry": "A String", # The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally.
        "timestampMs": "A String", # Time when the beacon was observed.
      },
    ],
    "namespacedTypes": [ # Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format namespace/type. Accepts `*` to specify all types in all namespaces. Optional.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Information about the requested beacons, optionally including attachment data.
    "beacons": [ # Public information about beacons. May be empty if the request matched no beacons.
      { # A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.
        "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The ID advertised by the beacon.
          "type": "A String", # Specifies the identifier type. Required.
          "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
        },
        "attachments": [ # Attachments matching the type(s) requested. May be empty if no attachment types were requested, or if none matched.
          { # A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.
            "data": "A String", # An opaque data container for client-provided data.
            "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type, for example scrupulous-wombat-12345/welcome-message
          },
        ],
        "beaconName": "A String", # The name under which the beacon is registered.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.beacons.attachments.html000066400000000000000000000310311300622755700314370ustar00rootroot00000000000000

Google Proximity Beacon API . beacons . attachments

Instance Methods

batchDelete(beaconName, namespacedType=None, projectId=None, x__xgafv=None)

Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `*/*` to delete all. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

create(beaconName, body, projectId=None, x__xgafv=None)

Associates the given data with the specified beacon. Attachment data must contain two parts:

delete(attachmentName, projectId=None, x__xgafv=None)

Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

list(beaconName, namespacedType=None, projectId=None, x__xgafv=None)

Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

Method Details

batchDelete(beaconName, namespacedType=None, projectId=None, x__xgafv=None) 
Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `*/*` to delete all. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, The beacon whose attachments should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. (required)
  namespacedType: string, Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify "all types in all namespaces". Optional.
  projectId: string, The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for a request to delete attachments.
    "numDeleted": 42, # The number of attachments that were deleted.
  }
create(beaconName, body, projectId=None, x__xgafv=None) 
Associates the given data with the specified beacon. Attachment data must contain two parts:  
- A namespaced type. 
- The actual attachment data itself.  The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Beacon on which the attachment should be created. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Project-specific data associated with a beacon.
    "data": "A String", # An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.
    "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format: beacons/beacon_id/attachments/attachment_id. Leave this empty on creation.
    "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required.
  }

  projectId: string, The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Project-specific data associated with a beacon.
      "data": "A String", # An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.
      "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format: beacons/beacon_id/attachments/attachment_id. Leave this empty on creation.
      "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required.
    }
delete(attachmentName, projectId=None, x__xgafv=None) 
Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  attachmentName: string, The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the beacon's current EID, or its "stable" Eddystone-UID. Required. (required)
  projectId: string, The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
list(beaconName, namespacedType=None, projectId=None, x__xgafv=None) 
Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Beacon whose attachments should be fetched. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. (required)
  namespacedType: string, Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify "all types in all namespaces".
  projectId: string, The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response to ListBeaconAttachments that contains the requested attachments.
    "attachments": [ # The attachments that corresponded to the request params.
      { # Project-specific data associated with a beacon.
          "data": "A String", # An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.
          "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format: beacons/beacon_id/attachments/attachment_id. Leave this empty on creation.
          "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required.
        },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.beacons.diagnostics.html000066400000000000000000000125061300622755700314410ustar00rootroot00000000000000

Google Proximity Beacon API . beacons . diagnostics

Instance Methods

list(beaconName, pageSize=None, projectId=None, alertFilter=None, pageToken=None, x__xgafv=None)

List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(beaconName, pageSize=None, projectId=None, alertFilter=None, pageToken=None, x__xgafv=None) 
List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Beacon that the diagnostics are for. (required)
  pageSize: integer, Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.
  projectId: string, Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional.
  alertFilter: string, Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.
  pageToken: string, Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response that contains the requested diagnostics.
    "nextPageToken": "A String", # Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response.
    "diagnostics": [ # The diagnostics matching the given request.
      { # Diagnostics for a single beacon.
        "estimatedLowBatteryDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date.
          "month": 42, # Month of year. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
        },
        "alerts": [ # An unordered list of Alerts that the beacon has.
          "A String",
        ],
        "beaconName": "A String", # Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.beacons.html000066400000000000000000002106341300622755700271350ustar00rootroot00000000000000

Google Proximity Beacon API . beacons

Instance Methods

attachments()

Returns the attachments Resource.

diagnostics()

Returns the diagnostics Resource.

activate(beaconName, projectId=None, x__xgafv=None)

Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

deactivate(beaconName, projectId=None, x__xgafv=None)

Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

decommission(beaconName, projectId=None, x__xgafv=None)

Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

get(beaconName, projectId=None, x__xgafv=None)

Returns detailed information about the specified beacon. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

list(pageSize=None, projectId=None, q=None, pageToken=None, x__xgafv=None)

Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

register(body, projectId=None, x__xgafv=None)

Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

update(beaconName, body, projectId=None, x__xgafv=None)

Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Method Details

activate(beaconName, projectId=None, x__xgafv=None) 
Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Beacon that should be activated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. (required)
  projectId: string, The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
deactivate(beaconName, projectId=None, x__xgafv=None) 
Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Beacon that should be deactivated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. (required)
  projectId: string, The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
decommission(beaconName, projectId=None, x__xgafv=None) 
Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Beacon that should be decommissioned. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's "stable" UID. Required. (required)
  projectId: string, The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(beaconName, projectId=None, x__xgafv=None) 
Returns detailed information about the specified beacon. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

Args:
  beaconName: string, Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. (required)
  projectId: string, The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Details of a beacon device.
    "status": "A String", # Current status of the beacon. Required.
    "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
    "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. # The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
      "name": "A String", # The name of this level.
    },
    "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
    },
    "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
    "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. # Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
      "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
      "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
      "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
      "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
      "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
      "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
    },
    "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
      "type": "A String", # Specifies the identifier type. Required.
      "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
    },
    "beaconName": "A String", # Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
    "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
    "properties": { # Properties of the beacon device, for example battery type or firmware version. Optional.
      "a_key": "A String",
    },
    "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
  }
list(pageSize=None, projectId=None, q=None, pageToken=None, x__xgafv=None) 
Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  pageSize: integer, The maximum number of records to return for this request, up to a server-defined upper limit.
  projectId: string, The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.
  q: string, Filter query string that supports the following field filters: * `description:""` For example: `description:"Room 3"` Returns beacons whose description matches tokens in the string "Room 3" (not necessarily that exact string). The string must be double-quoted. * `status:` For example: `status:active` Returns beacons whose status matches the given value. Values must be one of the Beacon.Status enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `stability:` For example: `stability:mobile` Returns beacons whose expected stability matches the given value. Values must be one of the Beacon.Stability enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `place_id:""` For example: `place_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="` Returns beacons explicitly registered at the given place, expressed as a Place ID obtained from [Google Places API](/places/place-id). Does not match places inside the given place. Does not consider the beacon's actual location (which may be different from its registered place). Accepts multiple filters that will be combined with OR logic. The place ID must be double-quoted. * `registration_time[|=]` For example: `registration_time>=1433116800` Returns beacons whose registration time matches the given filter. Supports the operators: , =. Timestamp must be expressed as an integer number of seconds since midnight January 1, 1970 UTC. Accepts at most two filters that will be combined with AND logic, to support "between" semantics. If more than two are supplied, the latter ones are ignored. * `lat: lng: radius:` For example: `lat:51.1232343 lng:-1.093852 radius:1000` Returns beacons whose registered location is within the given circle. When any of these fields are given, all are required. Latitude and longitude must be decimal degrees between -90.0 and 90.0 and between -180.0 and 180.0 respectively. Radius must be an integer number of meters between 10 and 1,000,000 (1000 km). * `property:"="` For example: `property:"battery-type=CR2032"` Returns beacons which have a property of the given name and value. Supports multiple filters which will be combined with OR logic. The entire name=value string must be double-quoted as one string. * `attachment_type:""` For example: `attachment_type:"my-namespace/my-type"` Returns beacons having at least one attachment of the given namespaced type. Supports "any within this namespace" via the partial wildcard syntax: "my-namespace/*". Supports multiple filters which will be combined with OR logic. The string must be double-quoted. Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces. As with any HTTP query string parameter, the whole filter expression must be URL-encoded. Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`
  pageToken: string, A pagination token obtained from a previous request to list beacons.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response that contains list beacon results and pagination help.
    "beacons": [ # The beacons that matched the search criteria.
      { # Details of a beacon device.
        "status": "A String", # Current status of the beacon. Required.
        "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
        "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. # The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
          "name": "A String", # The name of this level.
        },
        "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
          "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
          "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
        },
        "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
        "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. # Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
          "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
          "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
          "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
          "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
          "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
          "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
        },
        "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
          "type": "A String", # Specifies the identifier type. Required.
          "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
        },
        "beaconName": "A String", # Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
        "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
        "properties": { # Properties of the beacon device, for example battery type or firmware version. Optional.
          "a_key": "A String",
        },
        "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
      },
    ],
    "nextPageToken": "A String", # An opaque pagination token that the client may provide in their next request to retrieve the next page of results.
    "totalCount": "A String", # Estimate of the total number of beacons matched by the query. Higher values may be less accurate.
  }
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.
register(body, projectId=None, x__xgafv=None) 
Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Details of a beacon device.
  "status": "A String", # Current status of the beacon. Required.
  "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
  "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. # The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
    "name": "A String", # The name of this level.
  },
  "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
  },
  "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
  "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. # Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
    "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
    "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
    "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
    "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
    "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
    "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
  },
  "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
    "type": "A String", # Specifies the identifier type. Required.
    "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
  },
  "beaconName": "A String", # Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
  "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
  "properties": { # Properties of the beacon device, for example battery type or firmware version. Optional.
    "a_key": "A String",
  },
  "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
}

  projectId: string, The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Details of a beacon device.
    "status": "A String", # Current status of the beacon. Required.
    "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
    "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. # The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
      "name": "A String", # The name of this level.
    },
    "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
    },
    "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
    "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. # Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
      "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
      "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
      "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
      "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
      "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
      "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
    },
    "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
      "type": "A String", # Specifies the identifier type. Required.
      "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
    },
    "beaconName": "A String", # Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
    "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
    "properties": { # Properties of the beacon device, for example battery type or firmware version. Optional.
      "a_key": "A String",
    },
    "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
  }
update(beaconName, body, projectId=None, x__xgafv=None) 
Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  beaconName: string, Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Details of a beacon device.
  "status": "A String", # Current status of the beacon. Required.
  "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
  "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. # The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
    "name": "A String", # The name of this level.
  },
  "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
  },
  "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
  "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. # Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
    "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
    "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
    "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
    "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
    "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
    "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
  },
  "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
    "type": "A String", # Specifies the identifier type. Required.
    "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
  },
  "beaconName": "A String", # Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
  "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
  "properties": { # Properties of the beacon device, for example battery type or firmware version. Optional.
    "a_key": "A String",
  },
  "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
}

  projectId: string, The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Details of a beacon device.
    "status": "A String", # Current status of the beacon. Required.
    "description": "A String", # Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
    "indoorLevel": { # Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. # The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
      "name": "A String", # The name of this level.
    },
    "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
    },
    "placeId": "A String", # The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
    "ephemeralIdRegistration": { # Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. # Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
      "rotationPeriodExponent": 42, # Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
      "initialClockValue": "A String", # The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
      "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
      "initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
      "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
      "beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
    },
    "advertisedId": { # Defines a unique identifier of a beacon as broadcast by the device. # The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
      "type": "A String", # Specifies the identifier type. Required.
      "id": "A String", # The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
    },
    "beaconName": "A String", # Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
    "expectedStability": "A String", # Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
    "properties": { # Properties of the beacon device, for example battery type or firmware version. Optional.
      "a_key": "A String",
    },
    "provisioningKey": "A String", # Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
  }
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.html000066400000000000000000000051461300622755700255240ustar00rootroot00000000000000

Google Proximity Beacon API

Instance Methods

beaconinfo()

Returns the beaconinfo Resource.

beacons()

Returns the beacons Resource.

namespaces()

Returns the namespaces Resource.

v1beta1()

Returns the v1beta1 Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.namespaces.html000066400000000000000000000117051300622755700276400ustar00rootroot00000000000000

Google Proximity Beacon API . namespaces

Instance Methods

list(projectId=None, x__xgafv=None)

Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

update(namespaceName, body, projectId=None, x__xgafv=None)

Updates the information about the specified namespace. Only the namespace visibility can be updated.

Method Details

list(projectId=None, x__xgafv=None) 
Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

Args:
  projectId: string, The project id to list namespaces under. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response to ListNamespacesRequest that contains all the project's namespaces.
    "namespaces": [ # The attachments that corresponded to the request params.
      { # An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.
        "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format: namespaces/namespace.
        "servingVisibility": "A String", # Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
      },
    ],
  }
update(namespaceName, body, projectId=None, x__xgafv=None) 
Updates the information about the specified namespace. Only the namespace visibility can be updated.

Args:
  namespaceName: string, Resource name of this namespace. Namespaces names have the format: namespaces/namespace. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.
  "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format: namespaces/namespace.
  "servingVisibility": "A String", # Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
}

  projectId: string, The project id of the namespace to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.
    "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format: namespaces/namespace.
    "servingVisibility": "A String", # Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
  }
google-api-python-client-1.5.5/docs/dyn/proximitybeacon_v1beta1.v1beta1.html000066400000000000000000000060651300622755700267670ustar00rootroot00000000000000

Google Proximity Beacon API . v1beta1

Instance Methods

getEidparams(x__xgafv=None)

Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.

Method Details

getEidparams(x__xgafv=None) 
Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.

Args:
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.
    "minRotationPeriodExponent": 42, # Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
    "maxRotationPeriodExponent": 42, # Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
    "serviceEcdhPublicKey": "A String", # The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange.
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1.html000066400000000000000000000041251300622755700226670ustar00rootroot00000000000000

Google Cloud Pub/Sub API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/pubsub_v1.projects.html000066400000000000000000000030521300622755700245150ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects

Instance Methods

snapshots()

Returns the snapshots Resource.

subscriptions()

Returns the subscriptions Resource.

topics()

Returns the topics Resource.

google-api-python-client-1.5.5/docs/dyn/pubsub_v1.projects.snapshots.html000066400000000000000000000307741300622755700265510ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . snapshots

Instance Methods

getIamPolicy(resource, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

getIamPolicy(resource, x__xgafv=None) 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1.projects.subscriptions.html000066400000000000000000001164751300622755700274410ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . subscriptions

Instance Methods

acknowledge(subscription, body, x__xgafv=None)

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

create(name, body, x__xgafv=None)

Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.

delete(subscription, x__xgafv=None)

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

get(subscription, x__xgafv=None)

Gets the configuration details of a subscription.

getIamPolicy(resource, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

list(project, pageSize=None, pageToken=None, x__xgafv=None)

Lists matching subscriptions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

modifyAckDeadline(subscription, body, x__xgafv=None)

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

modifyPushConfig(subscription, body, x__xgafv=None)

Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

pull(subscription, body, x__xgafv=None)

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

acknowledge(subscription, body, x__xgafv=None) 
Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Args:
  subscription: string, The subscription whose message is being acknowledged. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Acknowledge method.
    "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
create(name, body, x__xgafv=None) 
Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.

Args:
  name: string, The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A subscription resource.
  "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
  "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
  "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
    "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
      "a_key": "A String",
    },
    "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
  },
  "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A subscription resource.
    "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
    "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
    "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
      "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
        "a_key": "A String",
      },
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
delete(subscription, x__xgafv=None) 
Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

Args:
  subscription: string, The subscription to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(subscription, x__xgafv=None) 
Gets the configuration details of a subscription.

Args:
  subscription: string, The name of the subscription to get. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A subscription resource.
    "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
    "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
    "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
      "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
        "a_key": "A String",
      },
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
getIamPolicy(resource, x__xgafv=None) 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(project, pageSize=None, pageToken=None, x__xgafv=None) 
Lists matching subscriptions.

Args:
  project: string, The name of the cloud project that subscriptions belong to. (required)
  pageSize: integer, Maximum number of subscriptions to return.
  pageToken: string, The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `ListSubscriptions` method.
    "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.
    "subscriptions": [ # The subscriptions that match the request.
      { # A subscription resource.
        "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
        "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
        "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
          "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
            "a_key": "A String",
          },
          "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
        },
        "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
      },
    ],
  }
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.
modifyAckDeadline(subscription, body, x__xgafv=None) 
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

Args:
  subscription: string, The name of the subscription. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the ModifyAckDeadline method.
    "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request.
    "ackIds": [ # List of acknowledgment IDs.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
modifyPushConfig(subscription, body, x__xgafv=None) 
Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

Args:
  subscription: string, The name of the subscription. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the ModifyPushConfig method.
    "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called.
      "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
        "a_key": "A String",
      },
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
pull(subscription, body, x__xgafv=None) 
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

Args:
  subscription: string, The subscription from which messages should be pulled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the `Pull` method.
    "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
    "maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `Pull` method.
    "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.
      { # A message and its corresponding acknowledgment ID.
        "ackId": "A String", # This ID can be used to acknowledge the received message.
        "message": { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. # The message.
          "attributes": { # Optional attributes for this message.
            "a_key": "A String",
          },
          "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
          "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
          "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
        },
      },
    ],
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1.projects.topics.html000066400000000000000000000514561300622755700260300ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . topics

Instance Methods

subscriptions()

Returns the subscriptions Resource.

create(name, body, x__xgafv=None)

Creates the given topic with the given name.

delete(topic, x__xgafv=None)

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

get(topic, x__xgafv=None)

Gets the configuration of a topic.

getIamPolicy(resource, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

list(project, pageSize=None, pageToken=None, x__xgafv=None)

Lists matching topics.

list_next(previous_request, previous_response)

Retrieves the next page of results.

publish(topic, body, x__xgafv=None)

Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

create(name, body, x__xgafv=None) 
Creates the given topic with the given name.

Args:
  name: string, The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A topic resource.
  "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A topic resource.
    "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
delete(topic, x__xgafv=None) 
Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Args:
  topic: string, Name of the topic to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(topic, x__xgafv=None) 
Gets the configuration of a topic.

Args:
  topic: string, The name of the topic to get. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A topic resource.
    "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
getIamPolicy(resource, x__xgafv=None) 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(project, pageSize=None, pageToken=None, x__xgafv=None) 
Lists matching topics.

Args:
  project: string, The name of the cloud project that topics belong to. (required)
  pageSize: integer, Maximum number of topics to return.
  pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `ListTopics` method.
    "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
    "topics": [ # The resulting topics.
      { # A topic resource.
        "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
      },
    ],
  }
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.
publish(topic, body, x__xgafv=None) 
Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

Args:
  topic: string, The messages in the request will be published on this topic. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Publish method.
    "messages": [ # The messages to publish.
      { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
        "attributes": { # Optional attributes for this message.
          "a_key": "A String",
        },
        "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
        "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
        "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `Publish` method.
    "messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
      "A String",
    ],
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1.projects.topics.subscriptions.html000066400000000000000000000061011300622755700307210ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . topics . subscriptions

Instance Methods

list(topic, pageSize=None, pageToken=None, x__xgafv=None)

Lists the name of the subscriptions for this topic.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(topic, pageSize=None, pageToken=None, x__xgafv=None) 
Lists the name of the subscriptions for this topic.

Args:
  topic: string, The name of the topic that subscriptions are attached to. (required)
  pageSize: integer, Maximum number of subscription names to return.
  pageToken: string, The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `ListTopicSubscriptions` method.
    "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.
    "subscriptions": [ # The names of the subscriptions that match the request.
      "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.
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta1a.html000066400000000000000000000044061300622755700237470ustar00rootroot00000000000000

Google Cloud Pub/Sub API

Instance Methods

subscriptions()

Returns the subscriptions Resource.

topics()

Returns the topics Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta1a.subscriptions.html000066400000000000000000000622061300622755700266570ustar00rootroot00000000000000

Google Cloud Pub/Sub API . subscriptions

Instance Methods

acknowledge(body, x__xgafv=None)

Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.

create(body, x__xgafv=None)

Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.

delete(subscription, x__xgafv=None)

Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.

get(subscription, x__xgafv=None)

Gets the configuration details of a subscription.

list(maxResults=None, pageToken=None, query=None, x__xgafv=None)

Lists matching subscriptions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

modifyAckDeadline(body, x__xgafv=None)

Modifies the Ack deadline for a message received from a pull request.

modifyPushConfig(body, x__xgafv=None)

Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.

pull(body, x__xgafv=None)

Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).

pullBatch(body, x__xgafv=None)

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.

Method Details

acknowledge(body, x__xgafv=None) 
Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Acknowledge method.
    "ackId": [ # The acknowledgment ID for the message being acknowledged. This was returned by the Pub/Sub system in the Pull response.
      "A String",
    ],
    "subscription": "A String", # The subscription whose message is being acknowledged.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
  }
create(body, x__xgafv=None) 
Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A subscription resource.
  "topic": "A String", # The name of the topic from which this subscription is receiving messages.
  "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
  "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
    "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
  },
  "name": "A String", # Name of the subscription.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A subscription resource.
    "topic": "A String", # The name of the topic from which this subscription is receiving messages.
    "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
    "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "name": "A String", # Name of the subscription.
  }
delete(subscription, x__xgafv=None) 
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.

Args:
  subscription: string, The subscription to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
  }
get(subscription, x__xgafv=None) 
Gets the configuration details of a subscription.

Args:
  subscription: string, The name of the subscription to get. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A subscription resource.
    "topic": "A String", # The name of the topic from which this subscription is receiving messages.
    "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
    "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "name": "A String", # Name of the subscription.
  }
list(maxResults=None, pageToken=None, query=None, x__xgafv=None) 
Lists matching subscriptions.

Args:
  maxResults: integer, Maximum number of subscriptions to return.
  pageToken: string, The value obtained in the last ListSubscriptionsResponse for continuation.
  query: string, A valid label query expression.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the ListSubscriptions method.
    "nextPageToken": "A String", # If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next ListSubscriptionsRequest to continue.
    "subscription": [ # The subscriptions that match the request.
      { # A subscription resource.
        "topic": "A String", # The name of the topic from which this subscription is receiving messages.
        "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
        "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
          "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
        },
        "name": "A String", # Name of the subscription.
      },
    ],
  }
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.
modifyAckDeadline(body, x__xgafv=None) 
Modifies the Ack deadline for a message received from a pull request.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the ModifyAckDeadline method.
    "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request.
    "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, not both.
    "ackIds": [ # List of acknowledgment IDs. Either this field or ack_id should be populated, not both.
      "A String",
    ],
    "subscription": "A String", # Next Index: 5 The name of the subscription from which messages are being pulled.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
  }
modifyPushConfig(body, x__xgafv=None) 
Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the ModifyPushConfig method.
    "pushConfig": { # Configuration for a push delivery endpoint. # An empty push_config indicates that the Pub/Sub system should pause pushing messages from the given subscription.
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "subscription": "A String", # The name of the subscription.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
  }
pull(body, x__xgafv=None) 
Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Pull method.
    "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning FAILED_PRECONDITION. The client may cancel the request if it does not wish to wait any longer for the response.
    "subscription": "A String", # The subscription from which a message should be pulled.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Either a PubsubMessage or a truncation event. One of these two must be populated.
    "pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event.
      "deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.)
      "message": { # A message data and its labels. # A received message.
        "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
        "data": "A String", # The message payload.
        "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
        "label": [ # Optional list of labels for this message. Keys in this collection must be unique.
          { # A key-value pair applied to a given object.
            "numValue": "A String", # An integer value.
            "strValue": "A String", # A string value.
            "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
          },
        ],
      },
      "truncated": True or False, # Indicates that this subscription has been truncated.
      "subscription": "A String", # The subscription that received the event.
    },
    "ackId": "A String", # This ID must be used to acknowledge the received event or message.
  }
pullBatch(body, x__xgafv=None) 
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the PullBatch method.
    "maxEvents": 42, # The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return fewer than the number of events specified.
    "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
    "subscription": "A String", # The subscription from which messages should be pulled.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the PullBatch method.
    "pullResponses": [ # Received Pub/Sub messages or status events. The Pub/Sub system will return zero messages if there are no more messages available in the backlog. The Pub/Sub system may return fewer than the max_events requested even if there are more messages available in the backlog.
      { # Either a PubsubMessage or a truncation event. One of these two must be populated.
        "pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event.
          "deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.)
          "message": { # A message data and its labels. # A received message.
            "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
            "data": "A String", # The message payload.
            "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
            "label": [ # Optional list of labels for this message. Keys in this collection must be unique.
              { # A key-value pair applied to a given object.
                "numValue": "A String", # An integer value.
                "strValue": "A String", # A string value.
                "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
              },
            ],
          },
          "truncated": True or False, # Indicates that this subscription has been truncated.
          "subscription": "A String", # The subscription that received the event.
        },
        "ackId": "A String", # This ID must be used to acknowledge the received event or message.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta1a.topics.html000066400000000000000000000252451300622755700252530ustar00rootroot00000000000000

Google Cloud Pub/Sub API . topics

Instance Methods

create(body, x__xgafv=None)

Creates the given topic with the given name.

delete(topic, x__xgafv=None)

Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.

get(topic, x__xgafv=None)

Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.

list(maxResults=None, pageToken=None, query=None, x__xgafv=None)

Lists matching topics.

list_next(previous_request, previous_response)

Retrieves the next page of results.

publish(body, x__xgafv=None)

Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.

publishBatch(body, x__xgafv=None)

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Method Details

create(body, x__xgafv=None) 
Creates the given topic with the given name.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A topic resource.
  "name": "A String", # Name of the topic.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A topic resource.
    "name": "A String", # Name of the topic.
  }
delete(topic, x__xgafv=None) 
Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.

Args:
  topic: string, Name of the topic to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
  }
get(topic, x__xgafv=None) 
Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.

Args:
  topic: string, The name of the topic to get. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A topic resource.
    "name": "A String", # Name of the topic.
  }
list(maxResults=None, pageToken=None, query=None, x__xgafv=None) 
Lists matching topics.

Args:
  maxResults: integer, Maximum number of topics to return.
  pageToken: string, The value obtained in the last ListTopicsResponse for continuation.
  query: string, A valid label query expression.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the ListTopics method.
    "topic": [ # The resulting topics.
      { # A topic resource.
        "name": "A String", # Name of the topic.
      },
    ],
    "nextPageToken": "A String", # If not empty, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue.
  }
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.
publish(body, x__xgafv=None) 
Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Publish method.
    "topic": "A String", # The message in the request will be published on this topic.
    "message": { # A message data and its labels. # The message to publish.
      "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
      "data": "A String", # The message payload.
      "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
      "label": [ # Optional list of labels for this message. Keys in this collection must be unique.
        { # A key-value pair applied to a given object.
          "numValue": "A String", # An integer value.
          "strValue": "A String", # A string value.
          "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
        },
      ],
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
  }
publishBatch(body, x__xgafv=None) 
Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the PublishBatch method.
    "topic": "A String", # The messages in the request will be published on this topic.
    "messages": [ # The messages to publish.
      { # A message data and its labels.
        "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
        "data": "A String", # The message payload.
        "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
        "label": [ # Optional list of labels for this message. Keys in this collection must be unique.
          { # A key-value pair applied to a given object.
            "numValue": "A String", # An integer value.
            "strValue": "A String", # A string value.
            "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
          },
        ],
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the PublishBatch method.
    "messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta2.html000066400000000000000000000041371300622755700236100ustar00rootroot00000000000000

Google Cloud Pub/Sub API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta2.projects.html000066400000000000000000000026341300622755700254400ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects

Instance Methods

subscriptions()

Returns the subscriptions Resource.

topics()

Returns the topics Resource.

google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta2.projects.subscriptions.html000066400000000000000000001166661300622755700303610ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . subscriptions

Instance Methods

acknowledge(subscription, body, x__xgafv=None)

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

create(name, body, x__xgafv=None)

Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.

delete(subscription, x__xgafv=None)

Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.

get(subscription, x__xgafv=None)

Gets the configuration details of a subscription.

getIamPolicy(resource, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

list(project, pageSize=None, pageToken=None, x__xgafv=None)

Lists matching subscriptions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

modifyAckDeadline(subscription, body, x__xgafv=None)

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

modifyPushConfig(subscription, body, x__xgafv=None)

Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

pull(subscription, body, x__xgafv=None)

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

acknowledge(subscription, body, x__xgafv=None) 
Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Args:
  subscription: string, The subscription whose message is being acknowledged. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Acknowledge method.
    "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
create(name, body, x__xgafv=None) 
Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.

Args:
  name: string, The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A subscription resource.
  "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
  "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
  "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
    "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
      "a_key": "A String",
    },
    "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
  },
  "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A subscription resource.
    "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
    "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
    "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
      "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
        "a_key": "A String",
      },
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
delete(subscription, x__xgafv=None) 
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.

Args:
  subscription: string, The subscription to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(subscription, x__xgafv=None) 
Gets the configuration details of a subscription.

Args:
  subscription: string, The name of the subscription to get. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A subscription resource.
    "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
    "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
    "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
      "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
        "a_key": "A String",
      },
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
    "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
getIamPolicy(resource, x__xgafv=None) 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(project, pageSize=None, pageToken=None, x__xgafv=None) 
Lists matching subscriptions.

Args:
  project: string, The name of the cloud project that subscriptions belong to. (required)
  pageSize: integer, Maximum number of subscriptions to return.
  pageToken: string, The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `ListSubscriptions` method.
    "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.
    "subscriptions": [ # The subscriptions that match the request.
      { # A subscription resource.
        "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
        "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
        "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
          "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
            "a_key": "A String",
          },
          "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
        },
        "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
      },
    ],
  }
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.
modifyAckDeadline(subscription, body, x__xgafv=None) 
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

Args:
  subscription: string, The name of the subscription. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the ModifyAckDeadline method.
    "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request.
    "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not both.
    "ackIds": [ # List of acknowledgment IDs.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
modifyPushConfig(subscription, body, x__xgafv=None) 
Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

Args:
  subscription: string, The name of the subscription. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the ModifyPushConfig method.
    "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called.
      "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
        "a_key": "A String",
      },
      "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
pull(subscription, body, x__xgafv=None) 
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

Args:
  subscription: string, The subscription from which messages should be pulled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the `Pull` method.
    "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
    "maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `Pull` method.
    "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.
      { # A message and its corresponding acknowledgment ID.
        "ackId": "A String", # This ID can be used to acknowledge the received message.
        "message": { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. # The message.
          "attributes": { # Optional attributes for this message.
            "a_key": "A String",
          },
          "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
          "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
          "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
        },
      },
    ],
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta2.projects.topics.html000066400000000000000000000515021300622755700267360ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . topics

Instance Methods

subscriptions()

Returns the subscriptions Resource.

create(name, body, x__xgafv=None)

Creates the given topic with the given name.

delete(topic, x__xgafv=None)

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

get(topic, x__xgafv=None)

Gets the configuration of a topic.

getIamPolicy(resource, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

list(project, pageSize=None, pageToken=None, x__xgafv=None)

Lists matching topics.

list_next(previous_request, previous_response)

Retrieves the next page of results.

publish(topic, body, x__xgafv=None)

Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

create(name, body, x__xgafv=None) 
Creates the given topic with the given name.

Args:
  name: string, The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A topic resource.
  "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A topic resource.
    "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
delete(topic, x__xgafv=None) 
Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Args:
  topic: string, Name of the topic to delete. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(topic, x__xgafv=None) 
Gets the configuration of a topic.

Args:
  topic: string, The name of the topic to get. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A topic resource.
    "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
  }
getIamPolicy(resource, x__xgafv=None) 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
list(project, pageSize=None, pageToken=None, x__xgafv=None) 
Lists matching topics.

Args:
  project: string, The name of the cloud project that topics belong to. (required)
  pageSize: integer, Maximum number of topics to return.
  pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `ListTopics` method.
    "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
    "topics": [ # The resulting topics.
      { # A topic resource.
        "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
      },
    ],
  }
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.
publish(topic, body, x__xgafv=None) 
Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

Args:
  topic: string, The messages in the request will be published on this topic. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the Publish method.
    "messages": [ # The messages to publish.
      { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
        "attributes": { # Optional attributes for this message.
          "a_key": "A String",
        },
        "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
        "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
        "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `Publish` method.
    "messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
      "A String",
    ],
  }
setIamPolicy(resource, body, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any existing policy.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
      "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
    "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
  }
testIamPermissions(resource, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html000066400000000000000000000061251300622755700316450ustar00rootroot00000000000000

Google Cloud Pub/Sub API . projects . topics . subscriptions

Instance Methods

list(topic, pageSize=None, pageToken=None, x__xgafv=None)

Lists the name of the subscriptions for this topic.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(topic, pageSize=None, pageToken=None, x__xgafv=None) 
Lists the name of the subscriptions for this topic.

Args:
  topic: string, The name of the topic that subscriptions are attached to. (required)
  pageSize: integer, Maximum number of subscription names to return.
  pageToken: string, The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response for the `ListTopicSubscriptions` method.
    "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.
    "subscriptions": [ # The names of the subscriptions that match the request.
      "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.
google-api-python-client-1.5.5/docs/dyn/qpxExpress_v1.html000066400000000000000000000041131300622755700235460ustar00rootroot00000000000000

QPX Express API

Instance Methods

trips()

Returns the trips Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/qpxExpress_v1.trips.html000066400000000000000000000563131300622755700247170ustar00rootroot00000000000000

QPX Express API . trips

Instance Methods

search(body)

Returns a list of flights.

Method Details

search(body) 
Returns a list of flights.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A QPX Express search request.
    "request": { # A QPX Express search request, which will yield one or more solutions. # A QPX Express search request. Required values are at least one adult or senior passenger, an origin, a destination, and a date.
      "passengers": { # The number and type of passengers. Unfortunately the definition of an infant, child, adult, and senior citizen varies across carriers and reservation systems. # Counts for each passenger type in the request.
        "kind": "qpxexpress#passengerCounts", # Identifies this as a passenger count object, representing the number of passengers. Value: the fixed string qpxexpress#passengerCounts.
        "infantInLapCount": 42, # The number of passengers that are infants travelling in the lap of an adult.
        "seniorCount": 42, # The number of passengers that are senior citizens.
        "infantInSeatCount": 42, # The number of passengers that are infants each assigned a seat.
        "childCount": 42, # The number of passengers that are children.
        "adultCount": 42, # The number of passengers that are adults.
      },
      "slice": [ # The slices that make up the itinerary of this trip. A slice represents a traveler's intent, the portion of a low-fare search corresponding to a traveler's request to get between two points. One-way journeys are generally expressed using one slice, round-trips using two. An example of a one slice trip with three segments might be BOS-SYD, SYD-LAX, LAX-BOS if the traveler only stopped in SYD and LAX just long enough to change planes.
        { # Criteria a desired slice must satisfy.
          "origin": "A String", # Airport or city IATA designator of the origin.
          "preferredCabin": "A String", # Prefer solutions that book in this cabin for this slice. Allowed values are COACH, PREMIUM_COACH, BUSINESS, and FIRST.
          "kind": "qpxexpress#sliceInput", # Identifies this as a slice input object, representing the criteria a desired slice must satisfy. Value: the fixed string qpxexpress#sliceInput.
          "alliance": "A String", # Slices with only the carriers in this alliance should be returned; do not use this field with permittedCarrier. Allowed values are ONEWORLD, SKYTEAM, and STAR.
          "destination": "A String", # Airport or city IATA designator of the destination.
          "maxStops": 42, # The maximum number of stops you are willing to accept in this slice.
          "permittedDepartureTime": { # Two times in a single day defining a time range. # Slices must depart in this time of day range, local to the point of departure.
            "latestTime": "A String", # The latest time of day in HH:MM format.
            "kind": "qpxexpress#timeOfDayRange", # Identifies this as a time of day range object, representing two times in a single day defining a time range. Value: the fixed string qpxexpress#timeOfDayRange.
            "earliestTime": "A String", # The earliest time of day in HH:MM format.
          },
          "permittedCarrier": [ # A list of 2-letter IATA airline designators. Slices with only these carriers should be returned.
            "A String",
          ],
          "maxConnectionDuration": 42, # The longest connection between two legs, in minutes, you are willing to accept.
          "date": "A String", # Departure date in YYYY-MM-DD format.
          "prohibitedCarrier": [ # A list of 2-letter IATA airline designators. Exclude slices that use these carriers.
            "A String",
          ],
        },
      ],
      "saleCountry": "A String", # IATA country code representing the point of sale. This determines the "equivalent amount paid" currency for the ticket.
      "maxPrice": "A String", # Do not return solutions that cost more than this price. The alphabetical part of the price is in ISO 4217. The format, in regex, is [A-Z]{3}\d+(\.\d+)? Example: $102.07
      "ticketingCountry": "A String", # IATA country code representing the point of ticketing.
      "solutions": 42, # The number of solutions to return, maximum 500.
      "refundable": True or False, # Return only solutions with refundable fares.
    },
  }


Returns:
  An object of the form:

    { # A QPX Express search response.
    "kind": "qpxExpress#tripsSearch", # Identifies this as a QPX Express API search response resource. Value: the fixed string qpxExpress#tripsSearch.
    "trips": { # A QPX Express search response. # All possible solutions to the QPX Express search request.
      "tripOption": [ # A list of priced itinerary solutions to the QPX Express query.
        { # Trip information.
          "saleTotal": "A String", # The total price for all passengers on the trip, in the form of a currency followed by an amount, e.g. USD253.35.
          "kind": "qpxexpress#tripOption", # Identifies this as a trip information object. Value: the fixed string qpxexpress#tripOption.
          "slice": [ # The slices that make up this trip's itinerary.
            { # Information about a slice. A slice represents a traveller's intent, the portion of a low-fare search corresponding to a traveler's request to get between two points. One-way journeys are generally expressed using 1 slice, round-trips using 2. For example, if a traveler specifies the following trip in a user interface:
                # | Origin | Destination | Departure Date | | BOS | LAX | March 10, 2007 | | LAX | SYD | March 17, 2007 | | SYD | BOS | March 22, 2007 |
                # then this is a three slice trip.
              "duration": 42, # The duration of the slice in minutes.
              "kind": "qpxexpress#sliceInfo", # Identifies this as a slice object. A slice represents a traveller's intent, the portion of a low-fare search corresponding to a traveler's request to get between two points. One-way journeys are generally expressed using 1 slice, round-trips using 2. Value: the fixed string qpxexpress#sliceInfo.
              "segment": [ # The segment(s) constituting the slice.
                { # Details of a segment of a flight; a segment is one or more consecutive legs on the same flight. For example a hypothetical flight ZZ001, from DFW to OGG, would have one segment with two legs: DFW to HNL (leg 1), HNL to OGG (leg 2), and DFW to OGG (legs 1 and 2).
                  "kind": "qpxexpress#segmentInfo", # Identifies this as a segment object. A segment is one or more consecutive legs on the same flight. For example a hypothetical flight ZZ001, from DFW to OGG, could have one segment with two legs: DFW to HNL (leg 1), HNL to OGG (leg 2). Value: the fixed string qpxexpress#segmentInfo.
                  "bookingCodeCount": 42, # The number of seats available in this booking code on this segment.
                  "flight": { # A flight is a sequence of legs with the same airline carrier and flight number. (A leg is the smallest unit of travel, in the case of a flight a takeoff immediately followed by a landing at two set points on a particular carrier with a particular flight number.) The naive view is that a flight is scheduled travel of an aircraft between two points, with possibly intermediate stops, but carriers will frequently list flights that require a change of aircraft between legs. # The flight this is a segment of.
                    "carrier": "A String",
                    "number": "A String", # The flight number.
                  },
                  "leg": [ # The legs composing this segment.
                    { # Information about a leg. (A leg is the smallest unit of travel, in the case of a flight a takeoff immediately followed by a landing at two set points on a particular carrier with a particular flight number.)
                      "origin": "A String", # The leg origin as a city and airport.
                      "originTerminal": "A String", # The terminal the flight is scheduled to depart from.
                      "departureTime": "A String", # The scheduled departure time of the leg, local to the point of departure.
                      "destinationTerminal": "A String", # The terminal the flight is scheduled to arrive at.
                      "secure": True or False, # Whether passenger information must be furnished to the United States Transportation Security Administration (TSA) prior to departure.
                      "connectionDuration": 42, # Duration of a connection following this leg, in minutes.
                      "destination": "A String", # The leg destination as a city and airport.
                      "kind": "qpxexpress#legInfo", # Identifies this as a leg object. A leg is the smallest unit of travel, in the case of a flight a takeoff immediately followed by a landing at two set points on a particular carrier with a particular flight number. Value: the fixed string qpxexpress#legInfo.
                      "meal": "A String", # A simple, general description of the meal(s) served on the flight, for example: "Hot meal".
                      "aircraft": "A String", # The aircraft (or bus, ferry, railcar, etc) travelling between the two points of this leg.
                      "mileage": 42, # The number of miles in this leg.
                      "changePlane": True or False, # Whether you have to change planes following this leg. Only applies to the next leg.
                      "arrivalTime": "A String", # The scheduled time of arrival at the destination of the leg, local to the point of arrival.
                      "duration": 42, # The scheduled travelling time from the origin to the destination.
                      "operatingDisclosure": "A String", # Department of Transportation disclosure information on the actual operator of a flight in a code share. (A code share refers to a marketing agreement between two carriers, where one carrier will list in its schedules (and take bookings for) flights that are actually operated by another carrier.)
                      "onTimePerformance": 42, # In percent, the published on time performance on this leg.
                      "id": "A String", # An identifier that uniquely identifies this leg in the solution.
                    },
                  ],
                  "subjectToGovernmentApproval": True or False, # Whether the operation of this segment remains subject to government approval.
                  "connectionDuration": 42, # In minutes, the duration of the connection following this segment.
                  "bookingCode": "A String", # The booking code or class for this segment.
                  "duration": 42, # The duration of the flight segment in minutes.
                  "id": "A String", # An id uniquely identifying the segment in the solution.
                  "cabin": "A String", # The cabin booked for this segment.
                  "marriedSegmentGroup": "A String", # The solution-based index of a segment in a married segment group. Married segments can only be booked together. For example, an airline might report a certain booking code as sold out from Boston to Pittsburgh, but as available as part of two married segments Boston to Chicago connecting through Pittsburgh. For example content of this field, consider the round-trip flight ZZ1 PHX-PHL ZZ2 PHL-CLT ZZ3 CLT-PHX. This has three segments, with the two outbound ones (ZZ1 ZZ2) married. In this case, the two outbound segments belong to married segment group 0, and the return segment belongs to married segment group 1.
                },
              ],
            },
          ],
          "id": "A String", # Identifier uniquely identifying this trip in a response.
          "pricing": [ # Per passenger pricing information.
            { # The price of one or more travel segments. The currency used to purchase tickets is usually determined by the sale/ticketing city or the sale/ticketing country, unless none are specified, in which case it defaults to that of the journey origin country.
              "fare": [ # The fare used to price one or more segments.
                { # Complete information about a fare used in the solution to a low-fare search query. In the airline industry a fare is a price an airline charges for one-way travel between two points. A fare typically contains a carrier code, two city codes, a price, and a fare basis. (A fare basis is a one-to-eight character alphanumeric code used to identify a fare.)
                  "basisCode": "A String",
                  "origin": "A String", # The city code of the city the trip begins at.
                  "kind": "qpxexpress#fareInfo", # Identifies this as a fare object. Value: the fixed string qpxexpress#fareInfo.
                  "destination": "A String", # The city code of the city the trip ends at.
                  "private": True or False, # Whether this is a private fare, for example one offered only to select customers rather than the general public.
                  "carrier": "A String", # The carrier of the aircraft or other vehicle commuting between two points.
                  "id": "A String", # A unique identifier of the fare.
                },
              ],
              "fareCalculation": "A String", # The horizontal fare calculation. This is a field on a ticket that displays all of the relevant items that go into the calculation of the fare.
              "kind": "qpxexpress#pricingInfo", # Identifies this as a pricing object, representing the price of one or more travel segments. Value: the fixed string qpxexpress#pricingInfo.
              "segmentPricing": [ # The per-segment price and baggage information.
                { # The price of this segment.
                  "kind": "qpxexpress#segmentPricing", # Identifies this as a segment pricing object, representing the price of this segment. Value: the fixed string qpxexpress#segmentPricing.
                  "fareId": "A String", # A segment identifier unique within a single solution. It is used to refer to different parts of the same solution.
                  "freeBaggageOption": [ # Details of the free baggage allowance on this segment.
                    { # Information about free baggage allowed on one segment of a trip.
                      "kilosPerPiece": 42, # The maximum number of kilos any one piece of baggage may weigh.
                      "pounds": 42, # The number of pounds of free baggage allowed.
                      "kind": "qpxexpress#freeBaggageAllowance", # Identifies this as free baggage object, allowed on one segment of a trip. Value: the fixed string qpxexpress#freeBaggageAllowance.
                      "pieces": 42, # The number of free pieces of baggage allowed.
                      "bagDescriptor": [ # A representation of a type of bag, such as an ATPCo subcode, Commercial Name, or other description.
                        { # Information about an item of baggage.
                          "count": 42, # How many of this type of bag will be checked on this flight.
                          "subcode": "A String", # The standard IATA subcode used to identify this optional service.
                          "kind": "qpxexpress#bagDescriptor", # Identifies this as a baggage object. Value: the fixed string qpxexpress#bagDescriptor.
                          "commercialName": "A String", # Provides the commercial name for an optional service.
                          "description": [ # A description of the baggage.
                            "A String",
                          ],
                        },
                      ],
                      "kilos": 42, # The maximum number of kilos all the free baggage together may weigh.
                    },
                  ],
                  "segmentId": "A String", # Unique identifier in the response of this segment.
                },
              ],
              "saleTotal": "A String", # Total per-passenger price (fare and tax) in the sale or equivalent currency.
              "passengers": { # The number and type of passengers. Unfortunately the definition of an infant, child, adult, and senior citizen varies across carriers and reservation systems. # The number of passengers to which this price applies.
                "kind": "qpxexpress#passengerCounts", # Identifies this as a passenger count object, representing the number of passengers. Value: the fixed string qpxexpress#passengerCounts.
                "infantInLapCount": 42, # The number of passengers that are infants travelling in the lap of an adult.
                "seniorCount": 42, # The number of passengers that are senior citizens.
                "infantInSeatCount": 42, # The number of passengers that are infants each assigned a seat.
                "childCount": 42, # The number of passengers that are children.
                "adultCount": 42, # The number of passengers that are adults.
              },
              "tax": [ # The taxes used to calculate the tax total per ticket.
                { # Tax information.
                  "kind": "qpxexpress#taxInfo", # Identifies this as a tax information object. Value: the fixed string qpxexpress#taxInfo.
                  "code": "A String", # The code to enter in the ticket's tax box.
                  "country": "A String", # For government charges, the country levying the charge.
                  "salePrice": "A String", # The price of the tax in the sales or equivalent currency.
                  "chargeType": "A String", # Whether this is a government charge or a carrier surcharge.
                  "id": "A String", # Identifier uniquely identifying this tax in a response. Not present for unnamed carrier surcharges.
                },
              ],
              "ptc": "A String", # The passenger type code for this pricing. An alphanumeric code used by a carrier to restrict fares to certain categories of passenger. For instance, a fare might be valid only for senior citizens.
              "saleFareTotal": "A String", # The total fare in the sale or equivalent currency.
              "baseFareTotal": "A String", # The total fare in the base fare currency (the currency of the country of origin). This element is only present when the sales currency and the currency of the country of commencement are different.
              "refundable": True or False, # Whether the fares on this pricing are refundable.
              "saleTaxTotal": "A String", # The taxes in the sale or equivalent currency.
              "latestTicketingTime": "A String", # The latest ticketing time for this pricing assuming the reservation occurs at ticketing time and there is no change in fares/rules. The time is local to the point of sale (POS).
            },
          ],
        },
      ],
      "kind": "qpxexpress#tripOptions", # Identifies this as a QPX Express trip response object, which consists of zero or more solutions. Value: the fixed string qpxexpress#tripOptions.
      "data": { # Detailed information about components found in the solutions of this response, including a trip's airport, city, taxes, airline, and aircraft. # Informational data global to list of solutions.
        "city": [ # The city that is either the origin or destination of part of a trip.
          { # Information about a city that might be useful to an end-user; typically the city of an airport.
            "country": "A String", # The two-character country code of the country the city is located in. For example, US for the United States of America.
            "kind": "qpxexpress#cityData", # Identifies this as a city, typically with one or more airports. Value: the fixed string qpxexpress#cityData.
            "code": "A String", # The IATA character ID of a city. For example, for Boston this is BOS.
            "name": "A String", # The full name of a city. An example would be: New York.
          },
        ],
        "kind": "qpxexpress#data", # Identifies this as QPX Express response resource, including a trip's airport, city, taxes, airline, and aircraft. Value: the fixed string qpxexpress#data.
        "tax": [ # The taxes due for flying between an origin and a destination.
          { # Tax data.
            "kind": "qpxexpress#taxData", # Identifies this as a tax data object, representing some tax. Value: the fixed string qpxexpress#taxData.
            "id": "A String", # An identifier uniquely identifying a tax in a response.
            "name": "A String", # The name of a tax.
          },
        ],
        "airport": [ # The airport of an origin or destination.
          { # An airport.
            "city": "A String", # The city code an airport is located in. For example, for JFK airport, this is NYC.
            "kind": "qpxexpress#airportData", # Identifies this as an airport object. Value: the fixed string qpxexpress#airportData.
            "code": "A String", # An airport's code. For example, for Boston Logan airport, this is BOS.
            "name": "A String", # The name of an airport. For example, for airport BOS the name is "Boston Logan International".
          },
        ],
        "aircraft": [ # The aircraft that is flying between an origin and destination.
          { # The make, model, and type of an aircraft.
            "kind": "qpxexpress#aircraftData", # Identifies this as an aircraftData object. Value: the fixed string qpxexpress#aircraftData
            "code": "A String", # The aircraft code. For example, for a Boeing 777 the code would be 777.
            "name": "A String", # The name of an aircraft, for example Boeing 777.
          },
        ],
        "carrier": [ # The airline carrier of the aircraft flying between an origin and destination. Allowed values are IATA carrier codes.
          { # Information about a carrier (ie. an airline, bus line, railroad, etc) that might be useful to display to an end-user.
            "kind": "qpxexpress#carrierData", # Identifies this as a kind of carrier (ie. an airline, bus line, railroad, etc). Value: the fixed string qpxexpress#carrierData.
            "code": "A String", # The IATA designator of a carrier (airline, etc). For example, for American Airlines, the code is AA.
            "name": "A String", # The long, full name of a carrier. For example: American Airlines.
          },
        ],
      },
      "requestId": "A String", # An identifier uniquely identifying this response.
    },
  }
google-api-python-client-1.5.5/docs/dyn/replicapool_v1beta1.html000066400000000000000000000043701300622755700246170ustar00rootroot00000000000000

Replica Pool API

Instance Methods

pools()

Returns the pools Resource.

replicas()

Returns the replicas Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/replicapool_v1beta1.pools.html000066400000000000000000002416101300622755700257520ustar00rootroot00000000000000

Replica Pool API . pools

Instance Methods

delete(projectName, zone, poolName, body)

Deletes a replica pool.

get(projectName, zone, poolName)

Gets information about a single replica pool.

insert(projectName, zone, body)

Inserts a new replica pool.

list(projectName, zone, pageToken=None, maxResults=None)

List all replica pools.

list_next(previous_request, previous_response)

Retrieves the next page of results.

resize(projectName, zone, poolName, numReplicas=None)

Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request.

updatetemplate(projectName, zone, poolName, body)

Update the template used by the pool.

Method Details

delete(projectName, zone, poolName, body) 
Deletes a replica pool.

Args:
  projectName: string, The project ID for this replica pool. (required)
  zone: string, The zone for this replica pool. (required)
  poolName: string, The name of the replica pool for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "abandonInstances": [ # If there are instances you would like to keep, you can specify them here. These instances won't be deleted, but the associated replica objects will be removed.
      "A String",
    ],
  }
get(projectName, zone, poolName) 
Gets information about a single replica pool.

Args:
  projectName: string, The project ID for this replica pool. (required)
  zone: string, The zone for this replica pool. (required)
  poolName: string, The name of the replica pool for this request. (required)

Returns:
  An object of the form:

    {
      "autoRestart": True or False, # Whether replicas in this pool should be restarted if they experience a failure. The default value is true.
      "resourceViews": [ # The list of resource views that should be updated with all the replicas that are managed by this pool.
        "A String",
      ],
      "description": "A String", # An optional description of the replica pool.
      "labels": [ # A list of labels to attach to this replica pool and all created virtual machines in this replica pool.
        { # A label to apply to this replica pool.
          "value": "A String", # The value of this label.
          "key": "A String", # The key for this label.
        },
      ],
      "targetPool": "A String", # Deprecated, please use target_pools instead.
      "baseInstanceName": "A String", # The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format -. The  postfix will be a four character alphanumeric identifier generated by the service.
          #
          # If this is not specified by the user, a random base instance name is generated by the service.
      "numReplicas": 42, # Deprecated! Use initial_num_replicas instead.
      "template": { # The template used for creating replicas in the pool. # The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts.
        "action": { # An action that gets executed during initialization of the replicas. # An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands.
          "timeoutMilliSeconds": 42, # If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds).
          "commands": [ # A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure.
            "A String",
          ],
          "envVariables": [ # A list of environment variables to use for the commands in this action.
            { # An environment variable to set for an action.
              "hidden": True or False, # Deprecated, do not use.
              "name": "A String", # The name of the environment variable.
              "value": "A String", # The value of the variable.
            },
          ],
        },
        "healthChecks": [ # A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool.
          {
            "description": "A String", # The description for this health check.
            "timeoutSec": 42, # How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds.
            "checkIntervalSec": 42, # How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds.
            "unhealthyThreshold": 42, # The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2.
            "healthyThreshold": 42, # The number of consecutive health check requests that need to succeed before the replica is considered healthy again. 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 localhost IP 127.0.0.1 will be used.
            "path": "A String", # The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck.
            "port": 42, # The TCP port for the health check requests.
            "name": "A String", # The name of this health check.
          },
        ],
        "version": "A String", # A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1.
        "vmParams": { # Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. # The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM.
          "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
            { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.
              "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be -
insert(projectName, zone, body) 
Inserts a new replica pool.

Args:
  projectName: string, The project ID for this replica pool. (required)
  zone: string, The zone for this replica pool. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "autoRestart": True or False, # Whether replicas in this pool should be restarted if they experience a failure. The default value is true.
    "resourceViews": [ # The list of resource views that should be updated with all the replicas that are managed by this pool.
      "A String",
    ],
    "description": "A String", # An optional description of the replica pool.
    "labels": [ # A list of labels to attach to this replica pool and all created virtual machines in this replica pool.
      { # A label to apply to this replica pool.
        "value": "A String", # The value of this label.
        "key": "A String", # The key for this label.
      },
    ],
    "targetPool": "A String", # Deprecated, please use target_pools instead.
    "baseInstanceName": "A String", # The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format -. The  postfix will be a four character alphanumeric identifier generated by the service.
        # 
        # If this is not specified by the user, a random base instance name is generated by the service.
    "numReplicas": 42, # Deprecated! Use initial_num_replicas instead.
    "template": { # The template used for creating replicas in the pool. # The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts.
      "action": { # An action that gets executed during initialization of the replicas. # An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands.
        "timeoutMilliSeconds": 42, # If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds).
        "commands": [ # A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure.
          "A String",
        ],
        "envVariables": [ # A list of environment variables to use for the commands in this action.
          { # An environment variable to set for an action.
            "hidden": True or False, # Deprecated, do not use.
            "name": "A String", # The name of the environment variable.
            "value": "A String", # The value of the variable.
          },
        ],
      },
      "healthChecks": [ # A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool.
        {
          "description": "A String", # The description for this health check.
          "timeoutSec": 42, # How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds.
          "checkIntervalSec": 42, # How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds.
          "unhealthyThreshold": 42, # The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2.
          "healthyThreshold": 42, # The number of consecutive health check requests that need to succeed before the replica is considered healthy again. 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 localhost IP 127.0.0.1 will be used.
          "path": "A String", # The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck.
          "port": 42, # The TCP port for the health check requests.
          "name": "A String", # The name of this health check.
        },
      ],
      "version": "A String", # A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1.
      "vmParams": { # Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. # The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM.
        "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
          { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.
            "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be --. The  postfix will be a four character alphanumeric identifier generated by the service.
          #
          # If this is not specified by the user, a random base instance name is generated by the service.
      "numReplicas": 42, # Deprecated! Use initial_num_replicas instead.
      "template": { # The template used for creating replicas in the pool. # The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts.
        "action": { # An action that gets executed during initialization of the replicas. # An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands.
          "timeoutMilliSeconds": 42, # If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds).
          "commands": [ # A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure.
            "A String",
          ],
          "envVariables": [ # A list of environment variables to use for the commands in this action.
            { # An environment variable to set for an action.
              "hidden": True or False, # Deprecated, do not use.
              "name": "A String", # The name of the environment variable.
              "value": "A String", # The value of the variable.
            },
          ],
        },
        "healthChecks": [ # A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool.
          {
            "description": "A String", # The description for this health check.
            "timeoutSec": 42, # How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds.
            "checkIntervalSec": 42, # How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds.
            "unhealthyThreshold": 42, # The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2.
            "healthyThreshold": 42, # The number of consecutive health check requests that need to succeed before the replica is considered healthy again. 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 localhost IP 127.0.0.1 will be used.
            "path": "A String", # The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck.
            "port": 42, # The TCP port for the health check requests.
            "name": "A String", # The name of this health check.
          },
        ],
        "version": "A String", # A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1.
        "vmParams": { # Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. # The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM.
          "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
            { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.
              "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be -
list(projectName, zone, pageToken=None, maxResults=None) 
List all replica pools.

Args:
  projectName: string, The project ID for this request. (required)
  zone: string, The zone for this replica pool. (required)
  pageToken: string, Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)

Returns:
  An object of the form:

    {
    "nextPageToken": "A String",
    "resources": [
      {
          "autoRestart": True or False, # Whether replicas in this pool should be restarted if they experience a failure. The default value is true.
          "resourceViews": [ # The list of resource views that should be updated with all the replicas that are managed by this pool.
            "A String",
          ],
          "description": "A String", # An optional description of the replica pool.
          "labels": [ # A list of labels to attach to this replica pool and all created virtual machines in this replica pool.
            { # A label to apply to this replica pool.
              "value": "A String", # The value of this label.
              "key": "A String", # The key for this label.
            },
          ],
          "targetPool": "A String", # Deprecated, please use target_pools instead.
          "baseInstanceName": "A String", # The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format -. The  postfix will be a four character alphanumeric identifier generated by the service.
              #
              # If this is not specified by the user, a random base instance name is generated by the service.
          "numReplicas": 42, # Deprecated! Use initial_num_replicas instead.
          "template": { # The template used for creating replicas in the pool. # The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts.
            "action": { # An action that gets executed during initialization of the replicas. # An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands.
              "timeoutMilliSeconds": 42, # If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds).
              "commands": [ # A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure.
                "A String",
              ],
              "envVariables": [ # A list of environment variables to use for the commands in this action.
                { # An environment variable to set for an action.
                  "hidden": True or False, # Deprecated, do not use.
                  "name": "A String", # The name of the environment variable.
                  "value": "A String", # The value of the variable.
                },
              ],
            },
            "healthChecks": [ # A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool.
              {
                "description": "A String", # The description for this health check.
                "timeoutSec": 42, # How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds.
                "checkIntervalSec": 42, # How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds.
                "unhealthyThreshold": 42, # The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2.
                "healthyThreshold": 42, # The number of consecutive health check requests that need to succeed before the replica is considered healthy again. 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 localhost IP 127.0.0.1 will be used.
                "path": "A String", # The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck.
                "port": 42, # The TCP port for the health check requests.
                "name": "A String", # The name of this health check.
              },
            ],
            "version": "A String", # A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1.
            "vmParams": { # Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. # The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM.
              "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
                { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.
                  "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be -
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.
resize(projectName, zone, poolName, numReplicas=None) 
Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request.

Args:
  projectName: string, The project ID for this replica pool. (required)
  zone: string, The zone for this replica pool. (required)
  poolName: string, The name of the replica pool for this request. (required)
  numReplicas: integer, The desired number of replicas to resize to. If this number is larger than the existing number of replicas, new replicas will be added. If the number is smaller, then existing replicas will be deleted.

Returns:
  An object of the form:

    {
      "autoRestart": True or False, # Whether replicas in this pool should be restarted if they experience a failure. The default value is true.
      "resourceViews": [ # The list of resource views that should be updated with all the replicas that are managed by this pool.
        "A String",
      ],
      "description": "A String", # An optional description of the replica pool.
      "labels": [ # A list of labels to attach to this replica pool and all created virtual machines in this replica pool.
        { # A label to apply to this replica pool.
          "value": "A String", # The value of this label.
          "key": "A String", # The key for this label.
        },
      ],
      "targetPool": "A String", # Deprecated, please use target_pools instead.
      "baseInstanceName": "A String", # The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format -. The  postfix will be a four character alphanumeric identifier generated by the service.
          #
          # If this is not specified by the user, a random base instance name is generated by the service.
      "numReplicas": 42, # Deprecated! Use initial_num_replicas instead.
      "template": { # The template used for creating replicas in the pool. # The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts.
        "action": { # An action that gets executed during initialization of the replicas. # An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands.
          "timeoutMilliSeconds": 42, # If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds).
          "commands": [ # A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure.
            "A String",
          ],
          "envVariables": [ # A list of environment variables to use for the commands in this action.
            { # An environment variable to set for an action.
              "hidden": True or False, # Deprecated, do not use.
              "name": "A String", # The name of the environment variable.
              "value": "A String", # The value of the variable.
            },
          ],
        },
        "healthChecks": [ # A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool.
          {
            "description": "A String", # The description for this health check.
            "timeoutSec": 42, # How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds.
            "checkIntervalSec": 42, # How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds.
            "unhealthyThreshold": 42, # The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2.
            "healthyThreshold": 42, # The number of consecutive health check requests that need to succeed before the replica is considered healthy again. 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 localhost IP 127.0.0.1 will be used.
            "path": "A String", # The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck.
            "port": 42, # The TCP port for the health check requests.
            "name": "A String", # The name of this health check.
          },
        ],
        "version": "A String", # A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1.
        "vmParams": { # Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. # The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM.
          "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
            { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.
              "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be -
updatetemplate(projectName, zone, poolName, body) 
Update the template used by the pool.

Args:
  projectName: string, The project ID for this replica pool. (required)
  zone: string, The zone for this replica pool. (required)
  poolName: string, The name of the replica pool for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The template used for creating replicas in the pool.
  "action": { # An action that gets executed during initialization of the replicas. # An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands.
    "timeoutMilliSeconds": 42, # If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds).
    "commands": [ # A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure.
      "A String",
    ],
    "envVariables": [ # A list of environment variables to use for the commands in this action.
      { # An environment variable to set for an action.
        "hidden": True or False, # Deprecated, do not use.
        "name": "A String", # The name of the environment variable.
        "value": "A String", # The value of the variable.
      },
    ],
  },
  "healthChecks": [ # A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool.
    {
      "description": "A String", # The description for this health check.
      "timeoutSec": 42, # How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds.
      "checkIntervalSec": 42, # How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds.
      "unhealthyThreshold": 42, # The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2.
      "healthyThreshold": 42, # The number of consecutive health check requests that need to succeed before the replica is considered healthy again. 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 localhost IP 127.0.0.1 will be used.
      "path": "A String", # The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck.
      "port": 42, # The TCP port for the health check requests.
      "name": "A String", # The name of this health check.
    },
  ],
  "version": "A String", # A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1.
  "vmParams": { # Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. # The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM.
    "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
      { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode.
        "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be -
google-api-python-client-1.5.5/docs/dyn/replicapool_v1beta1.replicas.html000066400000000000000000000216231300622755700264200ustar00rootroot00000000000000

Replica Pool API . replicas

Instance Methods

delete(projectName, zone, poolName, replicaName, body)

Deletes a replica from the pool.

get(projectName, zone, poolName, replicaName)

Gets information about a specific replica.

list(projectName, zone, poolName, maxResults=None, pageToken=None)

Lists all replicas in a pool.

list_next(previous_request, previous_response)

Retrieves the next page of results.

restart(projectName, zone, poolName, replicaName)

Restarts a replica in a pool.

Method Details

delete(projectName, zone, poolName, replicaName, body) 
Deletes a replica from the pool.

Args:
  projectName: string, The project ID for this request. (required)
  zone: string, The zone where the replica lives. (required)
  poolName: string, The replica pool name for this request. (required)
  replicaName: string, The name of the replica for this request. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "abandonInstance": True or False, # Whether the instance resource represented by this replica should be deleted or abandoned. If abandoned, the replica will be deleted but the virtual machine instance will remain. By default, this is set to false and the instance will be deleted along with the replica.
  }


Returns:
  An object of the form:

    { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas.
    "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
      "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned.
      "state": "A String", # [Output Only] The state of the Replica.
      "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
      "details": "A String", # [Output Only] Human-readable details about the current state of the replica
      "templateVersion": "A String", # [Output Only] The template used to build the replica.
    },
    "name": "A String", # [Output Only] The name of the Replica object.
    "selfLink": "A String", # [Output Only] The self-link of the Replica.
  }
get(projectName, zone, poolName, replicaName) 
Gets information about a specific replica.

Args:
  projectName: string, The project ID for this request. (required)
  zone: string, The zone where the replica lives. (required)
  poolName: string, The replica pool name for this request. (required)
  replicaName: string, The name of the replica for this request. (required)

Returns:
  An object of the form:

    { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas.
    "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
      "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned.
      "state": "A String", # [Output Only] The state of the Replica.
      "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
      "details": "A String", # [Output Only] Human-readable details about the current state of the replica
      "templateVersion": "A String", # [Output Only] The template used to build the replica.
    },
    "name": "A String", # [Output Only] The name of the Replica object.
    "selfLink": "A String", # [Output Only] The self-link of the Replica.
  }
list(projectName, zone, poolName, maxResults=None, pageToken=None) 
Lists all replicas in a pool.

Args:
  projectName: string, The project ID for this request. (required)
  zone: string, The zone where the replica pool lives. (required)
  poolName: string, The replica pool name for this request. (required)
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
  pageToken: string, Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String",
    "resources": [
      { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas.
        "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
          "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned.
          "state": "A String", # [Output Only] The state of the Replica.
          "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
          "details": "A String", # [Output Only] Human-readable details about the current state of the replica
          "templateVersion": "A String", # [Output Only] The template used to build the replica.
        },
        "name": "A String", # [Output Only] The name of the Replica object.
        "selfLink": "A String", # [Output Only] The self-link of the Replica.
      },
    ],
  }
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.
restart(projectName, zone, poolName, replicaName) 
Restarts a replica in a pool.

Args:
  projectName: string, The project ID for this request. (required)
  zone: string, The zone where the replica lives. (required)
  poolName: string, The replica pool name for this request. (required)
  replicaName: string, The name of the replica for this request. (required)

Returns:
  An object of the form:

    { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas.
    "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
      "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned.
      "state": "A String", # [Output Only] The state of the Replica.
      "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
      "details": "A String", # [Output Only] Human-readable details about the current state of the replica
      "templateVersion": "A String", # [Output Only] The template used to build the replica.
    },
    "name": "A String", # [Output Only] The name of the Replica object.
    "selfLink": "A String", # [Output Only] The self-link of the Replica.
  }
google-api-python-client-1.5.5/docs/dyn/replicapool_v1beta2.html000066400000000000000000000045321300622755700246200ustar00rootroot00000000000000

Google Compute Engine Instance Group Manager API

Instance Methods

instanceGroupManagers()

Returns the instanceGroupManagers Resource.

zoneOperations()

Returns the zoneOperations Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/replicapool_v1beta2.instanceGroupManagers.html000066400000000000000000001436131300622755700311220ustar00rootroot00000000000000

Google Compute Engine Instance Group Manager API . instanceGroupManagers

Instance Methods

abandonInstances(project, zone, instanceGroupManager, body)

Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.

delete(project, zone, instanceGroupManager)

Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.

deleteInstances(project, zone, instanceGroupManager, body)

Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.

get(project, zone, instanceGroupManager)

Returns the specified Instance Group Manager resource.

insert(project, zone, size, body)

Creates an instance group manager, as well as the instance group and the specified number of instances.

list(project, zone, maxResults=None, pageToken=None, filter=None)

Retrieves the list of Instance Group Manager resources contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

recreateInstances(project, zone, instanceGroupManager, body)

Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.

resize(project, zone, instanceGroupManager, size)

Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.

setInstanceTemplate(project, zone, instanceGroupManager, body)

Sets the instance template to use when creating new instances in this group. Existing instances are not affected.

setTargetPools(project, zone, instanceGroupManager, body)

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Method Details

abandonInstances(project, zone, instanceGroupManager, body) 
Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to abandon. For example:
        # { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
delete(project, zone, instanceGroupManager) 
Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, Name of the Instance Group Manager resource to delete. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
deleteInstances(project, zone, instanceGroupManager, body) 
Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # Names of instances to delete.
        # 
        # Example: 'instance-foo', 'instance-bar'
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
get(project, zone, instanceGroupManager) 
Returns the specified Instance Group Manager resource.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, Name of the instance resource to return. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
      "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
      "description": "A String", # An optional textual description of the instance group manager.
      "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
        {
          "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
          "actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
        },
      ],
      "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
        "A String",
      ],
      "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
      "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
      "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
      "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
      "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
      "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
      "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
      "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
    }
insert(project, zone, size, body) 
Creates an instance group manager, as well as the instance group and the specified number of instances.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  size: integer, Number of instances that should exist. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
    "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
    "description": "A String", # An optional textual description of the instance group manager.
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
      },
    ],
    "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
      "A String",
    ],
    "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
    "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
    "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
    "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
    "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
    "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
    "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
    "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
list(project, zone, maxResults=None, pageToken=None, filter=None) 
Retrieves the list of Instance Group Manager resources contained within the specified zone.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  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.
      { # An Instance Group Manager resource.
          "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
          "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
          "description": "A String", # An optional textual description of the instance group manager.
          "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
            {
              "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
              "actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
            },
          ],
          "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
            "A String",
          ],
          "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
          "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
          "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
          "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
          "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
          "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
          "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
          "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
        },
    ],
    "kind": "replicapool#instanceGroupManagerList", # 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.
recreateInstances(project, zone, instanceGroupManager, body) 
Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to recreate. For example:
        # { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
resize(project, zone, instanceGroupManager, size) 
Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  size: integer, Number of instances that should exist in this Instance Group Manager. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
setInstanceTemplate(project, zone, instanceGroupManager, body) 
Sets the instance template to use when creating new instances in this group. Existing instances are not affected.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # The full URL to an Instance Template from which all new instances will be created.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
setTargetPools(project, zone, instanceGroupManager, body) 
Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # A list of fully-qualified URLs to existing Target Pool resources. New instances in the Instance Group Manager will be added to the specified target pools; existing instances are not affected.
      "A String",
    ],
    "fingerprint": "A String", # The current fingerprint of the Instance Group Manager resource. If this does not match the server-side fingerprint of the resource, then the request will be rejected.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
google-api-python-client-1.5.5/docs/dyn/replicapool_v1beta2.zoneOperations.html000066400000000000000000000260671300622755700276450ustar00rootroot00000000000000

Google Compute Engine Instance Group Manager API . zoneOperations

Instance Methods

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

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", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
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 value is 500 and default value is 500.
  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.
      { # An operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
        "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] 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.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] Status of the operation.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "message": "A String", # [Output only] Optional human-readable details for this warning.
            "code": "A String", # [Output only] The warning type identifier for this warning.
            "data": [ # [Output only] Metadata for this warning in key:value format.
              {
                "value": "A String", # [Output Only] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "replicapool#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      },
    ],
    "kind": "replicapool#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.
google-api-python-client-1.5.5/docs/dyn/replicapoolupdater_v1beta1.html000066400000000000000000000045321300622755700262040ustar00rootroot00000000000000

Google Compute Engine Instance Group Updater API

Instance Methods

rollingUpdates()

Returns the rollingUpdates Resource.

zoneOperations()

Returns the zoneOperations Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html000066400000000000000000001140601300622755700311750ustar00rootroot00000000000000

Google Compute Engine Instance Group Updater API . rollingUpdates

Instance Methods

cancel(project, zone, rollingUpdate)

Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED.

get(project, zone, rollingUpdate)

Returns information about an update.

insert(project, zone, body)

Inserts and starts a new update.

list(project, zone, maxResults=None, pageToken=None, filter=None)

Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.

listInstanceUpdates(project, zone, rollingUpdate, maxResults=None, pageToken=None, filter=None)

Lists the current status for each instance within a given update.

listInstanceUpdates_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

pause(project, zone, rollingUpdate)

Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.

resume(project, zone, rollingUpdate)

Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.

rollback(project, zone, rollingUpdate)

Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK.

Method Details

cancel(project, zone, rollingUpdate) 
Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  rollingUpdate: string, The name of the update. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
  }
get(project, zone, rollingUpdate) 
Returns information about an update.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  rollingUpdate: string, The name of the update. (required)

Returns:
  An object of the form:

    { # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
      "status": "A String", # [Output Only] Status of the update. Possible values are:
          # - "ROLLING_FORWARD": The update is going forward.
          # - "ROLLING_BACK": The update is being rolled back.
          # - "PAUSED": The update is temporarily paused (inactive).
          # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
          # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
          # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
      "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
      "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
      "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
      "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
      "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
      "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
      "error": { # [Output Only] Errors that occurred during the rolling update.
        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
          {
            "message": "A String", # [Output Only] An optional, human-readable error message.
            "code": "A String", # [Output Only] The error type identifier for this error.
            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
          },
        ],
      },
      "policy": { # Parameters of the update process.
        "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
        "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
        "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
        "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
        "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
      },
      "progress": 42, # [Output Only] 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 update will be complete. This number should be monotonically increasing as the update progresses.
      "oldInstanceTemplate": "A String", # Fully-qualified URL of the instance template encountered while starting the update.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
      "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
      "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
    }
insert(project, zone, body) 
Inserts and starts a new update.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
    "status": "A String", # [Output Only] Status of the update. Possible values are:
        # - "ROLLING_FORWARD": The update is going forward.
        # - "ROLLING_BACK": The update is being rolled back.
        # - "PAUSED": The update is temporarily paused (inactive).
        # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
        # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
        # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
    "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
    "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
    "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
    "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
    "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
    "error": { # [Output Only] Errors that occurred during the rolling update.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "policy": { # Parameters of the update process.
      "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
      "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
      "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
      "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
      "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
    },
    "progress": 42, # [Output Only] 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 update will be complete. This number should be monotonically increasing as the update progresses.
    "oldInstanceTemplate": "A String", # Fully-qualified URL of the instance template encountered while starting the update.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
  }
list(project, zone, maxResults=None, pageToken=None, filter=None) 
Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  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:

    { # Response returned by List method.
    "nextPageToken": "A String", # A token used to continue a truncated list request.
    "items": [ # Collection of requested updates.
      { # The following represents a resource describing a single update (rollout) of a group of instances to the given template.
          "status": "A String", # [Output Only] Status of the update. Possible values are:
              # - "ROLLING_FORWARD": The update is going forward.
              # - "ROLLING_BACK": The update is being rolled back.
              # - "PAUSED": The update is temporarily paused (inactive).
              # - "ROLLED_OUT": The update is finished, all instances have been updated successfully.
              # - "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
              # - "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
          "kind": "replicapoolupdater#rollingUpdate", # [Output Only] Type of the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "user": "A String", # [Output Only] User who requested the update, for example: user@example.com.
          "instanceGroup": "A String", # Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
          "instanceTemplate": "A String", # Fully-qualified URL of an instance template to apply.
          "actionType": "A String", # Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
          "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the update.
          "error": { # [Output Only] Errors that occurred during the rolling update.
            "errors": [ # [Output Only] The array of errors encountered while processing this operation.
              {
                "message": "A String", # [Output Only] An optional, human-readable error message.
                "code": "A String", # [Output Only] The error type identifier for this error.
                "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              },
            ],
          },
          "policy": { # Parameters of the update process.
            "autoPauseAfterInstances": 42, # Number of instances to update before the updater pauses the rolling update.
            "instanceStartupTimeoutSec": 42, # The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
            "maxNumConcurrentInstances": 42, # The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
            "minInstanceUpdateTimeSec": 42, # The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
            "maxNumFailedInstances": 42, # The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
          },
          "progress": 42, # [Output Only] 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 update will be complete. This number should be monotonically increasing as the update progresses.
          "oldInstanceTemplate": "A String", # Fully-qualified URL of the instance template encountered while starting the update.
          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
          "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
          "instanceGroupManager": "A String", # Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
        },
    ],
    "kind": "replicapoolupdater#rollingUpdateList", # [Output Only] Type of the resource.
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
  }
listInstanceUpdates(project, zone, rollingUpdate, maxResults=None, pageToken=None, filter=None) 
Lists the current status for each instance within a given update.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  rollingUpdate: string, The name of the update. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  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:

    { # Response returned by ListInstanceUpdates method.
    "nextPageToken": "A String", # A token used to continue a truncated list request.
    "items": [ # Collection of requested instance updates.
      { # Update of a single instance.
        "status": "A String", # Status of the instance update. Possible values are:
            # - "PENDING": The instance update is pending execution.
            # - "ROLLING_FORWARD": The instance update is going forward.
            # - "ROLLING_BACK": The instance update is being rolled back.
            # - "PAUSED": The instance update is temporarily paused (inactive).
            # - "ROLLED_OUT": The instance update is finished, the instance is running the new template.
            # - "ROLLED_BACK": The instance update is finished, the instance has been reverted to the previous template.
            # - "CANCELLED": The instance update is paused and no longer can be resumed, undefined in which template the instance is running.
        "instance": "A String", # Fully-qualified URL of the instance being updated.
        "error": { # Errors that occurred during the instance update.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
      },
    ],
    "kind": "replicapoolupdater#instanceUpdateList", # [Output Only] Type of the resource.
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
  }
listInstanceUpdates_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.
pause(project, zone, rollingUpdate) 
Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  rollingUpdate: string, The name of the update. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
  }
resume(project, zone, rollingUpdate) 
Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  rollingUpdate: string, The name of the update. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
  }
rollback(project, zone, rollingUpdate) 
Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the update's target resides. (required)
  rollingUpdate: string, The name of the update. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
  }
google-api-python-client-1.5.5/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html000066400000000000000000000225571300622755700312310ustar00rootroot00000000000000

Google Compute Engine Instance Group Updater API . zoneOperations

Instance Methods

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

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", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
  }
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 value is 500 and default value is 500.
  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", # [Output Only] A token used to continue a truncate.
    "items": [ # [Output Only] The Operation resources.
      { # An operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
        "clientOperationId": "A String",
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides.
        "operationType": "A String",
        "httpErrorMessage": "A String",
        "progress": 42,
        "httpErrorStatusCode": 42,
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
        "warnings": [
          {
            "message": "A String", # [Output only] Optional human-readable details for this warning.
            "code": "A String", # [Output only] The warning type identifier for this warning.
            "data": [ # [Output only] Metadata for this warning in key:value format.
              {
                "value": "A String", # [Output Only] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String",
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
        "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides.
        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String",
        "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
        "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
      },
    ],
    "kind": "replicapoolupdater#operationList", # [Output Only] Type of resource. Always replicapoolupdater#operationList for OperationList resources.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] The fully qualified URL for 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.
google-api-python-client-1.5.5/docs/dyn/reseller_v1.customers.html000066400000000000000000000341721300622755700252340ustar00rootroot00000000000000

Enterprise Apps Reseller API . customers

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.
      "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
      "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.
    "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
    "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://admin.google.com/TransferToken. Optional.

Returns:
  An object of the form:

    { # JSON template for a customer.
      "customerDomain": "A String", # The domain name of the customer.
      "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
      "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.
    "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
    "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.
      "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
      "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.
    "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
    "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.
      "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
      "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.
    }
google-api-python-client-1.5.5/docs/dyn/reseller_v1.html000066400000000000000000000044071300622755700232070ustar00rootroot00000000000000

Enterprise Apps Reseller API

Instance Methods

customers()

Returns the customers Resource.

subscriptions()

Returns the subscriptions Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/reseller_v1.subscriptions.html000066400000000000000000001422051300622755700261140ustar00rootroot00000000000000

Enterprise Apps Reseller API . subscriptions

Instance Methods

activate(customerId, subscriptionId)

Activates a subscription previously suspended by the reseller

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

suspend(customerId, subscriptionId)

Suspends an active subscription

Method Details

activate(customerId, subscriptionId) 
Activates a subscription previously suspended by the reseller

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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this subscription.
      "customerId": "A String", # The id of the customer to whom the subscription belongs.
    }
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.
    "dealCode": "A String", # External name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used.
    "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.
      "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
    },
    "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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this 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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this 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.
  "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
}


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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this 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
      transfer_to_direct - Transfers a subscription directly to Google
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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this 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.
    },
    "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
    "customerDomain": "A String", # Primary domain name of the customer
    "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.
    },
    "skuId": "A String", # Name of the sku for which this subscription is purchased.
    "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.
      "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
    },
    "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
    "kind": "reseller#subscription", # Identifies the resource as a Subscription.
    "transferInfo": { # Transfer related information for the subscription.
      "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
      "minimumTransferableSeats": 42,
    },
    "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.
    "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
        # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
        # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
        # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
        # - TRIAL_ENDED - The customer's trial expired without a plan selected.
        # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
      "A String",
    ],
    "subscriptionId": "A String", # The id of the subscription.
    "billingMethod": "A String", # Billing method of this 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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this 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.
          },
          "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
          "customerDomain": "A String", # Primary domain name of the customer
          "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.
          },
          "skuId": "A String", # Name of the sku for which this subscription is purchased.
          "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.
            "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
          },
          "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
          "kind": "reseller#subscription", # Identifies the resource as a Subscription.
          "transferInfo": { # Transfer related information for the subscription.
            "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
            "minimumTransferableSeats": 42,
          },
          "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.
          "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
              # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
              # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
              # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
              # - TRIAL_ENDED - The customer's trial expired without a plan selected.
              # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
            "A String",
          ],
          "subscriptionId": "A String", # The id of the subscription.
          "billingMethod": "A String", # Billing method of this 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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this subscription.
      "customerId": "A String", # The id of the customer to whom the subscription belongs.
    }
suspend(customerId, subscriptionId) 
Suspends an active 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.
      },
      "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
      "customerDomain": "A String", # Primary domain name of the customer
      "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.
      },
      "skuId": "A String", # Name of the sku for which this subscription is purchased.
      "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.
        "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
      },
      "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
      "kind": "reseller#subscription", # Identifies the resource as a Subscription.
      "transferInfo": { # Transfer related information for the subscription.
        "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
        "minimumTransferableSeats": 42,
      },
      "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.
      "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
          # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
          # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
          # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
          # - TRIAL_ENDED - The customer's trial expired without a plan selected.
          # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
        "A String",
      ],
      "subscriptionId": "A String", # The id of the subscription.
      "billingMethod": "A String", # Billing method of this subscription.
      "customerId": "A String", # The id of the customer to whom the subscription belongs.
    }
google-api-python-client-1.5.5/docs/dyn/resourceviews_v1beta1.html000066400000000000000000000044251300622755700252140ustar00rootroot00000000000000

Resource Views API

Instance Methods

regionViews()

Returns the regionViews Resource.

zoneViews()

Returns the zoneViews Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/resourceviews_v1beta1.regionViews.html000066400000000000000000000273661300622755700275250ustar00rootroot00000000000000

Resource Views API . regionViews

Instance Methods

addresources(projectName, region, resourceViewName, body)

Add resources to the view.

delete(projectName, region, resourceViewName)

Delete a resource view.

get(projectName, region, resourceViewName)

Get the information of a resource view.

insert(projectName, region, body)

Create a resource view.

list(projectName, region, pageToken=None, maxResults=None)

List resource views.

list_next(previous_request, previous_response)

Retrieves the next page of results.

listresources(projectName, region, resourceViewName, pageToken=None, maxResults=None)

List the resources in the view.

listresources_next(previous_request, previous_response)

Retrieves the next page of results.

removeresources(projectName, region, resourceViewName, body)

Remove resources from the view.

Method Details

addresources(projectName, region, resourceViewName, body) 
Add resources to the view.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to add resources to the resource view.
    "resources": [ # The list of resources to be added.
      "A String",
    ],
  }
delete(projectName, region, resourceViewName) 
Delete a resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
get(projectName, region, resourceViewName) 
Get the information of a resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)

Returns:
  An object of the form:

    { # The resource view object.
      "kind": "resourceviews#resourceView", # Type of the resource.
      "numMembers": 42, # The total number of resources in the resource view.
      "description": "A String", # The detailed description of the resource view.
      "lastModified": "A String", # The last modified time of the view. Not supported yet.
      "labels": [ # The labels for events.
        { # The Label to be applied to the resource views.
          "value": "A String", # Value of the label.
          "key": "A String", # Key of the label.
        },
      ],
      "creationTime": "A String", # The creation time of the resource view.
      "members": [ # A list of all resources in the resource view.
        "A String",
      ],
      "id": "A String", # [Output Only] The ID of the resource view.
      "selfLink": "A String", # [Output Only] A self-link to the resource view.
      "name": "A String", # The name of the resource view.
    }
insert(projectName, region, body) 
Create a resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The resource view object.
    "kind": "resourceviews#resourceView", # Type of the resource.
    "numMembers": 42, # The total number of resources in the resource view.
    "description": "A String", # The detailed description of the resource view.
    "lastModified": "A String", # The last modified time of the view. Not supported yet.
    "labels": [ # The labels for events.
      { # The Label to be applied to the resource views.
        "value": "A String", # Value of the label.
        "key": "A String", # Key of the label.
      },
    ],
    "creationTime": "A String", # The creation time of the resource view.
    "members": [ # A list of all resources in the resource view.
      "A String",
    ],
    "id": "A String", # [Output Only] The ID of the resource view.
    "selfLink": "A String", # [Output Only] A self-link to the resource view.
    "name": "A String", # The name of the resource view.
  }


Returns:
  An object of the form:

    { # The response to a resource view insert request.
    "resource": { # The resource view object. # The resource view object inserted.
        "kind": "resourceviews#resourceView", # Type of the resource.
        "numMembers": 42, # The total number of resources in the resource view.
        "description": "A String", # The detailed description of the resource view.
        "lastModified": "A String", # The last modified time of the view. Not supported yet.
        "labels": [ # The labels for events.
          { # The Label to be applied to the resource views.
            "value": "A String", # Value of the label.
            "key": "A String", # Key of the label.
          },
        ],
        "creationTime": "A String", # The creation time of the resource view.
        "members": [ # A list of all resources in the resource view.
          "A String",
        ],
        "id": "A String", # [Output Only] The ID of the resource view.
        "selfLink": "A String", # [Output Only] A self-link to the resource view.
        "name": "A String", # The name of the resource view.
      },
  }
list(projectName, region, pageToken=None, maxResults=None) 
List resource views.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

Returns:
  An object of the form:

    { # The response to the list resource view request.
    "nextPageToken": "A String", # A token used for pagination.
    "resourceViews": [ # The list of resource views that meet the criteria.
      { # The resource view object.
          "kind": "resourceviews#resourceView", # Type of the resource.
          "numMembers": 42, # The total number of resources in the resource view.
          "description": "A String", # The detailed description of the resource view.
          "lastModified": "A String", # The last modified time of the view. Not supported yet.
          "labels": [ # The labels for events.
            { # The Label to be applied to the resource views.
              "value": "A String", # Value of the label.
              "key": "A String", # Key of the label.
            },
          ],
          "creationTime": "A String", # The creation time of the resource view.
          "members": [ # A list of all resources in the resource view.
            "A String",
          ],
          "id": "A String", # [Output Only] The ID of the resource view.
          "selfLink": "A String", # [Output Only] A self-link to the resource view.
          "name": "A String", # The name of the resource view.
        },
    ],
  }
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.
listresources(projectName, region, resourceViewName, pageToken=None, maxResults=None) 
List the resources in the view.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

Returns:
  An object of the form:

    { # The response to the list resource request.
    "nextPageToken": "A String", # A token used for pagination.
    "members": [ # The resources in the view.
      "A String",
    ],
  }
listresources_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.
removeresources(projectName, region, resourceViewName, body) 
Remove resources from the view.

Args:
  projectName: string, The project name of the resource view. (required)
  region: string, The region name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to remove resources from the resource view.
    "resources": [ # The list of resources to be removed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/resourceviews_v1beta1.zoneViews.html000066400000000000000000000273441300622755700272110ustar00rootroot00000000000000

Resource Views API . zoneViews

Instance Methods

addresources(projectName, zone, resourceViewName, body)

Add resources to the view.

delete(projectName, zone, resourceViewName)

Delete a resource view.

get(projectName, zone, resourceViewName)

Get the information of a zonal resource view.

insert(projectName, zone, body)

Create a resource view.

list(projectName, zone, pageToken=None, maxResults=None)

List resource views.

list_next(previous_request, previous_response)

Retrieves the next page of results.

listresources(projectName, zone, resourceViewName, pageToken=None, maxResults=None)

List the resources of the resource view.

listresources_next(previous_request, previous_response)

Retrieves the next page of results.

removeresources(projectName, zone, resourceViewName, body)

Remove resources from the view.

Method Details

addresources(projectName, zone, resourceViewName, body) 
Add resources to the view.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to add resources to the resource view.
    "resources": [ # The list of resources to be added.
      "A String",
    ],
  }
delete(projectName, zone, resourceViewName) 
Delete a resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
get(projectName, zone, resourceViewName) 
Get the information of a zonal resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)

Returns:
  An object of the form:

    { # The resource view object.
      "kind": "resourceviews#resourceView", # Type of the resource.
      "numMembers": 42, # The total number of resources in the resource view.
      "description": "A String", # The detailed description of the resource view.
      "lastModified": "A String", # The last modified time of the view. Not supported yet.
      "labels": [ # The labels for events.
        { # The Label to be applied to the resource views.
          "value": "A String", # Value of the label.
          "key": "A String", # Key of the label.
        },
      ],
      "creationTime": "A String", # The creation time of the resource view.
      "members": [ # A list of all resources in the resource view.
        "A String",
      ],
      "id": "A String", # [Output Only] The ID of the resource view.
      "selfLink": "A String", # [Output Only] A self-link to the resource view.
      "name": "A String", # The name of the resource view.
    }
insert(projectName, zone, body) 
Create a resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The resource view object.
    "kind": "resourceviews#resourceView", # Type of the resource.
    "numMembers": 42, # The total number of resources in the resource view.
    "description": "A String", # The detailed description of the resource view.
    "lastModified": "A String", # The last modified time of the view. Not supported yet.
    "labels": [ # The labels for events.
      { # The Label to be applied to the resource views.
        "value": "A String", # Value of the label.
        "key": "A String", # Key of the label.
      },
    ],
    "creationTime": "A String", # The creation time of the resource view.
    "members": [ # A list of all resources in the resource view.
      "A String",
    ],
    "id": "A String", # [Output Only] The ID of the resource view.
    "selfLink": "A String", # [Output Only] A self-link to the resource view.
    "name": "A String", # The name of the resource view.
  }


Returns:
  An object of the form:

    { # The response to an insert request.
    "resource": { # The resource view object. # The resource view object that has been inserted.
        "kind": "resourceviews#resourceView", # Type of the resource.
        "numMembers": 42, # The total number of resources in the resource view.
        "description": "A String", # The detailed description of the resource view.
        "lastModified": "A String", # The last modified time of the view. Not supported yet.
        "labels": [ # The labels for events.
          { # The Label to be applied to the resource views.
            "value": "A String", # Value of the label.
            "key": "A String", # Key of the label.
          },
        ],
        "creationTime": "A String", # The creation time of the resource view.
        "members": [ # A list of all resources in the resource view.
          "A String",
        ],
        "id": "A String", # [Output Only] The ID of the resource view.
        "selfLink": "A String", # [Output Only] A self-link to the resource view.
        "name": "A String", # The name of the resource view.
      },
  }
list(projectName, zone, pageToken=None, maxResults=None) 
List resource views.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

Returns:
  An object of the form:

    { # The response to a list request.
    "nextPageToken": "A String", # A token used for pagination.
    "resourceViews": [ # The result that contains all resource views that meet the criteria.
      { # The resource view object.
          "kind": "resourceviews#resourceView", # Type of the resource.
          "numMembers": 42, # The total number of resources in the resource view.
          "description": "A String", # The detailed description of the resource view.
          "lastModified": "A String", # The last modified time of the view. Not supported yet.
          "labels": [ # The labels for events.
            { # The Label to be applied to the resource views.
              "value": "A String", # Value of the label.
              "key": "A String", # Key of the label.
            },
          ],
          "creationTime": "A String", # The creation time of the resource view.
          "members": [ # A list of all resources in the resource view.
            "A String",
          ],
          "id": "A String", # [Output Only] The ID of the resource view.
          "selfLink": "A String", # [Output Only] A self-link to the resource view.
          "name": "A String", # The name of the resource view.
        },
    ],
  }
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.
listresources(projectName, zone, resourceViewName, pageToken=None, maxResults=None) 
List the resources of the resource view.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

Returns:
  An object of the form:

    { # The response to a list resource request.
    "nextPageToken": "A String", # A token used for pagination.
    "members": [ # The full URL of resources in the view.
      "A String",
    ],
  }
listresources_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.
removeresources(projectName, zone, resourceViewName, body) 
Remove resources from the view.

Args:
  projectName: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceViewName: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to remove resources from the resource view.
    "resources": [ # The list of resources to be removed.
      "A String",
    ],
  }
google-api-python-client-1.5.5/docs/dyn/resourceviews_v1beta2.html000066400000000000000000000044651300622755700252210ustar00rootroot00000000000000

Google Compute Engine Instance Groups API

Instance Methods

zoneOperations()

Returns the zoneOperations Resource.

zoneViews()

Returns the zoneViews Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/resourceviews_v1beta2.zoneOperations.html000066400000000000000000000260721300622755700302350ustar00rootroot00000000000000

Google Compute Engine Instance Groups API . zoneOperations

Instance Methods

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

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", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "resourceviews#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
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 value is 500 and default value is 500.
  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.
      { # An operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
        "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] 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.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] Status of the operation.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "message": "A String", # [Output only] Optional human-readable details for this warning.
            "code": "A String", # [Output only] The warning type identifier for this warning.
            "data": [ # [Output only] Metadata for this warning in key:value format.
              {
                "value": "A String", # [Output Only] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "resourceviews#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      },
    ],
    "kind": "resourceviews#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.
google-api-python-client-1.5.5/docs/dyn/resourceviews_v1beta2.zoneViews.html000066400000000000000000001023001300622755700271740ustar00rootroot00000000000000

Google Compute Engine Instance Groups API . zoneViews

Instance Methods

addResources(project, zone, resourceView, body)

Add resources to the view.

delete(project, zone, resourceView)

Delete a resource view.

get(project, zone, resourceView)

Get the information of a zonal resource view.

getService(project, zone, resourceView, resourceName=None)

Get the service information of a resource view or a resource.

insert(project, zone, body)

Create a resource view.

list(project, zone, pageToken=None, maxResults=None)

List resource views.

listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None)

List the resources of the resource view.

listResources_next(previous_request, previous_response)

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeResources(project, zone, resourceView, body)

Remove resources from the view.

setService(project, zone, resourceView, body)

Update the service information of a resource view or a resource.

Method Details

addResources(project, zone, resourceView, body) 
Add resources to the view.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to add resources to the resource view.
    "resources": [ # The list of resources to be added.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "resourceviews#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
delete(project, zone, resourceView) 
Delete a resource view.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "resourceviews#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
get(project, zone, resourceView) 
Get the information of a zonal resource view.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)

Returns:
  An object of the form:

    { # The resource view object.
      "size": 42, # The total number of resources in the resource view.
      "kind": "resourceviews#resourceView", # Type of the resource.
      "description": "A String", # The detailed description of the resource view.
      "labels": [ # The labels for events.
        { # The Label to be applied to the resource views.
          "value": "A String", # Value of the label.
          "key": "A String", # Key of the label.
        },
      ],
      "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
      "selfLink": "A String", # [Output Only] A self-link to the resource view.
      "fingerprint": "A String", # The fingerprint of the service endpoint information.
      "endpoints": [ # Services endpoint information.
        { # The service endpoint that may be started in a VM.
          "name": "A String", # The name of the service endpoint.
          "port": 42, # The port of the service endpoint.
        },
      ],
      "creationTimestamp": "A String", # The creation time of the resource view.
      "id": "A String", # [Output Only] The ID of the resource view.
      "resources": [ # A list of all resources in the resource view.
        "A String",
      ],
      "name": "A String", # The name of the resource view.
    }
getService(project, zone, resourceView, resourceName=None) 
Get the service information of a resource view or a resource.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)
  resourceName: string, The name of the resource if user wants to get the service information of the resource.

Returns:
  An object of the form:

    {
    "endpoints": [ # The service information.
      { # The service endpoint that may be started in a VM.
        "name": "A String", # The name of the service endpoint.
        "port": 42, # The port of the service endpoint.
      },
    ],
    "fingerprint": "A String", # The fingerprint of the service information.
  }
insert(project, zone, body) 
Create a resource view.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The resource view object.
    "size": 42, # The total number of resources in the resource view.
    "kind": "resourceviews#resourceView", # Type of the resource.
    "description": "A String", # The detailed description of the resource view.
    "labels": [ # The labels for events.
      { # The Label to be applied to the resource views.
        "value": "A String", # Value of the label.
        "key": "A String", # Key of the label.
      },
    ],
    "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
    "selfLink": "A String", # [Output Only] A self-link to the resource view.
    "fingerprint": "A String", # The fingerprint of the service endpoint information.
    "endpoints": [ # Services endpoint information.
      { # The service endpoint that may be started in a VM.
        "name": "A String", # The name of the service endpoint.
        "port": 42, # The port of the service endpoint.
      },
    ],
    "creationTimestamp": "A String", # The creation time of the resource view.
    "id": "A String", # [Output Only] The ID of the resource view.
    "resources": [ # A list of all resources in the resource view.
      "A String",
    ],
    "name": "A String", # The name of the resource view.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "resourceviews#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
list(project, zone, pageToken=None, maxResults=None) 
List resource views.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

Returns:
  An object of the form:

    { # The response to a list request.
    "nextPageToken": "A String", # A token used for pagination.
    "items": [ # The result that contains all resource views that meet the criteria.
      { # The resource view object.
          "size": 42, # The total number of resources in the resource view.
          "kind": "resourceviews#resourceView", # Type of the resource.
          "description": "A String", # The detailed description of the resource view.
          "labels": [ # The labels for events.
            { # The Label to be applied to the resource views.
              "value": "A String", # Value of the label.
              "key": "A String", # Key of the label.
            },
          ],
          "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
          "selfLink": "A String", # [Output Only] A self-link to the resource view.
          "fingerprint": "A String", # The fingerprint of the service endpoint information.
          "endpoints": [ # Services endpoint information.
            { # The service endpoint that may be started in a VM.
              "name": "A String", # The name of the service endpoint.
              "port": 42, # The port of the service endpoint.
            },
          ],
          "creationTimestamp": "A String", # The creation time of the resource view.
          "id": "A String", # [Output Only] The ID of the resource view.
          "resources": [ # A list of all resources in the resource view.
            "A String",
          ],
          "name": "A String", # The name of the resource view.
        },
    ],
    "kind": "resourceviews#zoneViewsList", # Type of resource.
    "selfLink": "A String", # Server defined URL for this resource (output only).
  }
listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None) 
List the resources of the resource view.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)
  listState: string, The state of the instance to list. By default, it lists all instances.
    Allowed values
      ALL - 
      RUNNING - 
  format: string, The requested format of the return value. It can be URL or URL_PORT. A JSON object will be included in the response based on the format. The default format is NONE, which results in no JSON in the response.
    Allowed values
      NONE - 
      URL - 
      URL_PORT - 
  maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)
  pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
  serviceName: string, The service name to return in the response. It is optional and if it is not set, all the service end points will be returned.

Returns:
  An object of the form:

    { # The response to a list resource request.
    "nextPageToken": "A String", # A token used for pagination.
    "items": [ # The formatted JSON that is requested by the user.
      { # The list response item that contains the resource and end points information.
        "endpoints": { # The list of service end points on the resource.
          "a_key": [ # The name of the service end point.
            42,
          ],
        },
        "resource": "A String", # The full URL of the resource.
      },
    ],
    "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
  }
listResources_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.
removeResources(project, zone, resourceView, body) 
Remove resources from the view.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to remove resources from the resource view.
    "resources": [ # The list of resources to be removed.
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "resourceviews#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
setService(project, zone, resourceView, body) 
Update the service information of a resource view or a resource.

Args:
  project: string, The project name of the resource view. (required)
  zone: string, The zone name of the resource view. (required)
  resourceView: string, The name of the resource view. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceName": "A String", # The name of the resource if user wants to update the service information of the resource.
    "endpoints": [ # The service information to be updated.
      { # The service endpoint that may be started in a VM.
        "name": "A String", # The name of the service endpoint.
        "port": 42, # The port of the service endpoint.
      },
    ],
    "fingerprint": "A String", # Fingerprint of the service information; a hash of the contents. This field is used for optimistic locking when updating the service entries.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "progress": 42, # [Output only] 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.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "resourceviews#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1.html000066400000000000000000000041571300622755700242450ustar00rootroot00000000000000

Google Cloud RuntimeConfig API

Instance Methods

operations()

Returns the operations Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1.operations.html000066400000000000000000000265541300622755700264340ustar00rootroot00000000000000

Google Cloud RuntimeConfig API . operations

Instance Methods

cancel(name, body, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server

delete(name, x__xgafv=None)

Deletes a long-running operation. This method indicates that the client is

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, body, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation.  The server
makes a best effort to cancel the operation, but success is not
guaranteed.  If the server doesn't support this method, it returns
`google.rpc.Code.UNIMPLEMENTED`.  Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to `Code.CANCELLED`.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for Operations.CancelOperation.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
`google.rpc.Code.UNIMPLEMENTED`.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding below allows API services to override the binding
to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The name of the operation collection. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "nextPageToken": "A String", # The standard List next-page token.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If true, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should have the format of `operations/some/unique/name`.
        "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1beta1.html000066400000000000000000000041631300622755700251570ustar00rootroot00000000000000

Google Cloud RuntimeConfig API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1beta1.projects.configs.html000066400000000000000000000327311300622755700304400ustar00rootroot00000000000000

Google Cloud RuntimeConfig API . projects . configs

Instance Methods

operations()

Returns the operations Resource.

variables()

Returns the variables Resource.

waiters()

Returns the waiters Resource.

create(parent=None, body, requestId=None, x__xgafv=None)

Creates a new RuntimeConfig resource. The configuration name must be

delete(name=None, x__xgafv=None)

Deletes a RuntimeConfig resource.

get(name=None, x__xgafv=None)

Gets information about a RuntimeConfig resource.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists all the RuntimeConfig resources within project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name=None, body, x__xgafv=None)

Updates a RuntimeConfig resource. The configuration must exist beforehand.

Method Details

create(parent=None, body, requestId=None, x__xgafv=None) 
Creates a new RuntimeConfig resource. The configuration name must be
unique within project.

Args:
  parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
for this request, in the format `projects/[PROJECT_ID]`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
      # service. A RuntimeConfig resource consists of metadata and a hierarchy of
      # variables.
    "description": "A String", # An optional description of the RuntimeConfig object.
        # The length of the description must be less than 256 bytes.
    "name": "A String", # The resource name of a runtime config. The name must have the format:
        # 
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]
        # 
        # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
        # arbitrary name that matches RFC 1035 segment specification. The length of
        # `[CONFIG_NAME]` must be less than 64 bytes.
        # 
        # You pick the RuntimeConfig resource name, but the server will validate that
        # the name adheres to this format. After you create the resource, you cannot
        # change the resource's name.
  }

  requestId: string, An optional unique request_id. If server receives two Create requests with
the same request_id then second request will be ignored and the resource
stored in the backend will be returned. Empty request_id fields are
ignored.
It is responsibility of the client to ensure uniqueness of the request_id
strings.
The strings are limited to 64 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
        # service. A RuntimeConfig resource consists of metadata and a hierarchy of
        # variables.
      "description": "A String", # An optional description of the RuntimeConfig object.
          # The length of the description must be less than 256 bytes.
      "name": "A String", # The resource name of a runtime config. The name must have the format:
          #
          #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]
          #
          # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
          # arbitrary name that matches RFC 1035 segment specification. The length of
          # `[CONFIG_NAME]` must be less than 64 bytes.
          #
          # You pick the RuntimeConfig resource name, but the server will validate that
          # the name adheres to this format. After you create the resource, you cannot
          # change the resource's name.
    }
delete(name=None, x__xgafv=None) 
Deletes a RuntimeConfig resource.

Args:
  name: string, The RuntimeConfig resource to delete, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name=None, x__xgafv=None) 
Gets information about a RuntimeConfig resource.

Args:
  name: string, The name of the RuntimeConfig resource to retrieve, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
        # service. A RuntimeConfig resource consists of metadata and a hierarchy of
        # variables.
      "description": "A String", # An optional description of the RuntimeConfig object.
          # The length of the description must be less than 256 bytes.
      "name": "A String", # The resource name of a runtime config. The name must have the format:
          #
          #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]
          #
          # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
          # arbitrary name that matches RFC 1035 segment specification. The length of
          # `[CONFIG_NAME]` must be less than 64 bytes.
          #
          # You pick the RuntimeConfig resource name, but the server will validate that
          # the name adheres to this format. After you create the resource, you cannot
          # change the resource's name.
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
Lists all the RuntimeConfig resources within project.

Args:
  parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
for this request, in the format `projects/[PROJECT_ID]`. (required)
  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.

Returns:
  An object of the form:

    { # `ListConfigs()` returns the following response. The order of returned
      # objects is arbitrary; that is, it is not ordered in any particular way.
    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
        # If the number of results is larger than `pageSize`, use the `nextPageToken`
        # as a value for the query parameter `pageToken` in the next list request.
        # Subsequent list requests will have their own `nextPageToken` to continue
        # paging through the results
    "configs": [ # A list of the configurations in the project. The order of returned
        # objects is arbitrary; that is, it is not ordered in any particular way.
      { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
            # service. A RuntimeConfig resource consists of metadata and a hierarchy of
            # variables.
          "description": "A String", # An optional description of the RuntimeConfig object.
              # The length of the description must be less than 256 bytes.
          "name": "A String", # The resource name of a runtime config. The name must have the format:
              #
              #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]
              #
              # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
              # arbitrary name that matches RFC 1035 segment specification. The length of
              # `[CONFIG_NAME]` must be less than 64 bytes.
              #
              # You pick the RuntimeConfig resource name, but the server will validate that
              # the name adheres to this format. After you create the resource, you cannot
              # change the resource's name.
        },
    ],
  }
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(name=None, body, x__xgafv=None) 
Updates a RuntimeConfig resource. The configuration must exist beforehand.

Args:
  name: string, The name of the RuntimeConfig resource to update, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
      # service. A RuntimeConfig resource consists of metadata and a hierarchy of
      # variables.
    "description": "A String", # An optional description of the RuntimeConfig object.
        # The length of the description must be less than 256 bytes.
    "name": "A String", # The resource name of a runtime config. The name must have the format:
        # 
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]
        # 
        # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
        # arbitrary name that matches RFC 1035 segment specification. The length of
        # `[CONFIG_NAME]` must be less than 64 bytes.
        # 
        # You pick the RuntimeConfig resource name, but the server will validate that
        # the name adheres to this format. After you create the resource, you cannot
        # change the resource's name.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
        # service. A RuntimeConfig resource consists of metadata and a hierarchy of
        # variables.
      "description": "A String", # An optional description of the RuntimeConfig object.
          # The length of the description must be less than 256 bytes.
      "name": "A String", # The resource name of a runtime config. The name must have the format:
          #
          #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]
          #
          # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
          # arbitrary name that matches RFC 1035 segment specification. The length of
          # `[CONFIG_NAME]` must be less than 64 bytes.
          #
          # You pick the RuntimeConfig resource name, but the server will validate that
          # the name adheres to this format. After you create the resource, you cannot
          # change the resource's name.
    }
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1beta1.projects.configs.operations.html000066400000000000000000000161221300622755700326160ustar00rootroot00000000000000

Google Cloud RuntimeConfig API . projects . configs . operations

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this

Method Details

get(name, x__xgafv=None) 
Gets the latest state of a long-running operation.  Clients can use this
method to poll the operation result at intervals as recommended by the API
service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html000066400000000000000000000604301300622755700324040ustar00rootroot00000000000000

Google Cloud RuntimeConfig API . projects . configs . variables

Instance Methods

create(parent=None, body, requestId=None, x__xgafv=None)

Creates a variable within the given configuration. You cannot create

delete(name=None, recursive=None, x__xgafv=None)

Deletes a variable or multiple variables.

get(name=None, x__xgafv=None)

Gets information about a single variable.

list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists variables within given a configuration, matching any provided filters.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name=None, body, x__xgafv=None)

Updates an existing variable with a new value.

watch(name=None, body, x__xgafv=None)

Watches a specific variable and waits for a change in the variable's value.

Method Details

create(parent=None, body, requestId=None, x__xgafv=None) 
Creates a variable within the given configuration. You cannot create
a variable with a name that is a prefix of an existing variable name, or a
name that has an existing variable name as a prefix.

To learn more about creating a variable, read the
[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)
documentation.

Args:
  parent: string, The path to the RutimeConfig resource that this variable should belong to.
The configuration must exist beforehand; the path must by in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a single variable within a RuntimeConfig resource.
    # The name denotes the hierarchical variable name. For example,
    # `ports/serving_port` is a valid variable name. The variable value is an
    # opaque string and only leaf variables can have values (that is, variables
    # that do not have any child variables).
  "text": "A String", # The textual value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted.
      # NB: Only one of value and string_value can be set at the same time.
  "updateTime": "A String", # [Output Only] The time of the last variable update.
  "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
      # the outcome of the `variables().watch` call and is visible through the
      # `get` and `list` calls.
  "value": "A String", # The binary value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted. The value must be
      # Base64 encoded.
      # NB: Only one of value and string_value can be set at the same time.
  "name": "A String", # The name of the variable resource, in the format:
      # 
      #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
      # 
      # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
      # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
      # file path naming.
      # 
      # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
      # dashes. Slashes are used as path element separators and are not part of the
      # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
      # non-slash character. Multiple slashes are coalesced into single slash
      # character. Each path segment should follow RFC 1035 segment specification.
      # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
      # 
      # Once you create a variable, you cannot change the variable name.
}

  requestId: string, An optional unique request_id. If server receives two Create requests with
the same request_id then second request will be ignored and the resource
stored in the backend will be returned. Empty request_id fields are
ignored.
It is responsibility of the client to ensure uniqueness of the request_id
strings.
The strings are limited to 64 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The textual value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted.
        # NB: Only one of value and string_value can be set at the same time.
    "updateTime": "A String", # [Output Only] The time of the last variable update.
    "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
        # the outcome of the `variables().watch` call and is visible through the
        # `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # Base64 encoded.
        # NB: Only one of value and string_value can be set at the same time.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should follow RFC 1035 segment specification.
        # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
        #
        # Once you create a variable, you cannot change the variable name.
  }
delete(name=None, recursive=None, x__xgafv=None) 
Deletes a variable or multiple variables.

If you specify a variable name, then that variable is deleted. If you
specify a prefix and `recursive` is true, then all variables with that
prefix are deleted. You must set a `recursive` to true if you delete
variables by prefix.

Args:
  name: string, The name of the variable to delete, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
  recursive: boolean, Set to `true` to recursively delete multiple variables with the same
prefix.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name=None, x__xgafv=None) 
Gets information about a single variable.

Args:
  name: string, The name of the variable to return, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The textual value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted.
        # NB: Only one of value and string_value can be set at the same time.
    "updateTime": "A String", # [Output Only] The time of the last variable update.
    "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
        # the outcome of the `variables().watch` call and is visible through the
        # `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # Base64 encoded.
        # NB: Only one of value and string_value can be set at the same time.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should follow RFC 1035 segment specification.
        # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
        #
        # Once you create a variable, you cannot change the variable name.
  }
list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists variables within given a configuration, matching any provided filters.
This only lists variable names, not the values.

Args:
  parent: string, The path to the RuntimeConfig resource for which you want to list variables.
The configuration must exist beforehand; the path must by in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.
  filter: string, Filters variables by matching the specified filter. For example:

`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `ListVariables()` method.
    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
        # If the number of results is larger than `pageSize`, use the `nextPageToken`
        # as a value for the query parameter `pageToken` in the next list request.
        # Subsequent list requests will have their own `nextPageToken` to continue
        # paging through the results
    "variables": [ # A list of variables and their values. The order of returned variable
        # objects is arbitrary.
      { # Describes a single variable within a RuntimeConfig resource.
          # The name denotes the hierarchical variable name. For example,
          # `ports/serving_port` is a valid variable name. The variable value is an
          # opaque string and only leaf variables can have values (that is, variables
          # that do not have any child variables).
        "text": "A String", # The textual value of the variable. The length of the value must be less
            # than 4096 bytes. Empty values are also accepted.
            # NB: Only one of value and string_value can be set at the same time.
        "updateTime": "A String", # [Output Only] The time of the last variable update.
        "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
            # the outcome of the `variables().watch` call and is visible through the
            # `get` and `list` calls.
        "value": "A String", # The binary value of the variable. The length of the value must be less
            # than 4096 bytes. Empty values are also accepted. The value must be
            # Base64 encoded.
            # NB: Only one of value and string_value can be set at the same time.
        "name": "A String", # The name of the variable resource, in the format:
            #
            #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
            #
            # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
            # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
            # file path naming.
            #
            # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
            # dashes. Slashes are used as path element separators and are not part of the
            # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
            # non-slash character. Multiple slashes are coalesced into single slash
            # character. Each path segment should follow RFC 1035 segment specification.
            # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
            #
            # Once you create a variable, you cannot change the variable name.
      },
    ],
  }
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(name=None, body, x__xgafv=None) 
Updates an existing variable with a new value.

Args:
  name: string, The name of the variable to update, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a single variable within a RuntimeConfig resource.
    # The name denotes the hierarchical variable name. For example,
    # `ports/serving_port` is a valid variable name. The variable value is an
    # opaque string and only leaf variables can have values (that is, variables
    # that do not have any child variables).
  "text": "A String", # The textual value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted.
      # NB: Only one of value and string_value can be set at the same time.
  "updateTime": "A String", # [Output Only] The time of the last variable update.
  "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
      # the outcome of the `variables().watch` call and is visible through the
      # `get` and `list` calls.
  "value": "A String", # The binary value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted. The value must be
      # Base64 encoded.
      # NB: Only one of value and string_value can be set at the same time.
  "name": "A String", # The name of the variable resource, in the format:
      # 
      #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
      # 
      # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
      # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
      # file path naming.
      # 
      # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
      # dashes. Slashes are used as path element separators and are not part of the
      # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
      # non-slash character. Multiple slashes are coalesced into single slash
      # character. Each path segment should follow RFC 1035 segment specification.
      # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
      # 
      # Once you create a variable, you cannot change the variable name.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The textual value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted.
        # NB: Only one of value and string_value can be set at the same time.
    "updateTime": "A String", # [Output Only] The time of the last variable update.
    "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
        # the outcome of the `variables().watch` call and is visible through the
        # `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # Base64 encoded.
        # NB: Only one of value and string_value can be set at the same time.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should follow RFC 1035 segment specification.
        # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
        #
        # Once you create a variable, you cannot change the variable name.
  }
watch(name=None, body, x__xgafv=None) 
Watches a specific variable and waits for a change in the variable's value.
When there is a change, this method returns the new value or times out.

If a variable is deleted while being watched, the `variableState` state is
set to `DELETED` and the method returns the last known variable `value`.

If you set the deadline for watching to a larger value than internal timeout
(60 seconds), the current variable value is returned and the `variableState`
will be `VARIABLE_STATE_UNSPECIFIED`.

To learn more about creating a watcher, read the
[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)
documentation.

Args:
  name: string, The name of the variable to watch, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the `WatchVariable()` method.
    "newerThan": "A String", # If specified, checks the current timestamp of the variable and if the
        # current timestamp is newer than `newerThan` timestamp, the method returns
        # immediately.
        # 
        # If not specified or the variable has an older timestamp, the watcher waits
        # for a the value to change before returning.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The textual value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted.
        # NB: Only one of value and string_value can be set at the same time.
    "updateTime": "A String", # [Output Only] The time of the last variable update.
    "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
        # the outcome of the `variables().watch` call and is visible through the
        # `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # Base64 encoded.
        # NB: Only one of value and string_value can be set at the same time.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should follow RFC 1035 segment specification.
        # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
        #
        # Once you create a variable, you cannot change the variable name.
  }
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html000066400000000000000000001170121300622755700321110ustar00rootroot00000000000000

Google Cloud RuntimeConfig API . projects . configs . waiters

Instance Methods

create(parent=None, body, requestId=None, x__xgafv=None)

Creates a Waiter resource. This operation returns a long-running Operation

delete(name=None, x__xgafv=None)

Deletes the waiter with the specified name.

get(name=None, x__xgafv=None)

Gets information about a single waiter.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

List waiters within the given configuration.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(parent=None, body, requestId=None, x__xgafv=None) 
Creates a Waiter resource. This operation returns a long-running Operation
resource which can be polled for completion. However, a waiter with the
given name will exist (and can be retrieved) prior to the operation
completing. If the operation fails, the failed Waiter resource will
still exist and must be deleted prior to subsequent creation attempts.

Args:
  parent: string, The path to the configuration that will own the waiter.
The configuration must exist beforehand; the path must by in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Waiter resource waits for some end condition within a RuntimeConfig resource
      # to be met before it returns. For example, assume you have a distributed
      # system where each node writes to a Variable resource indidicating the node's
      # readiness as part of the startup process.
      # 
      # You then configure a Waiter resource with the success condition set to wait
      # until some number of nodes have checked in. Afterwards, your application
      # runs some arbitrary code after the condition has been met and the waiter
      # returns successfully.
      # 
      # Once created, a Waiter resource is immutable.
      # 
      # To learn more about using waiters, read the
      # [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
      # documentation.
    "name": "A String", # The name of the Waiter resource, in the format:
        # 
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
        # 
        # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
        # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
        # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
        # of `[WAITER_NAME]` must be less than 64 bytes.
        # 
        # After you create a Waiter resource, you cannot change the resource name.
    "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
        # set to `true` and the `error` value will remain unset. The failure condition
        # takes precedence over the success condition. If both conditions are met, a
        # failure will be indicated.
      "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
          # met when the number of variables under a specified path prefix reaches a
          # predefined number. For example, if you set a Cardinality condition where
          # the `path` is set to `/foo` and the number of paths is set to 2, the
          # following variables would meet the condition in a RuntimeConfig resource:
          #
          # + `/foo/variable1 = "value1"`
          # + `/foo/variable2 = "value2"`
          # + `/bar/variable3 = "value3"`
          #
          # It would not would not satisify the same condition with the `number` set to
          # 3, however, because there is only 2 paths that start with `/foo`.
          # Cardinality conditions are recursive; all subtrees under the specific
          # path prefix are counted.
        "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
        "number": 42, # The number variables under the `path` that must exist to meet this
            # condition. Defaults to 1 if not specified.
      },
    },
    "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
        # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
        # The failure condition takes precedence over the success condition. If both
        # conditions are met, a failure will be indicated. This value is optional; if
        # no failure condition is set, the only failure scenario will be a timeout.
      "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
          # met when the number of variables under a specified path prefix reaches a
          # predefined number. For example, if you set a Cardinality condition where
          # the `path` is set to `/foo` and the number of paths is set to 2, the
          # following variables would meet the condition in a RuntimeConfig resource:
          #
          # + `/foo/variable1 = "value1"`
          # + `/foo/variable2 = "value2"`
          # + `/bar/variable3 = "value3"`
          #
          # It would not would not satisify the same condition with the `number` set to
          # 3, however, because there is only 2 paths that start with `/foo`.
          # Cardinality conditions are recursive; all subtrees under the specific
          # path prefix are counted.
        "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
        "number": 42, # The number variables under the `path` that must exist to meet this
            # condition. Defaults to 1 if not specified.
      },
    },
    "done": True or False, # [Output Only] If the value is `false`, it means the waiter is still waiting
        # for one of its conditions to be met.
        # 
        # If true, the waiter has finished. If the waiter finished due to a timeout
        # or failure, `error` will be set.
    "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
        # the instant that `waiters().create` method is called. If this time elapses
        # before the success or failure conditions are met, the waiter fails and sets
        # the `error` code to `DEADLINE_EXCEEDED`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # [Output Only] If the waiter ended due to a failure or timeout, this value
        # will be set.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "createTime": "A String", # [Output Only] The instant at which this Waiter resource was created. Adding
        # the value of `timeout` to this instant yields the timeout deadline for the
        # waiter.
  }

  requestId: string, An optional unique request_id. If server receives two Create requests with
the same request_id then second request will be ignored and information
stored in the backend will be returned. Empty request_id fields are
ignored.
It is responsibility of the client to ensure uniqueness of the request_id
strings.
The strings are limited to 64 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
delete(name=None, x__xgafv=None) 
Deletes the waiter with the specified name.

Args:
  name: string, The Waiter resource to delete, in the format:

 `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name=None, x__xgafv=None) 
Gets information about a single waiter.

Args:
  name: string, The fully-qualified name of the Waiter resource object to retrieve, in the
format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Waiter resource waits for some end condition within a RuntimeConfig resource
        # to be met before it returns. For example, assume you have a distributed
        # system where each node writes to a Variable resource indidicating the node's
        # readiness as part of the startup process.
        #
        # You then configure a Waiter resource with the success condition set to wait
        # until some number of nodes have checked in. Afterwards, your application
        # runs some arbitrary code after the condition has been met and the waiter
        # returns successfully.
        #
        # Once created, a Waiter resource is immutable.
        #
        # To learn more about using waiters, read the
        # [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
        # documentation.
      "name": "A String", # The name of the Waiter resource, in the format:
          #
          #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
          #
          # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
          # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
          # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
          # of `[WAITER_NAME]` must be less than 64 bytes.
          #
          # After you create a Waiter resource, you cannot change the resource name.
      "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
          # set to `true` and the `error` value will remain unset. The failure condition
          # takes precedence over the success condition. If both conditions are met, a
          # failure will be indicated.
        "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
            # met when the number of variables under a specified path prefix reaches a
            # predefined number. For example, if you set a Cardinality condition where
            # the `path` is set to `/foo` and the number of paths is set to 2, the
            # following variables would meet the condition in a RuntimeConfig resource:
            #
            # + `/foo/variable1 = "value1"`
            # + `/foo/variable2 = "value2"`
            # + `/bar/variable3 = "value3"`
            #
            # It would not would not satisify the same condition with the `number` set to
            # 3, however, because there is only 2 paths that start with `/foo`.
            # Cardinality conditions are recursive; all subtrees under the specific
            # path prefix are counted.
          "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
          "number": 42, # The number variables under the `path` that must exist to meet this
              # condition. Defaults to 1 if not specified.
        },
      },
      "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
          # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
          # The failure condition takes precedence over the success condition. If both
          # conditions are met, a failure will be indicated. This value is optional; if
          # no failure condition is set, the only failure scenario will be a timeout.
        "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
            # met when the number of variables under a specified path prefix reaches a
            # predefined number. For example, if you set a Cardinality condition where
            # the `path` is set to `/foo` and the number of paths is set to 2, the
            # following variables would meet the condition in a RuntimeConfig resource:
            #
            # + `/foo/variable1 = "value1"`
            # + `/foo/variable2 = "value2"`
            # + `/bar/variable3 = "value3"`
            #
            # It would not would not satisify the same condition with the `number` set to
            # 3, however, because there is only 2 paths that start with `/foo`.
            # Cardinality conditions are recursive; all subtrees under the specific
            # path prefix are counted.
          "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
          "number": 42, # The number variables under the `path` that must exist to meet this
              # condition. Defaults to 1 if not specified.
        },
      },
      "done": True or False, # [Output Only] If the value is `false`, it means the waiter is still waiting
          # for one of its conditions to be met.
          #
          # If true, the waiter has finished. If the waiter finished due to a timeout
          # or failure, `error` will be set.
      "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
          # the instant that `waiters().create` method is called. If this time elapses
          # before the success or failure conditions are met, the waiter fails and sets
          # the `error` code to `DEADLINE_EXCEEDED`.
      "error": { # The `Status` type defines a logical error model that is suitable for different # [Output Only] If the waiter ended due to a failure or timeout, this value
          # will be set.
          # programming environments, including REST APIs and RPC APIs. It is used by
          # [gRPC](https://github.com/grpc). The error model is designed to be:
          #
          # - Simple to use and understand for most users
          # - Flexible enough to meet unexpected needs
          #
          # # Overview
          #
          # The `Status` message contains three pieces of data: error code, error message,
          # and error details. The error code should be an enum value of
          # google.rpc.Code, but it may accept additional error codes if needed.  The
          # error message should be a developer-facing English message that helps
          # developers *understand* and *resolve* the error. If a localized user-facing
          # error message is needed, put the localized message in the error details or
          # localize it in the client. The optional error details may contain arbitrary
          # information about the error. There is a predefined set of error detail types
          # in the package `google.rpc` which can be used for common error conditions.
          #
          # # Language mapping
          #
          # The `Status` message is the logical representation of the error model, but it
          # is not necessarily the actual wire format. When the `Status` message is
          # exposed in different client libraries and different wire protocols, it can be
          # mapped differently. For example, it will likely be mapped to some exceptions
          # in Java, but more likely mapped to some error codes in C.
          #
          # # Other uses
          #
          # The error model and the `Status` message can be used in a variety of
          # environments, either with or without APIs, to provide a
          # consistent developer experience across different environments.
          #
          # Example uses of this error model include:
          #
          # - Partial errors. If a service needs to return partial errors to the client,
          #     it may embed the `Status` in the normal response to indicate the partial
          #     errors.
          #
          # - Workflow errors. A typical workflow has multiple steps. Each step may
          #     have a `Status` message for error reporting purpose.
          #
          # - Batch operations. If a client uses batch request and batch response, the
          #     `Status` message should be used directly inside batch response, one for
          #     each error sub-response.
          #
          # - Asynchronous operations. If an API call embeds asynchronous operation
          #     results in its response, the status of those operations should be
          #     represented directly using the `Status` message.
          #
          # - Logging. If some API errors are stored in logs, the message `Status` could
          #     be used directly after any stripping needed for security/privacy reasons.
        "message": "A String", # A developer-facing error message, which should be in English. Any
            # user-facing error message should be localized and sent in the
            # google.rpc.Status.details field, or localized by the client.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details.  There will be a
            # common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
      },
      "createTime": "A String", # [Output Only] The instant at which this Waiter resource was created. Adding
          # the value of `timeout` to this instant yields the timeout deadline for the
          # waiter.
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None) 
List waiters within the given configuration.

Args:
  parent: string, The path to the configuration for which you want to get a list of waiters.
The configuration must exist beforehand; the path must by in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.

Returns:
  An object of the form:

    { # Response for the `ListWaiters()` method.
      # Order of returned waiter objects is arbitrary.
    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
        # If the number of results is larger than `pageSize`, use the `nextPageToken`
        # as a value for the query parameter `pageToken` in the next list request.
        # Subsequent list requests will have their own `nextPageToken` to continue
        # paging through the results
    "waiters": [ # Found waiters in the project.
      { # A Waiter resource waits for some end condition within a RuntimeConfig resource
            # to be met before it returns. For example, assume you have a distributed
            # system where each node writes to a Variable resource indidicating the node's
            # readiness as part of the startup process.
            #
            # You then configure a Waiter resource with the success condition set to wait
            # until some number of nodes have checked in. Afterwards, your application
            # runs some arbitrary code after the condition has been met and the waiter
            # returns successfully.
            #
            # Once created, a Waiter resource is immutable.
            #
            # To learn more about using waiters, read the
            # [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
            # documentation.
          "name": "A String", # The name of the Waiter resource, in the format:
              #
              #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]
              #
              # The `[PROJECT_ID]` must be a valid Google Cloud project ID,
              # the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
              # `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
              # of `[WAITER_NAME]` must be less than 64 bytes.
              #
              # After you create a Waiter resource, you cannot change the resource name.
          "success": { # The condition that a Waiter resource is waiting for. # [Required] The success condition. If this condition is met, `done` will be
              # set to `true` and the `error` value will remain unset. The failure condition
              # takes precedence over the success condition. If both conditions are met, a
              # failure will be indicated.
            "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
                # met when the number of variables under a specified path prefix reaches a
                # predefined number. For example, if you set a Cardinality condition where
                # the `path` is set to `/foo` and the number of paths is set to 2, the
                # following variables would meet the condition in a RuntimeConfig resource:
                #
                # + `/foo/variable1 = "value1"`
                # + `/foo/variable2 = "value2"`
                # + `/bar/variable3 = "value3"`
                #
                # It would not would not satisify the same condition with the `number` set to
                # 3, however, because there is only 2 paths that start with `/foo`.
                # Cardinality conditions are recursive; all subtrees under the specific
                # path prefix are counted.
              "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
              "number": 42, # The number variables under the `path` that must exist to meet this
                  # condition. Defaults to 1 if not specified.
            },
          },
          "failure": { # The condition that a Waiter resource is waiting for. # [Optional] The failure condition of this waiter. If this condition is met,
              # `done` will be set to `true` and the `error` code will be set to `ABORTED`.
              # The failure condition takes precedence over the success condition. If both
              # conditions are met, a failure will be indicated. This value is optional; if
              # no failure condition is set, the only failure scenario will be a timeout.
            "cardinality": { # A Cardinality condition for the Waiter resource. A cardinality condition is # The cardinality of the `EndCondition`.
                # met when the number of variables under a specified path prefix reaches a
                # predefined number. For example, if you set a Cardinality condition where
                # the `path` is set to `/foo` and the number of paths is set to 2, the
                # following variables would meet the condition in a RuntimeConfig resource:
                #
                # + `/foo/variable1 = "value1"`
                # + `/foo/variable2 = "value2"`
                # + `/bar/variable3 = "value3"`
                #
                # It would not would not satisify the same condition with the `number` set to
                # 3, however, because there is only 2 paths that start with `/foo`.
                # Cardinality conditions are recursive; all subtrees under the specific
                # path prefix are counted.
              "path": "A String", # The root of the variable subtree to monitor. For example, `/foo`.
              "number": 42, # The number variables under the `path` that must exist to meet this
                  # condition. Defaults to 1 if not specified.
            },
          },
          "done": True or False, # [Output Only] If the value is `false`, it means the waiter is still waiting
              # for one of its conditions to be met.
              #
              # If true, the waiter has finished. If the waiter finished due to a timeout
              # or failure, `error` will be set.
          "timeout": "A String", # [Required] Specifies the timeout of the waiter in seconds, beginning from
              # the instant that `waiters().create` method is called. If this time elapses
              # before the success or failure conditions are met, the waiter fails and sets
              # the `error` code to `DEADLINE_EXCEEDED`.
          "error": { # The `Status` type defines a logical error model that is suitable for different # [Output Only] If the waiter ended due to a failure or timeout, this value
              # will be set.
              # programming environments, including REST APIs and RPC APIs. It is used by
              # [gRPC](https://github.com/grpc). The error model is designed to be:
              #
              # - Simple to use and understand for most users
              # - Flexible enough to meet unexpected needs
              #
              # # Overview
              #
              # The `Status` message contains three pieces of data: error code, error message,
              # and error details. The error code should be an enum value of
              # google.rpc.Code, but it may accept additional error codes if needed.  The
              # error message should be a developer-facing English message that helps
              # developers *understand* and *resolve* the error. If a localized user-facing
              # error message is needed, put the localized message in the error details or
              # localize it in the client. The optional error details may contain arbitrary
              # information about the error. There is a predefined set of error detail types
              # in the package `google.rpc` which can be used for common error conditions.
              #
              # # Language mapping
              #
              # The `Status` message is the logical representation of the error model, but it
              # is not necessarily the actual wire format. When the `Status` message is
              # exposed in different client libraries and different wire protocols, it can be
              # mapped differently. For example, it will likely be mapped to some exceptions
              # in Java, but more likely mapped to some error codes in C.
              #
              # # Other uses
              #
              # The error model and the `Status` message can be used in a variety of
              # environments, either with or without APIs, to provide a
              # consistent developer experience across different environments.
              #
              # Example uses of this error model include:
              #
              # - Partial errors. If a service needs to return partial errors to the client,
              #     it may embed the `Status` in the normal response to indicate the partial
              #     errors.
              #
              # - Workflow errors. A typical workflow has multiple steps. Each step may
              #     have a `Status` message for error reporting purpose.
              #
              # - Batch operations. If a client uses batch request and batch response, the
              #     `Status` message should be used directly inside batch response, one for
              #     each error sub-response.
              #
              # - Asynchronous operations. If an API call embeds asynchronous operation
              #     results in its response, the status of those operations should be
              #     represented directly using the `Status` message.
              #
              # - Logging. If some API errors are stored in logs, the message `Status` could
              #     be used directly after any stripping needed for security/privacy reasons.
            "message": "A String", # A developer-facing error message, which should be in English. Any
                # user-facing error message should be localized and sent in the
                # google.rpc.Status.details field, or localized by the client.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details.  There will be a
                # common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
          },
          "createTime": "A String", # [Output Only] The instant at which this Waiter resource was created. Adding
              # the value of `timeout` to this instant yields the timeout deadline for the
              # waiter.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/runtimeconfig_v1beta1.projects.html000066400000000000000000000024071300622755700270060ustar00rootroot00000000000000

Google Cloud RuntimeConfig API . projects

Instance Methods

configs()

Returns the configs Resource.

google-api-python-client-1.5.5/docs/dyn/safebrowsing_v4.fullHashes.html000066400000000000000000000116271300622755700261650ustar00rootroot00000000000000

Safe Browsing APIs . fullHashes

Instance Methods

find(body, x__xgafv=None)

Finds the full hashes that match the requested hash prefixes.

Method Details

find(body, x__xgafv=None) 
Finds the full hashes that match the requested hash prefixes.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to return full hashes matched by the provided hash prefixes.
    "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
      "clientVersion": "A String", # The version of the client implementation.
      "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
    },
    "threatInfo": { # The information regarding one or more threats that a client submits when checking for matches in threat lists. # The lists and hashes to be checked.
      "threatTypes": [ # The threat types to be checked.
        "A String",
      ],
      "threatEntries": [ # The threat entries to be checked.
        { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
          "url": "A String", # A URL.
          "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.
          "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests.
        },
      ],
      "platformTypes": [ # The platform types to be checked.
        "A String",
      ],
      "threatEntryTypes": [ # The entry types to be checked.
        "A String",
      ],
    },
    "clientStates": [ # The current client states for each of the client's local threat lists.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "matches": [ # The full hashes that matched the requested prefixes.
      { # A match when checking a threat entry in the Safe Browsing threat lists.
        "threatType": "A String", # The threat type matching this threat.
        "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. # Optional metadata associated with this threat.
          "entries": [ # The metadata entries.
            { # A single metadata entry.
              "value": "A String", # The metadata entry value.
              "key": "A String", # The metadata entry key.
            },
          ],
        },
        "threatEntryType": "A String", # The threat entry type matching this threat.
        "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
        "threat": { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. # The threat matching this threat.
          "url": "A String", # A URL.
          "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.
          "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests.
        },
        "platformType": "A String", # The platform type matching this threat.
      },
    ],
    "negativeCacheDuration": "A String", # For requested entities that did not match the threat list, how long to cache the response.
    "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.
  }
google-api-python-client-1.5.5/docs/dyn/safebrowsing_v4.html000066400000000000000000000051501300622755700240620ustar00rootroot00000000000000

Safe Browsing APIs

Instance Methods

fullHashes()

Returns the fullHashes Resource.

threatListUpdates()

Returns the threatListUpdates Resource.

threatLists()

Returns the threatLists Resource.

threatMatches()

Returns the threatMatches Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/safebrowsing_v4.threatListUpdates.html000066400000000000000000000263431300622755700275410ustar00rootroot00000000000000

Safe Browsing APIs . threatListUpdates

Instance Methods

fetch(body, x__xgafv=None)

Fetches the most recent threat list updates. A client can request updates for multiple lists at once.

Method Details

fetch(body, x__xgafv=None) 
Fetches the most recent threat list updates. A client can request updates for multiple lists at once.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. NOTE: Field index 2 is unused. NEXT: 4
    "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
      "clientVersion": "A String", # The version of the client implementation.
      "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
    },
    "listUpdateRequests": [ # The requested threat list updates.
      { # A single list update request.
        "threatType": "A String", # The type of threat posed by entries present in the list.
        "threatEntryType": "A String", # The types of entries present in the list.
        "platformType": "A String", # The type of platform at risk by entries present in the list.
        "constraints": { # The constraints for this update. # The constraints associated with this request.
          "maxDatabaseEntries": 42, # Sets the maximum number of entries that the client is willing to have in the local database. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set.
          "region": "A String", # Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format.
          "supportedCompressions": [ # The compression types supported by the client.
            "A String",
          ],
          "maxUpdateEntries": 42, # The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set.
        },
        "state": "A String", # The current state of the client for the requested list (the encrypted client state that was received from the last successful list update).
      },
    ],
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "listUpdateResponses": [ # The list updates requested by the clients.
      { # An update to an individual list.
        "responseType": "A String", # The type of response. This may indicate that an action is required by the client when the response is received.
        "threatType": "A String", # The threat type for which data is returned.
        "removals": [ # A set of entries to remove from a local threat type's list. Repeated for the same reason as above.
          { # A set of threats that should be added or removed from a client's local database.
            "compressionType": "A String", # The compression type for the entries in this set.
            "riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices. # The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices.
              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero.
              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value.
            },
            "rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.
              "indices": [ # The indices to remove from a lexicographically-sorted local list.
                42,
              ],
            },
            "riceHashes": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices. # The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding.
              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero.
              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value.
            },
            "rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression. # The raw SHA256-formatted entries.
              "prefixSize": 42, # The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
              "rawHashes": "A String", # The hashes, all concatenated into one long string. Each hash has a prefix size of |prefix_size| above. Hashes are sorted in lexicographic order.
            },
          },
        ],
        "newClientState": "A String", # The new client state, in encrypted format. Opaque to clients.
        "checksum": { # The expected state of a client's local database. # The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided update. If the client state doesn't match the expected state, the client must disregard this update and retry later.
          "sha256": "A String", # The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database.
        },
        "threatEntryType": "A String", # The format of the threats.
        "additions": [ # A set of entries to add to a local threat type's list. Repeated to allow for a combination of compressed and raw data to be sent in a single response.
          { # A set of threats that should be added or removed from a client's local database.
            "compressionType": "A String", # The compression type for the entries in this set.
            "riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices. # The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices.
              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero.
              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value.
            },
            "rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.
              "indices": [ # The indices to remove from a lexicographically-sorted local list.
                42,
              ],
            },
            "riceHashes": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices. # The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding.
              "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
              "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
              "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero.
              "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value.
            },
            "rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression. # The raw SHA256-formatted entries.
              "prefixSize": 42, # The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
              "rawHashes": "A String", # The hashes, all concatenated into one long string. Each hash has a prefix size of |prefix_size| above. Hashes are sorted in lexicographic order.
            },
          },
        ],
        "platformType": "A String", # The platform type for which data is returned.
      },
    ],
    "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want.
  }
google-api-python-client-1.5.5/docs/dyn/safebrowsing_v4.threatLists.html000066400000000000000000000040401300622755700263640ustar00rootroot00000000000000

Safe Browsing APIs . threatLists

Instance Methods

list(x__xgafv=None)

Lists the Safe Browsing threat lists available for download.

Method Details

list(x__xgafv=None) 
Lists the Safe Browsing threat lists available for download.

Args:
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "threatLists": [ # The lists available for download by the client.
      { # Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.
        "threatType": "A String", # The threat type posed by the list's entries.
        "threatEntryType": "A String", # The entry types contained in the list.
        "platformType": "A String", # The platform type targeted by the list's entries.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/safebrowsing_v4.threatMatches.html000066400000000000000000000106521300622755700266600ustar00rootroot00000000000000

Safe Browsing APIs . threatMatches

Instance Methods

find(body, x__xgafv=None)

Finds the threat entries that match the Safe Browsing lists.

Method Details

find(body, x__xgafv=None) 
Finds the threat entries that match the Safe Browsing lists.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to check entries against lists.
    "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
      "clientVersion": "A String", # The version of the client implementation.
      "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
    },
    "threatInfo": { # The information regarding one or more threats that a client submits when checking for matches in threat lists. # The lists and entries to be checked for matches.
      "threatTypes": [ # The threat types to be checked.
        "A String",
      ],
      "threatEntries": [ # The threat entries to be checked.
        { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
          "url": "A String", # A URL.
          "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.
          "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests.
        },
      ],
      "platformTypes": [ # The platform types to be checked.
        "A String",
      ],
      "threatEntryTypes": [ # The entry types to be checked.
        "A String",
      ],
    },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    {
    "matches": [ # The threat list matches.
      { # A match when checking a threat entry in the Safe Browsing threat lists.
        "threatType": "A String", # The threat type matching this threat.
        "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. # Optional metadata associated with this threat.
          "entries": [ # The metadata entries.
            { # A single metadata entry.
              "value": "A String", # The metadata entry value.
              "key": "A String", # The metadata entry key.
            },
          ],
        },
        "threatEntryType": "A String", # The threat entry type matching this threat.
        "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
        "threat": { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. # The threat matching this threat.
          "url": "A String", # A URL.
          "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.
          "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests.
        },
        "platformType": "A String", # The platform type matching this threat.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/script_v1.html000066400000000000000000000041321300622755700226710ustar00rootroot00000000000000

Google Apps Script Execution API

Instance Methods

scripts()

Returns the scripts Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/script_v1.scripts.html000066400000000000000000000143031300622755700243600ustar00rootroot00000000000000

Google Apps Script Execution API . scripts

Instance Methods

run(scriptId, body, x__xgafv=None)

Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authentication](#authentication) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab.

Method Details

run(scriptId, body, x__xgafv=None) 
Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authentication](#authentication) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab.

Args:
  scriptId: string, The project key of the script to be executed. To find the project key, open the project in the script editor, then select **File > Project properties**. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script will return results based on the implementation of the script.
    "function": "A String", # The name of the function to execute in the given script. The name does not include parentheses or parameters.
    "devMode": True or False, # If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Execution API. Optional; default is `false`.
    "parameters": [ # The parameters to be passed to the function being executed. The type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific objects (such as a `Document` or `Calendar`); they can only be primitive types such as a `string`, `number`, `array`, `object`, or `boolean`. Optional.
      "",
    ],
    "sessionState": "A String", # This field is not used.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).
      # If the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.
      #
      # If the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.
      #
      # If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.
    "response": { # If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object. # If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # An array that contains a single `ExecutionError` object that provides information about the nature of the error.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # This field is not used.
    "name": "A String", # This field is not used.
    "metadata": { # This field is not used.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
google-api-python-client-1.5.5/docs/dyn/servicecontrol_v1.html000066400000000000000000000041471300622755700244340ustar00rootroot00000000000000

Google Service Control API

Instance Methods

services()

Returns the services Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/servicecontrol_v1.services.html000066400000000000000000001013101300622755700262440ustar00rootroot00000000000000

Google Service Control API . services

Instance Methods

check(serviceName=None, body, x__xgafv=None)

Checks an operation with Google Service Control to decide whether

report(serviceName=None, body, x__xgafv=None)

Reports operations to Google Service Control. It should be called

Method Details

check(serviceName=None, body, x__xgafv=None) 
Checks an operation with Google Service Control to decide whether
the given operation should proceed. It should be called before the
operation is executed.

This method requires the `servicemanagement.services.check` permission
on the specified service. For more information, see
[Google Cloud IAM](https://cloud.google.com/iam).

Args:
  serviceName: string, The service name as specified in its service configuration. For example,
`"pubsub.googleapis.com"`.

See google.api.Service for the definition of a service name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the Check method.
    "operation": { # Represents information regarding an operation. # The operation to be checked.
      "operationName": "A String", # Fully qualified name of the operation. Reserved for future use.
      "metricValueSets": [ # Represents information about this operation. Each MetricValueSet
          # corresponds to a metric defined in the service configuration.
          # The data type used in the MetricValueSet must agree with
          # the data type specified in the metric definition.
          #
          # Within a single operation, it is not allowed to have more than one
          # MetricValue instances that have the same metric names and identical
          # label value combinations. If a request has such duplicated MetricValue
          # instances, the entire request is rejected with
          # an invalid argument error.
        { # Represents a set of metric values in the same metric.
            # Each metric value in the set should have a unique combination of start time,
            # end time, and label values.
          "metricValues": [ # The values in this metric.
            { # Represents a single metric value.
              "labels": { # The labels describing the metric value.
                  # See comments on google.api.servicecontrol.v1.Operation.labels for
                  # the overriding relationship.
                "a_key": "A String",
              },
              "doubleValue": 3.14, # A double precision floating point value.
              "boolValue": True or False, # A boolean value.
              "startTime": "A String", # The start of the time period over which this metric value's measurement
                  # applies. The time period has different semantics for different metric
                  # types (cumulative, delta, and gauge). See the metric definition
                  # documentation in the service configuration for details.
              "distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
                  # points. It contains the size of the population of sample points plus
                  # additional optional information:
                  #
                  #   - the arithmetic mean of the samples
                  #   - the minimum and maximum of the samples
                  #   - the sum-squared-deviation of the samples, used to compute variance
                  #   - a histogram of the values of the sample points
                "count": "A String", # The total number of samples in the distribution. Must be >= 0.
                "bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are
                    # optional. If present, they must sum to the `count` value.
                    #
                    # The buckets are defined below in `bucket_option`. There are N buckets.
                    # `bucket_counts[0]` is the number of samples in the underflow bucket.
                    # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
                    # in each of the finite buckets. And `bucket_counts[N] is the number
                    # of samples in the overflow bucket. See the comments of `bucket_option`
                    # below for more details.
                    #
                    # Any suffix of trailing zeros may be omitted.
                  "A String",
                ],
                "exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
                  "scale": 3.14, # The i'th exponential bucket covers the interval
                      #   [scale * growth_factor^(i-1), scale * growth_factor^i)
                      # where i ranges from 1 to num_finite_buckets inclusive.
                      # Must be > 0.
                  "growthFactor": 3.14, # The i'th exponential bucket covers the interval
                      #   [scale * growth_factor^(i-1), scale * growth_factor^i)
                      # where i ranges from 1 to num_finite_buckets inclusive.
                      # Must be larger than 1.0.
                  "numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,
                      # the total number of buckets is `num_finite_buckets` + 2.
                      # See comments on `bucket_options` for details.
                },
                "minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.
                "maximum": 3.14, # The maximum of the population of values. Ignored if `count` is zero.
                "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:
                    #   Sum[i=1..count]((x_i - mean)^2)
                    # where each x_i is a sample values. If `count` is zero then this field
                    # must be zero, otherwise validation of the request fails.
                "linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.
                  "width": 3.14, # The i'th linear bucket covers the interval
                      #   [offset + (i-1) * width, offset + i * width)
                      # where i ranges from 1 to num_finite_buckets, inclusive.
                      # Must be strictly positive.
                  "numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,
                      # the total number of buckets is `num_finite_buckets` + 2.
                      # See comments on `bucket_options` for details.
                  "offset": 3.14, # The i'th linear bucket covers the interval
                      #   [offset + (i-1) * width, offset + i * width)
                      # where i ranges from 1 to num_finite_buckets, inclusive.
                },
                "explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
                  "bounds": [ # 'bound' is a list of strictly increasing boundaries between
                      # buckets. Note that a list of length N-1 defines N buckets because
                      # of fenceposting. See comments on `bucket_options` for details.
                      #
                      # The i'th finite bucket covers the interval
                      #   [bound[i-1], bound[i])
                      # where i ranges from 1 to bound_size() - 1. Note that there are no
                      # finite buckets at all if 'bound' only contains a single element; in
                      # that special case the single bound defines the boundary between the
                      # underflow and overflow buckets.
                      #
                      # bucket number                   lower bound    upper bound
                      #  i == 0 (underflow)              -inf           bound[i]
                      #  0 < i < bound_size()            bound[i-1]     bound[i]
                      #  i == bound_size() (overflow)    bound[i-1]     +inf
                    3.14,
                  ],
                },
                "mean": 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
                    # zero then this field must be zero.
              },
              "stringValue": "A String", # A text string value.
              "int64Value": "A String", # A signed 64-bit integer value.
              "endTime": "A String", # The end of the time period over which this metric value's measurement
                  # applies.
            },
          ],
          "metricName": "A String", # The metric name defined in the service configuration.
        },
      ],
      "importance": "A String", # DO NOT USE. This is an experimental field.
      "labels": { # Labels describing the operation. Only the following labels are allowed:
          #
          # - Labels describing monitored resources as defined in
          #   the service configuration.
          # - Default labels of metric values. When specified, labels defined in the
          #   metric value override these default.
          # - The following labels defined by Google Cloud Platform:
          #     - `cloud.googleapis.com/location` describing the location where the
          #        operation happened,
          #     - `servicecontrol.googleapis.com/user_agent` describing the user agent
          #        of the API request,
          #     - `servicecontrol.googleapis.com/service_agent` describing the service
          #        used to handle the API request (e.g. ESP),
          #     - `servicecontrol.googleapis.com/platform` describing the platform
          #        where the API is served (e.g. GAE, GCE, GKE).
        "a_key": "A String",
      },
      "consumerId": "A String", # Identity of the consumer who is using the service.
          # This field should be filled in for the operations initiated by a
          # consumer, but not for service-initiated operations that are
          # not related to a specific consumer.
          #
          # This can be in one of the following formats:
          #   project:,
          #   project_number:,
          #   api_key:.
      "logEntries": [ # Represents information to be logged.
        { # An individual log entry.
          "name": "A String", # Required. The log to which this log entry belongs. Examples: `"syslog"`,
              # `"book_log"`.
          "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
          "timestamp": "A String", # The time the event described by the log entry occurred. If
              # omitted, defaults to operation start time.
          "labels": { # A set of user-defined (key, value) data that provides additional
              # information about the log entry.
            "a_key": "A String",
          },
          "structPayload": { # The log entry payload, represented as a structure that
              # is expressed as a JSON object.
            "a_key": "", # Properties of the object.
          },
          "insertId": "A String", # A unique ID for the log entry used for deduplication. If omitted,
              # the implementation will generate one based on operation_id.
          "protoPayload": { # The log entry payload, represented as a protocol buffer that is
              # expressed as a JSON object. You can only pass `protoPayload`
              # values that belong to a set of approved types.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "severity": "A String", # The severity of the log entry. The default value is
              # `LogSeverity.DEFAULT`.
        },
      ],
      "startTime": "A String", # Required. Start time of the operation.
      "endTime": "A String", # End time of the operation.
          # Required when the operation is used in ServiceController.Report,
          # but optional when the operation is used in ServiceController.Check.
      "operationId": "A String", # Identity of the operation. This must be unique within the scope of the
          # service that generated the operation. If the service calls
          # Check() and Report() on the same operation, the two calls should carry
          # the same id.
          #
          # UUID version 4 is recommended, though not required.
          # In scenarios where an operation is computed from existing information
          # and an idempotent id is desirable for deduplication purpose, UUID version 5
          # is recommended. See RFC 4122 for details.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the Check method.
    "serviceConfigId": "A String", # The actual config id used to process the request.
    "checkErrors": [ # Indicate the decision of the check.
        #
        # If no check errors are present, the service should process the operation.
        # Otherwise the service should use the list of errors to determine the
        # appropriate action.
      { # Defines the errors to be returned in
          # google.api.servicecontrol.v1.CheckResponse.check_errors.
        "code": "A String", # The error code.
        "detail": "A String", # Free-form text providing details on the error cause of the error.
      },
    ],
    "operationId": "A String", # The same operation_id value used in the CheckRequest.
        # Used for logging and diagnostics purposes.
  }
report(serviceName=None, body, x__xgafv=None) 
Reports operations to Google Service Control. It should be called
after the operation is completed.

This method requires the `servicemanagement.services.report` permission
on the specified service. For more information, see
[Google Cloud IAM](https://cloud.google.com/iam).

Args:
  serviceName: string, The service name as specified in its service configuration. For example,
`"pubsub.googleapis.com"`.

See google.api.Service for the definition of a service name. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the Report method.
    "operations": [ # Operations to be reported.
        # 
        # Typically the service should report one operation per request.
        # Putting multiple operations into a single request is allowed, but should
        # be used only when multiple operations are natually available at the time
        # of the report.
        # 
        # If multiple operations are in a single request, the total request size
        # should be no larger than 1MB. See ReportResponse.report_errors for
        # partial failure behavior.
      { # Represents information regarding an operation.
        "operationName": "A String", # Fully qualified name of the operation. Reserved for future use.
        "metricValueSets": [ # Represents information about this operation. Each MetricValueSet
            # corresponds to a metric defined in the service configuration.
            # The data type used in the MetricValueSet must agree with
            # the data type specified in the metric definition.
            #
            # Within a single operation, it is not allowed to have more than one
            # MetricValue instances that have the same metric names and identical
            # label value combinations. If a request has such duplicated MetricValue
            # instances, the entire request is rejected with
            # an invalid argument error.
          { # Represents a set of metric values in the same metric.
              # Each metric value in the set should have a unique combination of start time,
              # end time, and label values.
            "metricValues": [ # The values in this metric.
              { # Represents a single metric value.
                "labels": { # The labels describing the metric value.
                    # See comments on google.api.servicecontrol.v1.Operation.labels for
                    # the overriding relationship.
                  "a_key": "A String",
                },
                "doubleValue": 3.14, # A double precision floating point value.
                "boolValue": True or False, # A boolean value.
                "startTime": "A String", # The start of the time period over which this metric value's measurement
                    # applies. The time period has different semantics for different metric
                    # types (cumulative, delta, and gauge). See the metric definition
                    # documentation in the service configuration for details.
                "distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
                    # points. It contains the size of the population of sample points plus
                    # additional optional information:
                    #
                    #   - the arithmetic mean of the samples
                    #   - the minimum and maximum of the samples
                    #   - the sum-squared-deviation of the samples, used to compute variance
                    #   - a histogram of the values of the sample points
                  "count": "A String", # The total number of samples in the distribution. Must be >= 0.
                  "bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are
                      # optional. If present, they must sum to the `count` value.
                      #
                      # The buckets are defined below in `bucket_option`. There are N buckets.
                      # `bucket_counts[0]` is the number of samples in the underflow bucket.
                      # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
                      # in each of the finite buckets. And `bucket_counts[N] is the number
                      # of samples in the overflow bucket. See the comments of `bucket_option`
                      # below for more details.
                      #
                      # Any suffix of trailing zeros may be omitted.
                    "A String",
                  ],
                  "exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
                    "scale": 3.14, # The i'th exponential bucket covers the interval
                        #   [scale * growth_factor^(i-1), scale * growth_factor^i)
                        # where i ranges from 1 to num_finite_buckets inclusive.
                        # Must be > 0.
                    "growthFactor": 3.14, # The i'th exponential bucket covers the interval
                        #   [scale * growth_factor^(i-1), scale * growth_factor^i)
                        # where i ranges from 1 to num_finite_buckets inclusive.
                        # Must be larger than 1.0.
                    "numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,
                        # the total number of buckets is `num_finite_buckets` + 2.
                        # See comments on `bucket_options` for details.
                  },
                  "minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.
                  "maximum": 3.14, # The maximum of the population of values. Ignored if `count` is zero.
                  "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:
                      #   Sum[i=1..count]((x_i - mean)^2)
                      # where each x_i is a sample values. If `count` is zero then this field
                      # must be zero, otherwise validation of the request fails.
                  "linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.
                    "width": 3.14, # The i'th linear bucket covers the interval
                        #   [offset + (i-1) * width, offset + i * width)
                        # where i ranges from 1 to num_finite_buckets, inclusive.
                        # Must be strictly positive.
                    "numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,
                        # the total number of buckets is `num_finite_buckets` + 2.
                        # See comments on `bucket_options` for details.
                    "offset": 3.14, # The i'th linear bucket covers the interval
                        #   [offset + (i-1) * width, offset + i * width)
                        # where i ranges from 1 to num_finite_buckets, inclusive.
                  },
                  "explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
                    "bounds": [ # 'bound' is a list of strictly increasing boundaries between
                        # buckets. Note that a list of length N-1 defines N buckets because
                        # of fenceposting. See comments on `bucket_options` for details.
                        #
                        # The i'th finite bucket covers the interval
                        #   [bound[i-1], bound[i])
                        # where i ranges from 1 to bound_size() - 1. Note that there are no
                        # finite buckets at all if 'bound' only contains a single element; in
                        # that special case the single bound defines the boundary between the
                        # underflow and overflow buckets.
                        #
                        # bucket number                   lower bound    upper bound
                        #  i == 0 (underflow)              -inf           bound[i]
                        #  0 < i < bound_size()            bound[i-1]     bound[i]
                        #  i == bound_size() (overflow)    bound[i-1]     +inf
                      3.14,
                    ],
                  },
                  "mean": 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
                      # zero then this field must be zero.
                },
                "stringValue": "A String", # A text string value.
                "int64Value": "A String", # A signed 64-bit integer value.
                "endTime": "A String", # The end of the time period over which this metric value's measurement
                    # applies.
              },
            ],
            "metricName": "A String", # The metric name defined in the service configuration.
          },
        ],
        "importance": "A String", # DO NOT USE. This is an experimental field.
        "labels": { # Labels describing the operation. Only the following labels are allowed:
            #
            # - Labels describing monitored resources as defined in
            #   the service configuration.
            # - Default labels of metric values. When specified, labels defined in the
            #   metric value override these default.
            # - The following labels defined by Google Cloud Platform:
            #     - `cloud.googleapis.com/location` describing the location where the
            #        operation happened,
            #     - `servicecontrol.googleapis.com/user_agent` describing the user agent
            #        of the API request,
            #     - `servicecontrol.googleapis.com/service_agent` describing the service
            #        used to handle the API request (e.g. ESP),
            #     - `servicecontrol.googleapis.com/platform` describing the platform
            #        where the API is served (e.g. GAE, GCE, GKE).
          "a_key": "A String",
        },
        "consumerId": "A String", # Identity of the consumer who is using the service.
            # This field should be filled in for the operations initiated by a
            # consumer, but not for service-initiated operations that are
            # not related to a specific consumer.
            #
            # This can be in one of the following formats:
            #   project:,
            #   project_number:,
            #   api_key:.
        "logEntries": [ # Represents information to be logged.
          { # An individual log entry.
            "name": "A String", # Required. The log to which this log entry belongs. Examples: `"syslog"`,
                # `"book_log"`.
            "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
            "timestamp": "A String", # The time the event described by the log entry occurred. If
                # omitted, defaults to operation start time.
            "labels": { # A set of user-defined (key, value) data that provides additional
                # information about the log entry.
              "a_key": "A String",
            },
            "structPayload": { # The log entry payload, represented as a structure that
                # is expressed as a JSON object.
              "a_key": "", # Properties of the object.
            },
            "insertId": "A String", # A unique ID for the log entry used for deduplication. If omitted,
                # the implementation will generate one based on operation_id.
            "protoPayload": { # The log entry payload, represented as a protocol buffer that is
                # expressed as a JSON object. You can only pass `protoPayload`
                # values that belong to a set of approved types.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "severity": "A String", # The severity of the log entry. The default value is
                # `LogSeverity.DEFAULT`.
          },
        ],
        "startTime": "A String", # Required. Start time of the operation.
        "endTime": "A String", # End time of the operation.
            # Required when the operation is used in ServiceController.Report,
            # but optional when the operation is used in ServiceController.Check.
        "operationId": "A String", # Identity of the operation. This must be unique within the scope of the
            # service that generated the operation. If the service calls
            # Check() and Report() on the same operation, the two calls should carry
            # the same id.
            #
            # UUID version 4 is recommended, though not required.
            # In scenarios where an operation is computed from existing information
            # and an idempotent id is desirable for deduplication purpose, UUID version 5
            # is recommended. See RFC 4122 for details.
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the Report method.
    "serviceConfigId": "A String", # The actual config id used to process the request.
    "reportErrors": [ # Partial failures, one for each `Operation` in the request that failed
        # processing. There are three possible combinations of the RPC status:
        #
        # 1. The combination of a successful RPC status and an empty `report_errors`
        #    list indicates a complete success where all `Operations` in the
        #    request are processed successfully.
        # 2. The combination of a successful RPC status and a non-empty
        #    `report_errors` list indicates a partial success where some
        #    `Operations` in the request succeeded. Each
        #    `Operation` that failed processing has a corresponding item
        #    in this list.
        # 3. A failed RPC status indicates a complete failure where none of the
        #    `Operations` in the request succeeded.
      { # Represents the processing error of one `Operation` in the request.
        "status": { # The `Status` type defines a logical error model that is suitable for different # Details of the error when processing the `Operation`.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "operationId": "A String", # The Operation.operation_id value from the request.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/servicemanagement_v1.html000066400000000000000000000044271300622755700250710ustar00rootroot00000000000000

Google Service Management API

Instance Methods

operations()

Returns the operations Resource.

services()

Returns the services Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/servicemanagement_v1.operations.html000066400000000000000000000156751300622755700272620ustar00rootroot00000000000000

Google Service Management API . operations

Instance Methods

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this

Method Details

get(name, x__xgafv=None) 
Gets the latest state of a long-running operation.  Clients can use this
method to poll the operation result at intervals as recommended by the API
service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/servicemanagement_v1.services.configs.html000066400000000000000000011542201300622755700303400ustar00rootroot00000000000000

Google Service Management API . services . configs

Instance Methods

create(serviceName=None, body, x__xgafv=None)

Creates a new service configuration (version) for a managed service.

get(serviceName=None, configId, x__xgafv=None)

Gets a service configuration (version) for a managed service.

list(serviceName=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the history of the service configuration for a managed service,

list_next(previous_request, previous_response)

Retrieves the next page of results.

submit(serviceName=None, body, x__xgafv=None)

Creates a new service configuration (version) for a managed service based

Method Details

create(serviceName=None, body, x__xgafv=None) 
Creates a new service configuration (version) for a managed service.
This method only stores the service configuration. To roll out the service
configuration to backend systems please call
CreateServiceRollout.

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # `Service` is the root object of Google service configuration schema. It
    # describes basic information about a service, such as the name and the
    # title, and delegates other aspects to sub-sections. Each sub-section is
    # either a proto message or a repeated proto message that configures a
    # specific aspect, such as auth. See each proto message definition for details.
    # 
    # Example:
    # 
    #     type: google.api.Service
    #     config_version: 3
    #     name: calendar.googleapis.com
    #     title: Google Calendar API
    #     apis:
    #     - name: google.calendar.v3.Calendar
    #     backend:
    #       rules:
    #       - selector: "google.calendar.v3.*"
    #         address: calendar.example.com
  "control": { # Selects and configures the service controller used by the service.  The # Configuration for the service control plane.
      # service controller handles features like abuse, quota, billing, logging,
      # monitoring, etc.
    "environment": "A String", # The service control environment to use. If empty, no control plane
        # feature (like quota and billing) will be enabled.
  },
  "monitoredResources": [ # Defines the monitored resources used by this service. This is required
      # by the Service.monitoring and Service.logging configurations.
    { # An object that describes the schema of a MonitoredResource object using a
        # type name and a set of labels.  For example, the monitored resource
        # descriptor for Google Compute Engine VM instances has a type of
        # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
        # `"zone"` to identify particular VM instances.
        #
        # Different APIs can support different monitored resource types. APIs generally
        # provide a `list` method that returns the monitored resource descriptors used
        # by the API.
      "type": "A String", # Required. The monitored resource type. For example, the type
          # `"cloudsql_database"` represents databases in Google Cloud SQL.
          # The maximum length of this value is 256 characters.
      "labels": [ # Required. A set of labels used to describe instances of this monitored
          # resource type. For example, an individual Google Cloud SQL database is
          # identified by values for the labels `"database_id"` and `"zone"`.
        { # A description of a label.
          "valueType": "A String", # The type of data that can be assigned to the label.
          "description": "A String", # A human-readable description for the label.
          "key": "A String", # The label key.
        },
      ],
      "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
          # displayed in user interfaces. It should be a Title Cased Noun Phrase,
          # without any article or other determiners. For example,
          # `"Google Cloud SQL Database"`.
      "description": "A String", # Optional. A detailed description of the monitored resource type that might
          # be used in documentation.
      "name": "A String", # Optional. The resource name of the monitored resource descriptor:
          # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
          # {type} is the value of the `type` field in this object and
          # {project_id} is a project ID that provides API-specific context for
          # accessing the type.  APIs that do not use project information can use the
          # resource name format `"monitoredResourceDescriptors/{type}"`.
    },
  ],
  "logs": [ # Defines the logs used by this service.
    { # A description of a log type. Example in YAML format:
        #
        #     - name: library.googleapis.com/activity_history
        #       description: The history of borrowing and returning library items.
        #       display_name: Activity
        #       labels:
        #       - key: /customer_id
        #         description: Identifier of a library customer
      "labels": [ # The set of labels that are available to describe a specific log entry.
          # Runtime requests that contain labels not specified here are
          # considered invalid.
        { # A description of a label.
          "valueType": "A String", # The type of data that can be assigned to the label.
          "description": "A String", # A human-readable description for the label.
          "key": "A String", # The label key.
        },
      ],
      "displayName": "A String", # The human-readable name for this log. This information appears on
          # the user interface and should be concise.
      "description": "A String", # A human-readable description of this log. This information appears in
          # the documentation and can contain details.
      "name": "A String", # The name of the log. It must be less than 512 characters long and can
          # include the following characters: upper- and lower-case alphanumeric
          # characters [A-Za-z0-9], and punctuation characters including
          # slash, underscore, hyphen, period [/_-.].
    },
  ],
  "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
      # 
      # Analytics configuration.
      #
      # The example below shows how to configure monitored resources and metrics
      # for analytics. In the example, a monitored resource and two metrics are
      # defined. The `library.googleapis.com/book/returned_count` and
      # `library.googleapis.com/book/overdue_count` metric are sent
      # to the analytics.
      #
      #     monitored_resources:
      #     - type: library.googleapis.com/branch
      #       labels:
      #       - key: /city
      #         description: The city where the library branch is located in.
      #       - key: /name
      #         description: The name of the branch.
      #     metrics:
      #     - name: library.googleapis.com/book/returned_count
      #       metric_kind: DELTA
      #       value_type: INT64
      #       labels:
      #       - key: /customer_id
      #     - name: library.googleapis.com/book/overdue_count
      #       metric_kind: GAUGE
      #       value_type: INT64
      #       labels:
      #       - key: /customer_id
      #     analytics:
      #       producer_destinations:
      #       - monitored_resource: library.googleapis.com/branch
      #         metrics:
      #         - library.googleapis.com/book/returned_count
      #         - library.googleapis.com/book/overdue_count
    "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
        # There can be multiple producer destinations, each one must have a
        # different monitored resource type. A metric can be used in at most
        # one producer destination.
      { # Configuration of a specific analytics destination.
        "monitoredResource": "A String", # The monitored resource type. The type must be defined in
            # Service.monitored_resources section.
        "metrics": [ # Names of the metrics to report to this analytics destination.
            # Each name must be defined in Service.metrics section. Metrics
            # with value type BOOL and STRING must be of GUAGE kind, metrics with
            # value type INT64, DOUBLE and MONEY must be of DELTA kind.
          "A String",
        ],
      },
    ],
  },
  "systemParameters": { # ### System parameter configuration # System parameter configuration.
      #
      # A system parameter is a special kind of parameter defined by the API
      # system, not by an individual API. It is typically mapped to an HTTP header
      # and/or a URL query parameter. This configuration specifies which methods
      # change the names of the system parameters.
    "rules": [ # Define system parameters.
        #
        # The parameters defined here will override the default parameters
        # implemented by the system. If this field is missing from the service
        # config, default system parameters will be used. Default system parameters
        # and names is implementation-dependent.
        #
        # Example: define api key and alt name for all methods
        #
        # system_parameters
        #   rules:
        #     - selector: "*"
        #       parameters:
        #         - name: api_key
        #           url_query_parameter: api_key
        #         - name: alt
        #           http_header: Response-Content-Type
        #
        # Example: define 2 api key names for a specific method.
        #
        # system_parameters
        #   rules:
        #     - selector: "/ListShelves"
        #       parameters:
        #         - name: api_key
        #           http_header: Api-Key1
        #         - name: api_key
        #           http_header: Api-Key2
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # Define a system parameter rule mapping system parameter definitions to
          # methods.
        "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
            # For a given method call, only one of them should be used. If multiple
            # names are used the behavior is implementation-dependent.
            # If none of the specified names are present the behavior is
            # parameter-dependent.
          { # Define a parameter's name and location. The parameter may be passed as either
              # an HTTP header or a URL query parameter, and if both are passed the behavior
              # is implementation-dependent.
            "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
                # sensitive.
            "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
                # and etc. It is case sensitive.
            "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
                # insensitive.
          },
        ],
        "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
            # methods in all APIs.
            #
            # Refer to selector for syntax details.
      },
    ],
  },
  "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
    "rules": [ # A list of API backend rules that apply to individual API methods.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # A backend rule provides configuration for an individual API element.
        "selector": "A String", # Selects the methods to which this rule applies.
            #
            # Refer to selector for syntax details.
        "deadline": 3.14, # The number of seconds to wait for a response from a request.  The
            # default depends on the deployment context.
        "address": "A String", # The address of the API backend.
      },
    ],
  },
  "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
      #
      # The example below shows how to configure monitored resources and metrics
      # for monitoring. In the example, a monitored resource and two metrics are
      # defined. The `library.googleapis.com/book/returned_count` metric is sent
      # to both producer and consumer projects, whereas the
      # `library.googleapis.com/book/overdue_count` metric is only sent to the
      # consumer project.
      #
      #     monitored_resources:
      #     - type: library.googleapis.com/branch
      #       labels:
      #       - key: /city
      #         description: The city where the library branch is located in.
      #       - key: /name
      #         description: The name of the branch.
      #     metrics:
      #     - name: library.googleapis.com/book/returned_count
      #       metric_kind: DELTA
      #       value_type: INT64
      #       labels:
      #       - key: /customer_id
      #     - name: library.googleapis.com/book/overdue_count
      #       metric_kind: GAUGE
      #       value_type: INT64
      #       labels:
      #       - key: /customer_id
      #     monitoring:
      #       producer_destinations:
      #       - monitored_resource: library.googleapis.com/branch
      #         metrics:
      #         - library.googleapis.com/book/returned_count
      #       consumer_destinations:
      #       - monitored_resource: library.googleapis.com/branch
      #         metrics:
      #         - library.googleapis.com/book/returned_count
      #         - library.googleapis.com/book/overdue_count
    "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
        # There can be multiple producer destinations, each one must have a
        # different monitored resource type. A metric can be used in at most
        # one producer destination.
      { # Configuration of a specific monitoring destination (the producer project
          # or the consumer project).
        "monitoredResource": "A String", # The monitored resource type. The type must be defined in
            # Service.monitored_resources section.
        "metrics": [ # Names of the metrics to report to this monitoring destination.
            # Each name must be defined in Service.metrics section.
          "A String",
        ],
      },
    ],
    "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
        # There can be multiple consumer destinations, each one must have a
        # different monitored resource type. A metric can be used in at most
        # one consumer destination.
      { # Configuration of a specific monitoring destination (the producer project
          # or the consumer project).
        "monitoredResource": "A String", # The monitored resource type. The type must be defined in
            # Service.monitored_resources section.
        "metrics": [ # Names of the metrics to report to this monitoring destination.
            # Each name must be defined in Service.metrics section.
          "A String",
        ],
      },
    ],
  },
  "title": "A String", # The product title associated with this service.
  "id": "A String", # A unique ID for a specific instance of this message, typically assigned
      # by the client for tracking purpose. If empty, the server may choose to
      # generate one instead.
  "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
      #
      # Example for an API targeted for external use:
      #
      #     name: calendar.googleapis.com
      #     authentication:
      #       rules:
      #       - selector: "*"
      #         oauth:
      #           canonical_scopes: https://www.googleapis.com/auth/calendar
      #
      #       - selector: google.calendar.Delegate
      #         oauth:
      #           canonical_scopes: https://www.googleapis.com/auth/calendar.read
    "rules": [ # A list of authentication rules that apply to individual API methods.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # Authentication rules for the service.
          #
          # By default, if a method has any authentication requirements, every request
          # must include a valid credential matching one of the requirements.
          # It's an error to include more than one kind of credential in a single
          # request.
          #
          # If a method doesn't have any auth requirements, request credentials will be
          # ignored.
        "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
            # there are scopes defined for "Read-only access to Google Calendar" and
            # "Access to Cloud Platform". Users can consent to a scope for an application,
            # giving it permission to access that data on their behalf.
            #
            # OAuth scope specifications should be fairly coarse grained; a user will need
            # to see and understand the text description of what your scope means.
            #
            # In most cases: use one or at most two OAuth scopes for an entire family of
            # products. If your product has multiple APIs, you should probably be sharing
            # the OAuth scope across all of those APIs.
            #
            # When you need finer grained OAuth consent screens: talk with your product
            # management about how developers will use them in practice.
            #
            # Please note that even though each of the canonical scopes is enough for a
            # request to be accepted and passed to the backend, a request can still fail
            # due to the backend requiring additional scopes or permissions.
          "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
              # OAuth token containing any of these scopes will be accepted.
              #
              # Example:
              #
              #      canonical_scopes: https://www.googleapis.com/auth/calendar,
              #                        https://www.googleapis.com/auth/calendar.read
        },
        "requirements": [ # Requirements for additional authentication providers.
          { # User-defined authentication requirements, including support for
              # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
            "providerId": "A String", # id from authentication provider.
                #
                # Example:
                #
                #     provider_id: bookstore_auth
            "audiences": "A String", # The list of JWT
                # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
                # that are allowed to access. A JWT containing any of these audiences will
                # be accepted. When this setting is absent, only JWTs with audience
                # "https://Service_name/API_name"
                # will be accepted. For example, if no audiences are in the setting,
                # LibraryService API will only accept JWTs with the following audience
                # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
                #
                # Example:
                #
                #     audiences: bookstore_android.apps.googleusercontent.com,
                #                bookstore_web.apps.googleusercontent.com
          },
        ],
        "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
            # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
            #
            # For requests without credentials, if the service control environment is
            # specified, each incoming request **must** be associated with a service
            # consumer. This can be done by passing an API key that belongs to a consumer
            # project.
        "selector": "A String", # Selects the methods to which this rule applies.
            #
            # Refer to selector for syntax details.
      },
    ],
    "providers": [ # Defines a set of authentication providers that a service supports.
      { # Configuration for an anthentication provider, including support for
          # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
        "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
            # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
            # Optional if the key set document:
            #  - can be retrieved from
            #    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
            #    of the issuer.
            #  - can be inferred from the email domain of the issuer (e.g. a Google service account).
            #
            # Example: https://www.googleapis.com/oauth2/v1/certs
        "id": "A String", # The unique identifier of the auth provider. It will be referred to by
            # `AuthRequirement.provider_id`.
            #
            # Example: "bookstore_auth".
        "issuer": "A String", # Identifies the principal that issued the JWT. See
            # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
            # Usually a URL or an email address.
            #
            # Example: https://securetoken.google.com
            # Example: 1234567-compute@developer.gserviceaccount.com
      },
    ],
  },
  "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
    "rules": [ # A list of usage rules that apply to individual API methods.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # Usage configuration rules for the service.
          #
          # NOTE: Under development.
          #
          #
          # Use this rule to configure unregistered calls for the service. Unregistered
          # calls are calls that do not contain consumer project identity.
          # (Example: calls that do not contain an API key).
          # By default, API methods do not allow unregistered calls, and each method call
          # must be identified by a consumer project identity. Use this rule to
          # allow/disallow unregistered calls.
          #
          # Example of an API that wants to allow unregistered calls for entire service.
          #
          #     usage:
          #       rules:
          #       - selector: "*"
          #         allow_unregistered_calls: true
          #
          # Example of a method that wants to allow unregistered calls.
          #
          #     usage:
          #       rules:
          #       - selector: "google.example.library.v1.LibraryService.CreateBook"
          #         allow_unregistered_calls: true
        "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
            # methods in all APIs.
            #
            # Refer to selector for syntax details.
        "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
      },
    ],
    "requirements": [ # Requirements that must be satisfied before a consumer project can use the
        # service. Each requirement is of the form /;
        # for example 'serviceusage.googleapis.com/billing-enabled'.
      "A String",
    ],
  },
  "configVersion": 42, # The version of the service configuration. The config version may
      # influence interpretation of the configuration, for example, to
      # determine defaults. This is documented together with applicable
      # options. The current default for the config version itself is `3`.
  "producerProjectId": "A String", # The id of the Google developer project that owns the service.
      # Members of this project can manage the service configuration,
      # manage consumption of the service, etc.
  "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
      # HttpRule, each specifying the mapping of an RPC method
      # to one or more HTTP REST API methods.
    "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
          # REST APIs.  The mapping determines what portions of the request
          # message are populated from the path, query parameters, or body of
          # the HTTP request.  The mapping is typically specified as an
          # `google.api.http` annotation, see "google/api/annotations.proto"
          # for details.
          #
          # The mapping consists of a field specifying the path template and
          # method kind.  The path template can refer to fields in the request
          # message, as in the example below which describes a REST GET
          # operation on a resource collection of messages:
          #
          # ```proto
          # service Messaging {
          #   rpc GetMessage(GetMessageRequest) returns (Message) {
          #     option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
          #   }
          # }
          # message GetMessageRequest {
          #   message SubMessage {
          #     string subfield = 1;
          #   }
          #   string message_id = 1; // mapped to the URL
          #   SubMessage sub = 2;    // `sub.subfield` is url-mapped
          # }
          # message Message {
          #   string text = 1; // content of the resource
          # }
          # ```
          #
          # This definition enables an automatic, bidrectional mapping of HTTP
          # JSON to RPC. Example:
          #
          # HTTP | RPC
          # -----|-----
          # `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
          #
          # In general, not only fields but also field paths can be referenced
          # from a path pattern. Fields mapped to the path pattern cannot be
          # repeated and must have a primitive (non-message) type.
          #
          # Any fields in the request message which are not bound by the path
          # pattern automatically become (optional) HTTP query
          # parameters. Assume the following definition of the request message:
          #
          # ```proto
          # message GetMessageRequest {
          #   message SubMessage {
          #     string subfield = 1;
          #   }
          #   string message_id = 1; // mapped to the URL
          #   int64 revision = 2;    // becomes a parameter
          #   SubMessage sub = 3;    // `sub.subfield` becomes a parameter
          # }
          # ```
          #
          # This enables a HTTP JSON to RPC mapping as below:
          #
          # HTTP | RPC
          # -----|-----
          # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
          #
          # Note that fields which are mapped to HTTP parameters must have a
          # primitive type or a repeated primitive type. Message types are not
          # allowed. In the case of a repeated type, the parameter can be
          # repeated in the URL, as in `...?param=A¶m=B`.
          #
          # For HTTP method kinds which allow a request body, the `body` field
          # specifies the mapping. Consider a REST update method on the
          # message resource collection:
          #
          # ```proto
          # service Messaging {
          #   rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
          #     option (google.api.http) = {
          #       put: "/v1/messages/{message_id}"
          #       body: "message"
          #     };
          #   }
          # }
          # message UpdateMessageRequest {
          #   string message_id = 1; // mapped to the URL
          #   Message message = 2;   // mapped to the body
          # }
          # ```
          #
          # The following HTTP JSON to RPC mapping is enabled, where the
          # representation of the JSON in the request body is determined by
          # protos JSON encoding:
          #
          # HTTP | RPC
          # -----|-----
          # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
          #
          # The special name `*` can be used in the body mapping to define that
          # every field not bound by the path template should be mapped to the
          # request body.  This enables the following alternative definition of
          # the update method:
          #
          # ```proto
          # service Messaging {
          #   rpc UpdateMessage(Message) returns (Message) {
          #     option (google.api.http) = {
          #       put: "/v1/messages/{message_id}"
          #       body: "*"
          #     };
          #   }
          # }
          # message Message {
          #   string message_id = 1;
          #   string text = 2;
          # }
          # ```
          #
          # The following HTTP JSON to RPC mapping is enabled:
          #
          # HTTP | RPC
          # -----|-----
          # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
          #
          # Note that when using `*` in the body mapping, it is not possible to
          # have HTTP parameters, as all fields not bound by the path end in
          # the body. This makes this option more rarely used in practice of
          # defining REST APIs. The common usage of `*` is in custom methods
          # which don't use the URL at all for transferring data.
          #
          # It is possible to define multiple HTTP methods for one RPC by using
          # the `additional_bindings` option. Example:
          #
          # ```proto
          # service Messaging {
          #   rpc GetMessage(GetMessageRequest) returns (Message) {
          #     option (google.api.http) = {
          #       get: "/v1/messages/{message_id}"
          #       additional_bindings {
          #         get: "/v1/users/{user_id}/messages/{message_id}"
          #       }
          #     };
          #   }
          # }
          # message GetMessageRequest {
          #   string message_id = 1;
          #   string user_id = 2;
          # }
          # ```
          #
          # This enables the following two alternative HTTP JSON to RPC
          # mappings:
          #
          # HTTP | RPC
          # -----|-----
          # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
          # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
          #
          # # Rules for HTTP mapping
          #
          # The rules for mapping HTTP path, query parameters, and body fields
          # to the request message are as follows:
          #
          # 1. The `body` field specifies either `*` or a field path, or is
          #    omitted. If omitted, it assumes there is no HTTP body.
          # 2. Leaf fields (recursive expansion of nested messages in the
          #    request) can be classified into three types:
          #     (a) Matched in the URL template.
          #     (b) Covered by body (if body is `*`, everything except (a) fields;
          #         else everything under the body field)
          #     (c) All other fields.
          # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
          # 4. Any body sent with an HTTP request can contain only (b) fields.
          #
          # The syntax of the path template is as follows:
          #
          #     Template = "/" Segments [ Verb ] ;
          #     Segments = Segment { "/" Segment } ;
          #     Segment  = "*" | "**" | LITERAL | Variable ;
          #     Variable = "{" FieldPath [ "=" Segments ] "}" ;
          #     FieldPath = IDENT { "." IDENT } ;
          #     Verb     = ":" LITERAL ;
          #
          # The syntax `*` matches a single path segment. It follows the semantics of
          # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
          # Expansion.
          #
          # The syntax `**` matches zero or more path segments. It follows the semantics
          # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
          # Expansion.
          #
          # The syntax `LITERAL` matches literal text in the URL path.
          #
          # The syntax `Variable` matches the entire path as specified by its template;
          # this nested template must not contain further variables. If a variable
          # matches a single path segment, its template may be omitted, e.g. `{var}`
          # is equivalent to `{var=*}`.
          #
          # NOTE: the field paths in variables and in the `body` must not refer to
          # repeated fields or map fields.
          #
          # Use CustomHttpPattern to specify any HTTP method that is not included in the
          # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
          # a given URL path rule. The wild-card rule is useful for services that provide
          # content to Web (HTML) clients.
        "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
            # `*` for mapping all fields not captured by the path pattern to the HTTP
            # body. NOTE: the referred field must not be a repeated field and must be
            # present at the top-level of response message type.
        "get": "A String", # Used for listing and getting information about resources.
        "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
            # [][google.bytestream.RestByteStream] as an API to your
            # configuration.
            # [][google.bytestream.RestByteStream] as an API to your
            # configuration.
          "enabled": True or False, # Whether download is enabled.
        },
        "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
            # not contain an `additional_bindings` field themselves (that is,
            # the nesting may only be one level deep).
          # Object with schema name: HttpRule
        ],
        "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
            # [][google.bytestream.RestByteStream] as an API to your
            # configuration.
            # [][google.bytestream.RestByteStream] as an API to your
            # configuration.
          "enabled": True or False, # Whether upload is enabled.
        },
        "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
          "path": "A String", # The path matched by this custom verb.
          "kind": "A String", # The name of this custom HTTP verb.
        },
        "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
            # response. Other response fields are ignored. This field is optional. When
            # not set, the response message will be used as HTTP body of response.
            # NOTE: the referred field must be not a repeated field and must be present
            # at the top-level of response message type.
        "put": "A String", # Used for updating a resource.
        "patch": "A String", # Used for updating a resource.
        "post": "A String", # Used for creating a resource.
        "selector": "A String", # Selects methods to which this rule applies.
            #
            # Refer to selector for syntax details.
        "delete": "A String", # Used for deleting a resource.
      },
    ],
  },
  "apis": [ # A list of API interfaces exported by this service. Only the `name` field
      # of the google.protobuf.Api needs to be provided by the configuration
      # author, as the remaining fields will be derived from the IDL during the
      # normalization process. It is an error to specify an API interface here
      # which cannot be resolved against the associated IDL files.
    { # Api is a light-weight descriptor for a protocol buffer service.
      "methods": [ # The methods of this api, in unspecified order.
        { # Method represents a method of an api.
          "name": "A String", # The simple name of this method.
          "requestStreaming": True or False, # If true, the request is streamed.
          "responseTypeUrl": "A String", # The URL of the output message type.
          "requestTypeUrl": "A String", # A URL of the input message type.
          "responseStreaming": True or False, # If true, the response is streamed.
          "syntax": "A String", # The source syntax of this method.
          "options": [ # Any metadata attached to the method.
            { # A protocol buffer option, which can be attached to a message, field,
                # enumeration, etc.
              "name": "A String", # The option's name. For example, `"java_package"`.
              "value": { # The option's value. For example, `"com.google.protobuf"`.
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            },
          ],
        },
      ],
      "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
          # message.
          # protobuf element, like the file in which it is defined.
        "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
            # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
      },
      "mixins": [ # Included APIs. See Mixin.
        { # Declares an API to be included in this API. The including API must
            # redeclare all the methods from the included API, but documentation
            # and options are inherited as follows:
            #
            # - If after comment and whitespace stripping, the documentation
            #   string of the redeclared method is empty, it will be inherited
            #   from the original method.
            #
            # - Each annotation belonging to the service config (http,
            #   visibility) which is not set in the redeclared method will be
            #   inherited.
            #
            # - If an http annotation is inherited, the path pattern will be
            #   modified as follows. Any version prefix will be replaced by the
            #   version of the including API plus the root path if specified.
            #
            # Example of a simple mixin:
            #
            #     package google.acl.v1;
            #     service AccessControl {
            #       // Get the underlying ACL object.
            #       rpc GetAcl(GetAclRequest) returns (Acl) {
            #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
            #       }
            #     }
            #
            #     package google.storage.v2;
            #     service Storage {
            #       //       rpc GetAcl(GetAclRequest) returns (Acl);
            #
            #       // Get a data record.
            #       rpc GetData(GetDataRequest) returns (Data) {
            #         option (google.api.http).get = "/v2/{resource=**}";
            #       }
            #     }
            #
            # Example of a mixin configuration:
            #
            #     apis:
            #     - name: google.storage.v2.Storage
            #       mixins:
            #       - name: google.acl.v1.AccessControl
            #
            # The mixin construct implies that all methods in `AccessControl` are
            # also declared with same name and request/response types in
            # `Storage`. A documentation generator or annotation processor will
            # see the effective `Storage.GetAcl` method after inherting
            # documentation and annotations as follows:
            #
            #     service Storage {
            #       // Get the underlying ACL object.
            #       rpc GetAcl(GetAclRequest) returns (Acl) {
            #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
            #       }
            #       ...
            #     }
            #
            # Note how the version in the path pattern changed from `v1` to `v2`.
            #
            # If the `root` field in the mixin is specified, it should be a
            # relative path under which inherited HTTP paths are placed. Example:
            #
            #     apis:
            #     - name: google.storage.v2.Storage
            #       mixins:
            #       - name: google.acl.v1.AccessControl
            #         root: acls
            #
            # This implies the following inherited HTTP annotation:
            #
            #     service Storage {
            #       // Get the underlying ACL object.
            #       rpc GetAcl(GetAclRequest) returns (Acl) {
            #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
            #       }
            #       ...
            #     }
          "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
              # are rooted.
          "name": "A String", # The fully qualified name of the API which is included.
        },
      ],
      "syntax": "A String", # The source syntax of the service.
      "version": "A String", # A version string for this api. If specified, must have the form
          # `major-version.minor-version`, as in `1.10`. If the minor version
          # is omitted, it defaults to zero. If the entire version field is
          # empty, the major version is derived from the package name, as
          # outlined below. If the field is not empty, the version in the
          # package name will be verified to be consistent with what is
          # provided here.
          #
          # The versioning schema uses [semantic
          # versioning](http://semver.org) where the major version number
          # indicates a breaking change and the minor version an additive,
          # non-breaking change. Both version numbers are signals to users
          # what to expect from different versions, and should be carefully
          # chosen based on the product plan.
          #
          # The major version is also reflected in the package name of the
          # API, which must end in `v`, as in
          # `google.feature.v1`. For major versions 0 and 1, the suffix can
          # be omitted. Zero major versions must only be used for
          # experimental, none-GA apis.
      "options": [ # Any metadata attached to the API.
        { # A protocol buffer option, which can be attached to a message, field,
            # enumeration, etc.
          "name": "A String", # The option's name. For example, `"java_package"`.
          "value": { # The option's value. For example, `"com.google.protobuf"`.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        },
      ],
      "name": "A String", # The fully qualified name of this api, including package name
          # followed by the api's simple name.
    },
  ],
  "customError": { # Customize service error responses.  For example, list any service # Custom error configuration.
      # specific protobuf types that can appear in error detail lists of
      # error responses.
      #
      # Example:
      #
      #     custom_error:
      #       types:
      #       - google.foo.v1.CustomError
      #       - google.foo.v1.AnotherError
    "rules": [ # The list of custom error rules that apply to individual API messages.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # A custom error rule.
        "isErrorType": True or False, # Mark this message as possible payload in error response.  Otherwise,
            # objects of this type will be filtered when they appear in error payload.
        "selector": "A String", # Selects messages to which this rule applies.
            #
            # Refer to selector for syntax details.
      },
    ],
    "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
      "A String",
    ],
  },
  "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
      # elements.  Restrictions are specified using visibility labels
      # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
      #
      # Users and projects can have access to more than one visibility label. The
      # effective visibility for multiple labels is the union of each label's
      # elements, plus any unrestricted elements.
      #
      # If an element and its parents have no restrictions, visibility is
      # unconditionally granted.
      #
      # Example:
      #
      #     visibility:
      #       rules:
      #       - selector: google.calendar.Calendar.EnhancedSearch
      #         restriction: TRUSTED_TESTER
      #       - selector: google.calendar.Calendar.Delegate
      #         restriction: GOOGLE_INTERNAL
      #
      # Here, all methods are publicly visible except for the restricted methods
      # EnhancedSearch and Delegate.
    "rules": [ # A list of visibility rules that apply to individual API elements.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # A visibility rule provides visibility configuration for an individual API
          # element.
        "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
            # Any of the listed labels can be used to grant the visibility.
            #
            # If a rule has multiple labels, removing one of the labels but not all of
            # them can break clients.
            #
            # Example:
            #
            #     visibility:
            #       rules:
            #       - selector: google.calendar.Calendar.EnhancedSearch
            #         restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
            #
            # Removing GOOGLE_INTERNAL from this restriction will break clients that
            # rely on this method and only had access to it through GOOGLE_INTERNAL.
        "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
            #
            # Refer to selector for syntax details.
      },
    ],
  },
  "metrics": [ # Defines the metrics used by this service.
    { # Defines a metric type and its schema.
      "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
          # Use sentence case without an ending period, for example "Request count".
      "description": "A String", # A detailed description of the metric, which can be used in documentation.
      "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
          # Some combinations of `metric_kind` and `value_type` might not be supported.
      "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
          # Some combinations of `metric_kind` and `value_type` might not be supported.
      "labels": [ # The set of labels that can be used to describe a specific instance of this
          # metric type. For example, the
          # `compute.googleapis.com/instance/network/received_bytes_count` metric type
          # has a label, `loadbalanced`, that specifies whether the traffic was
          # received through a load balanced IP address.
        { # A description of a label.
          "valueType": "A String", # The type of data that can be assigned to the label.
          "description": "A String", # A human-readable description for the label.
          "key": "A String", # The label key.
        },
      ],
      "type": "A String", # The metric type including a DNS name prefix, for example
          # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
          # should use a natural hierarchical grouping such as the following:
          #
          #     compute.googleapis.com/instance/cpu/utilization
          #     compute.googleapis.com/instance/disk/read_ops_count
          #     compute.googleapis.com/instance/network/received_bytes_count
          #
          # Note that if the metric type changes, the monitoring data will be
          # discontinued, and anything depends on it will break, such as monitoring
          # dashboards, alerting rules and quota limits. Therefore, once a metric has
          # been published, its type should be immutable.
      "unit": "A String", # The unit in which the metric value is reported. It is only applicable
          # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
          # supported units are a subset of [The Unified Code for Units of
          # Measure](http://unitsofmeasure.org/ucum.html) standard:
          #
          # **Basic units (UNIT)**
          #
          # * `bit`   bit
          # * `By`    byte
          # * `s`     second
          # * `min`   minute
          # * `h`     hour
          # * `d`     day
          #
          # **Prefixes (PREFIX)**
          #
          # * `k`     kilo    (10**3)
          # * `M`     mega    (10**6)
          # * `G`     giga    (10**9)
          # * `T`     tera    (10**12)
          # * `P`     peta    (10**15)
          # * `E`     exa     (10**18)
          # * `Z`     zetta   (10**21)
          # * `Y`     yotta   (10**24)
          # * `m`     milli   (10**-3)
          # * `u`     micro   (10**-6)
          # * `n`     nano    (10**-9)
          # * `p`     pico    (10**-12)
          # * `f`     femto   (10**-15)
          # * `a`     atto    (10**-18)
          # * `z`     zepto   (10**-21)
          # * `y`     yocto   (10**-24)
          # * `Ki`    kibi    (2**10)
          # * `Mi`    mebi    (2**20)
          # * `Gi`    gibi    (2**30)
          # * `Ti`    tebi    (2**40)
          #
          # **Grammar**
          #
          # The grammar includes the dimensionless unit `1`, such as `1/s`.
          #
          # The grammar also includes these connectors:
          #
          # * `/`    division (as an infix operator, e.g. `1/s`).
          # * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
          #
          # The grammar for a unit is as follows:
          #
          #     Expression = Component { "." Component } { "/" Component } ;
          #
          #     Component = [ PREFIX ] UNIT [ Annotation ]
          #               | Annotation
          #               | "1"
          #               ;
          #
          #     Annotation = "{" NAME "}" ;
          #
          # Notes:
          #
          # * `Annotation` is just a comment if it follows a `UNIT` and is
          #    equivalent to `1` if it is used alone. For examples,
          #    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
          # * `NAME` is a sequence of non-blank printable ASCII characters not
          #    containing '{' or '}'.
      "name": "A String", # Resource name. The format of the name may vary between different
          # implementations. For examples:
          #
          #     projects/{project_id}/metricDescriptors/{type=**}
          #     metricDescriptors/{type=**}
    },
  ],
  "enums": [ # A list of all enum types included in this API service.  Enums
      # referenced directly or indirectly by the `apis` are automatically
      # included.  Enums which are not referenced but shall be included
      # should be listed here by name. Example:
      # 
      #     enums:
      #     - name: google.someapi.v1.SomeEnum
    { # Enum type definition.
      "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
          # protobuf element, like the file in which it is defined.
        "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
            # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
      },
      "enumvalue": [ # Enum value definitions.
        { # Enum value definition.
          "number": 42, # Enum value number.
          "options": [ # Protocol buffer options.
            { # A protocol buffer option, which can be attached to a message, field,
                # enumeration, etc.
              "name": "A String", # The option's name. For example, `"java_package"`.
              "value": { # The option's value. For example, `"com.google.protobuf"`.
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            },
          ],
          "name": "A String", # Enum value name.
        },
      ],
      "options": [ # Protocol buffer options.
        { # A protocol buffer option, which can be attached to a message, field,
            # enumeration, etc.
          "name": "A String", # The option's name. For example, `"java_package"`.
          "value": { # The option's value. For example, `"com.google.protobuf"`.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        },
      ],
      "name": "A String", # Enum type name.
      "syntax": "A String", # The source syntax.
    },
  ],
  "types": [ # A list of all proto message types included in this API service.
      # Types referenced directly or indirectly by the `apis` are
      # automatically included.  Messages which are not referenced but
      # shall be included, such as types used by the `google.protobuf.Any` type,
      # should be listed here by name. Example:
      # 
      #     types:
      #     - name: google.protobuf.Int32
    { # A protocol buffer message type.
      "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
        "A String",
      ],
      "name": "A String", # The fully qualified message name.
      "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
          # protobuf element, like the file in which it is defined.
        "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
            # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
      },
      "syntax": "A String", # The source syntax.
      "fields": [ # The list of fields.
        { # A single field of a message type.
          "kind": "A String", # The field type.
          "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
              # types. The first type has index 1; zero means the type is not in the list.
          "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
              # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
          "name": "A String", # The field name.
          "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
          "jsonName": "A String", # The field JSON name.
          "number": 42, # The field number.
          "cardinality": "A String", # The field cardinality.
          "options": [ # The protocol buffer options.
            { # A protocol buffer option, which can be attached to a message, field,
                # enumeration, etc.
              "name": "A String", # The option's name. For example, `"java_package"`.
              "value": { # The option's value. For example, `"com.google.protobuf"`.
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            },
          ],
          "packed": True or False, # Whether to use alternative packed wire representation.
        },
      ],
      "options": [ # The protocol buffer options.
        { # A protocol buffer option, which can be attached to a message, field,
            # enumeration, etc.
          "name": "A String", # The option's name. For example, `"java_package"`.
          "value": { # The option's value. For example, `"com.google.protobuf"`.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        },
      ],
    },
  ],
  "logging": { # Logging configuration of the service. # Logging configuration.
      #
      # The following example shows how to configure logs to be sent to the
      # producer and consumer projects. In the example, the `activity_history`
      # log is sent to both the producer and consumer projects, whereas the
      # `purchase_history` log is only sent to the producer project.
      #
      #     monitored_resources:
      #     - type: library.googleapis.com/branch
      #       labels:
      #       - key: /city
      #         description: The city where the library branch is located in.
      #       - key: /name
      #         description: The name of the branch.
      #     logs:
      #     - name: activity_history
      #       labels:
      #       - key: /customer_id
      #     - name: purchase_history
      #     logging:
      #       producer_destinations:
      #       - monitored_resource: library.googleapis.com/branch
      #         logs:
      #         - activity_history
      #         - purchase_history
      #       consumer_destinations:
      #       - monitored_resource: library.googleapis.com/branch
      #         logs:
      #         - activity_history
    "producerDestinations": [ # Logging configurations for sending logs to the producer project.
        # There can be multiple producer destinations, each one must have a
        # different monitored resource type. A log can be used in at most
        # one producer destination.
      { # Configuration of a specific logging destination (the producer project
          # or the consumer project).
        "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
            # Service.monitored_resources section.
        "logs": [ # Names of the logs to be sent to this destination. Each name must
            # be defined in the Service.logs section. If the log name is
            # not a domain scoped name, it will be automatically prefixed with
            # the service name followed by "/".
          "A String",
        ],
      },
    ],
    "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
        # There can be multiple consumer destinations, each one must have a
        # different monitored resource type. A log can be used in at most
        # one consumer destination.
      { # Configuration of a specific logging destination (the producer project
          # or the consumer project).
        "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
            # Service.monitored_resources section.
        "logs": [ # Names of the logs to be sent to this destination. Each name must
            # be defined in the Service.logs section. If the log name is
            # not a domain scoped name, it will be automatically prefixed with
            # the service name followed by "/".
          "A String",
        ],
      },
    ],
  },
  "name": "A String", # The DNS address at which this service is available,
      # e.g. `calendar.googleapis.com`.
  "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
      #
      # Example:
      # 
documentation:
      #   summary: >
      #     The Google Calendar API gives access
      #     to most calendar features.
      #   pages:
      #   - name: Overview
      #     content: (== include google/foo/overview.md ==)
      #   - name: Tutorial
      #     content: (== include google/foo/tutorial.md ==)
      #     subpages;
      #     - name: Java
      #       content: (== include google/foo/tutorial_java.md ==)
      #   rules:
      #   - selector: google.calendar.Calendar.Get
      #     description: >
      #       ...
      #   - selector: google.calendar.Calendar.Put
      #     description: >
      #       ...
      # 

      # Documentation is provided in markdown syntax. In addition to
      # standard markdown features, definition lists, tables and fenced
      # code blocks are supported. Section headers can be provided and are
      # interpreted relative to the section nesting of the context where
      # a documentation fragment is embedded.
      #
      # Documentation from the IDL is merged with documentation defined
      # via the config at normalization time, where documentation provided
      # by config rules overrides IDL provided.
      #
      # A number of constructs specific to the API platform are supported
      # in documentation text.
      #
      # In order to reference a proto element, the following
      # notation can be used:
      # 
[fully.qualified.proto.name][]

      # To override the display text used for the link, this can be used:
      # 
[display text][fully.qualified.proto.name]

      # Text can be excluded from doc using the following notation:
      # 
(-- internal comment --)

      # Comments can be made conditional using a visibility label. The below
      # text will be only rendered if the `BETA` label is available:
      # 
(--BETA: comment for BETA users --)

      # A few directives are available in documentation. Note that
      # directives must appear on a single line to be properly
      # identified. The `include` directive includes a markdown file from
      # an external source:
      # 
(== include path/to/file ==)

      # The `resource_for` directive marks a message to be the resource of
      # a collection in REST view. If it is not specified, tools attempt
      # to infer the resource from the operations in a collection:
      # 
(== resource_for v1.shelves.books ==)

      # The directive `suppress_warning` does not directly affect documentation
      # and is documented together with service config validation.
    "rules": [ # A list of documentation rules that apply to individual API elements.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # A documentation rule provides information about individual API elements.
        "description": "A String", # Description of the selected API(s).
        "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
            # element is marked as `deprecated`.
        "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
            # qualified name of the element which may end in "*", indicating a wildcard.
            # Wildcards are only allowed at the end and for a whole component of the
            # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
            # specify a default for all applicable elements, the whole pattern "*"
            # is used.
      },
    ],
    "overview": "A String", # Declares a single overview page. For example:
        # 
documentation:
        #   summary: ...
        #   overview: (== include overview.md ==)
        # 

        # This is a shortcut for the following declaration (using pages style):
        # 
documentation:
        #   summary: ...
        #   pages:
        #   - name: Overview
        #     content: (== include overview.md ==)
        # 

        # Note: you cannot specify both `overview` field and `pages` field.
    "summary": "A String", # A short summary of what the service does. Can only be provided by
        # plain text.
    "pages": [ # The top level pages for the documentation set.
      { # Represents a documentation page. A page can contain subpages to represent
          # nested documentation set structure.
        "content": "A String", # The Markdown content of the page. You can use (== include {path} ==)
            # to include content from a Markdown file.
        "subpages": [ # Subpages of this page. The order of subpages specified here will be
            # honored in the generated docset.
          # Object with schema name: Page
        ],
        "name": "A String", # The name of the page. It will be used as an identity of the page to
            # generate URI of the page, text of the link to this page in navigation,
            # etc. The full page name (start from the root page name to this page
            # concatenated with `.`) can be used as reference to the page in your
            # documentation. For example:
            # 
pages:
            # - name: Tutorial
            #   content: (== include tutorial.md ==)
            #   subpages:
            #   - name: Java
            #     content: (== include tutorial_java.md ==)
            # 

            # You can reference `Java` page using Markdown reference link syntax:
            # `Java`.
      },
    ],
    "documentationRootUrl": "A String", # The URL to the root of documentation.
  },
  "systemTypes": [ # A list of all proto message types included in this API service.
      # It serves similar purpose as [google.api.Service.types], except that
      # these types are not needed by user-defined APIs. Therefore, they will not
      # show up in the generated discovery doc. This field should only be used
      # to define system APIs in ESF.
    { # A protocol buffer message type.
      "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
        "A String",
      ],
      "name": "A String", # The fully qualified message name.
      "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
          # protobuf element, like the file in which it is defined.
        "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
            # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
      },
      "syntax": "A String", # The source syntax.
      "fields": [ # The list of fields.
        { # A single field of a message type.
          "kind": "A String", # The field type.
          "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
              # types. The first type has index 1; zero means the type is not in the list.
          "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
              # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
          "name": "A String", # The field name.
          "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
          "jsonName": "A String", # The field JSON name.
          "number": 42, # The field number.
          "cardinality": "A String", # The field cardinality.
          "options": [ # The protocol buffer options.
            { # A protocol buffer option, which can be attached to a message, field,
                # enumeration, etc.
              "name": "A String", # The option's name. For example, `"java_package"`.
              "value": { # The option's value. For example, `"com.google.protobuf"`.
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            },
          ],
          "packed": True or False, # Whether to use alternative packed wire representation.
        },
      ],
      "options": [ # The protocol buffer options.
        { # A protocol buffer option, which can be attached to a message, field,
            # enumeration, etc.
          "name": "A String", # The option's name. For example, `"java_package"`.
          "value": { # The option's value. For example, `"com.google.protobuf"`.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        },
      ],
    },
  ],
  "context": { # `Context` defines which contexts an API requests. # Context configuration.
      #
      # Example:
      #
      #     context:
      #       rules:
      #       - selector: "*"
      #         requested:
      #         - google.rpc.context.ProjectContext
      #         - google.rpc.context.OriginContext
      #
      # The above specifies that all methods in the API request
      # `google.rpc.context.ProjectContext` and
      # `google.rpc.context.OriginContext`.
      #
      # Available context types are defined in package
      # `google.rpc.context`.
    "rules": [ # A list of RPC context rules that apply to individual API methods.
        #
        # **NOTE:** All service configuration rules follow "last one wins" order.
      { # A context rule provides information about the context for an individual API
          # element.
        "provided": [ # A list of full type names of provided contexts.
          "A String",
        ],
        "requested": [ # A list of full type names of requested contexts.
          "A String",
        ],
        "selector": "A String", # Selects the methods to which this rule applies.
            #
            # Refer to selector for syntax details.
      },
    ],
  },
  "endpoints": [ # Configuration for network endpoints.  If this is empty, then an endpoint
      # with the same name as the service is automatically generated to service all
      # defined APIs.
    { # `Endpoint` describes a network endpoint that serves a set of APIs.
        # A service may expose any number of endpoints, and all endpoints share the
        # same service configuration, such as quota configuration and monitoring
        # configuration.
        #
        # Example service configuration:
        #
        #     name: library-example.googleapis.com
        #     endpoints:
        #       # Below entry makes 'google.example.library.v1.Library'
        #       # API be served from endpoint address library-example.googleapis.com.
        #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
        #       # it to decide whether the subsequent cross-origin request is
        #       # allowed to proceed.
        #     - name: library-example.googleapis.com
        #       apis: google.example.library.v1.Library
        #       allow_cors: true
        #       # Below entry makes 'google.example.library.v1.Library'
        #       # API be served from endpoint address
        #       # google.example.library-example.v1.LibraryManager.
        #     - name: library-manager.googleapis.com
        #       apis: google.example.library.v1.LibraryManager
        #       # BNS address for a borg job. Can specify a task by appending
        #       # "/taskId" (e.g. "/0") to the job spec.
        #
        # Example OpenAPI extension for endpoint with allow_cors set to true:
        #
        #     {
        #       "swagger": "2.0",
        #       "info": {
        #         "description": "A simple..."
        #       },
        #       "host": "MY_PROJECT_ID.appspot.com",
        #       "x-google-endpoints": [{
        #         "name": "MY_PROJECT_ID.appspot.com",
        #         "allow_cors": "true"
        #       }]
        #     }
      "allowCors": True or False, # Allowing
          # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
          # cross-domain traffic, would allow the backends served from this endpoint to
          # receive and respond to HTTP OPTIONS requests. The response will be used by
          # the browser to determine whether the subsequent cross-origin request is
          # allowed to proceed.
      "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
          # please specify multiple google.api.Endpoint for each of the intented
          # alias.
          #
          # Additional names that this endpoint will be hosted on.
        "A String",
      ],
      "features": [ # The list of features enabled on this endpoint.
        "A String",
      ],
      "name": "A String", # The canonical name of this endpoint.
      "apis": [ # The list of APIs served by this endpoint.
        "A String",
      ],
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Service` is the root object of Google service configuration schema. It
      # describes basic information about a service, such as the name and the
      # title, and delegates other aspects to sub-sections. Each sub-section is
      # either a proto message or a repeated proto message that configures a
      # specific aspect, such as auth. See each proto message definition for details.
      #
      # Example:
      #
      #     type: google.api.Service
      #     config_version: 3
      #     name: calendar.googleapis.com
      #     title: Google Calendar API
      #     apis:
      #     - name: google.calendar.v3.Calendar
      #     backend:
      #       rules:
      #       - selector: "google.calendar.v3.*"
      #         address: calendar.example.com
    "control": { # Selects and configures the service controller used by the service.  The # Configuration for the service control plane.
        # service controller handles features like abuse, quota, billing, logging,
        # monitoring, etc.
      "environment": "A String", # The service control environment to use. If empty, no control plane
          # feature (like quota and billing) will be enabled.
    },
    "monitoredResources": [ # Defines the monitored resources used by this service. This is required
        # by the Service.monitoring and Service.logging configurations.
      { # An object that describes the schema of a MonitoredResource object using a
          # type name and a set of labels.  For example, the monitored resource
          # descriptor for Google Compute Engine VM instances has a type of
          # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
          # `"zone"` to identify particular VM instances.
          #
          # Different APIs can support different monitored resource types. APIs generally
          # provide a `list` method that returns the monitored resource descriptors used
          # by the API.
        "type": "A String", # Required. The monitored resource type. For example, the type
            # `"cloudsql_database"` represents databases in Google Cloud SQL.
            # The maximum length of this value is 256 characters.
        "labels": [ # Required. A set of labels used to describe instances of this monitored
            # resource type. For example, an individual Google Cloud SQL database is
            # identified by values for the labels `"database_id"` and `"zone"`.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
            # displayed in user interfaces. It should be a Title Cased Noun Phrase,
            # without any article or other determiners. For example,
            # `"Google Cloud SQL Database"`.
        "description": "A String", # Optional. A detailed description of the monitored resource type that might
            # be used in documentation.
        "name": "A String", # Optional. The resource name of the monitored resource descriptor:
            # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
            # {type} is the value of the `type` field in this object and
            # {project_id} is a project ID that provides API-specific context for
            # accessing the type.  APIs that do not use project information can use the
            # resource name format `"monitoredResourceDescriptors/{type}"`.
      },
    ],
    "logs": [ # Defines the logs used by this service.
      { # A description of a log type. Example in YAML format:
          #
          #     - name: library.googleapis.com/activity_history
          #       description: The history of borrowing and returning library items.
          #       display_name: Activity
          #       labels:
          #       - key: /customer_id
          #         description: Identifier of a library customer
        "labels": [ # The set of labels that are available to describe a specific log entry.
            # Runtime requests that contain labels not specified here are
            # considered invalid.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # The human-readable name for this log. This information appears on
            # the user interface and should be concise.
        "description": "A String", # A human-readable description of this log. This information appears in
            # the documentation and can contain details.
        "name": "A String", # The name of the log. It must be less than 512 characters long and can
            # include the following characters: upper- and lower-case alphanumeric
            # characters [A-Za-z0-9], and punctuation characters including
            # slash, underscore, hyphen, period [/_-.].
      },
    ],
    "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
        #
        # Analytics configuration.
        #
        # The example below shows how to configure monitored resources and metrics
        # for analytics. In the example, a monitored resource and two metrics are
        # defined. The `library.googleapis.com/book/returned_count` and
        # `library.googleapis.com/book/overdue_count` metric are sent
        # to the analytics.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     metrics:
        #     - name: library.googleapis.com/book/returned_count
        #       metric_kind: DELTA
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     - name: library.googleapis.com/book/overdue_count
        #       metric_kind: GAUGE
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     analytics:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #         - library.googleapis.com/book/overdue_count
      "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one producer destination.
        { # Configuration of a specific analytics destination.
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this analytics destination.
              # Each name must be defined in Service.metrics section. Metrics
              # with value type BOOL and STRING must be of GUAGE kind, metrics with
              # value type INT64, DOUBLE and MONEY must be of DELTA kind.
            "A String",
          ],
        },
      ],
    },
    "systemParameters": { # ### System parameter configuration # System parameter configuration.
        #
        # A system parameter is a special kind of parameter defined by the API
        # system, not by an individual API. It is typically mapped to an HTTP header
        # and/or a URL query parameter. This configuration specifies which methods
        # change the names of the system parameters.
      "rules": [ # Define system parameters.
          #
          # The parameters defined here will override the default parameters
          # implemented by the system. If this field is missing from the service
          # config, default system parameters will be used. Default system parameters
          # and names is implementation-dependent.
          #
          # Example: define api key and alt name for all methods
          #
          # system_parameters
          #   rules:
          #     - selector: "*"
          #       parameters:
          #         - name: api_key
          #           url_query_parameter: api_key
          #         - name: alt
          #           http_header: Response-Content-Type
          #
          # Example: define 2 api key names for a specific method.
          #
          # system_parameters
          #   rules:
          #     - selector: "/ListShelves"
          #       parameters:
          #         - name: api_key
          #           http_header: Api-Key1
          #         - name: api_key
          #           http_header: Api-Key2
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Define a system parameter rule mapping system parameter definitions to
            # methods.
          "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
              # For a given method call, only one of them should be used. If multiple
              # names are used the behavior is implementation-dependent.
              # If none of the specified names are present the behavior is
              # parameter-dependent.
            { # Define a parameter's name and location. The parameter may be passed as either
                # an HTTP header or a URL query parameter, and if both are passed the behavior
                # is implementation-dependent.
              "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
                  # sensitive.
              "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
                  # and etc. It is case sensitive.
              "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
                  # insensitive.
            },
          ],
          "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
              # methods in all APIs.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
      "rules": [ # A list of API backend rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A backend rule provides configuration for an individual API element.
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
          "deadline": 3.14, # The number of seconds to wait for a response from a request.  The
              # default depends on the deployment context.
          "address": "A String", # The address of the API backend.
        },
      ],
    },
    "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
        #
        # The example below shows how to configure monitored resources and metrics
        # for monitoring. In the example, a monitored resource and two metrics are
        # defined. The `library.googleapis.com/book/returned_count` metric is sent
        # to both producer and consumer projects, whereas the
        # `library.googleapis.com/book/overdue_count` metric is only sent to the
        # consumer project.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     metrics:
        #     - name: library.googleapis.com/book/returned_count
        #       metric_kind: DELTA
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     - name: library.googleapis.com/book/overdue_count
        #       metric_kind: GAUGE
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     monitoring:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #       consumer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #         - library.googleapis.com/book/overdue_count
      "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one producer destination.
        { # Configuration of a specific monitoring destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this monitoring destination.
              # Each name must be defined in Service.metrics section.
            "A String",
          ],
        },
      ],
      "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
          # There can be multiple consumer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one consumer destination.
        { # Configuration of a specific monitoring destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this monitoring destination.
              # Each name must be defined in Service.metrics section.
            "A String",
          ],
        },
      ],
    },
    "title": "A String", # The product title associated with this service.
    "id": "A String", # A unique ID for a specific instance of this message, typically assigned
        # by the client for tracking purpose. If empty, the server may choose to
        # generate one instead.
    "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
        #
        # Example for an API targeted for external use:
        #
        #     name: calendar.googleapis.com
        #     authentication:
        #       rules:
        #       - selector: "*"
        #         oauth:
        #           canonical_scopes: https://www.googleapis.com/auth/calendar
        #
        #       - selector: google.calendar.Delegate
        #         oauth:
        #           canonical_scopes: https://www.googleapis.com/auth/calendar.read
      "rules": [ # A list of authentication rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Authentication rules for the service.
            #
            # By default, if a method has any authentication requirements, every request
            # must include a valid credential matching one of the requirements.
            # It's an error to include more than one kind of credential in a single
            # request.
            #
            # If a method doesn't have any auth requirements, request credentials will be
            # ignored.
          "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
              # there are scopes defined for "Read-only access to Google Calendar" and
              # "Access to Cloud Platform". Users can consent to a scope for an application,
              # giving it permission to access that data on their behalf.
              #
              # OAuth scope specifications should be fairly coarse grained; a user will need
              # to see and understand the text description of what your scope means.
              #
              # In most cases: use one or at most two OAuth scopes for an entire family of
              # products. If your product has multiple APIs, you should probably be sharing
              # the OAuth scope across all of those APIs.
              #
              # When you need finer grained OAuth consent screens: talk with your product
              # management about how developers will use them in practice.
              #
              # Please note that even though each of the canonical scopes is enough for a
              # request to be accepted and passed to the backend, a request can still fail
              # due to the backend requiring additional scopes or permissions.
            "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
                # OAuth token containing any of these scopes will be accepted.
                #
                # Example:
                #
                #      canonical_scopes: https://www.googleapis.com/auth/calendar,
                #                        https://www.googleapis.com/auth/calendar.read
          },
          "requirements": [ # Requirements for additional authentication providers.
            { # User-defined authentication requirements, including support for
                # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
              "providerId": "A String", # id from authentication provider.
                  #
                  # Example:
                  #
                  #     provider_id: bookstore_auth
              "audiences": "A String", # The list of JWT
                  # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
                  # that are allowed to access. A JWT containing any of these audiences will
                  # be accepted. When this setting is absent, only JWTs with audience
                  # "https://Service_name/API_name"
                  # will be accepted. For example, if no audiences are in the setting,
                  # LibraryService API will only accept JWTs with the following audience
                  # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
                  #
                  # Example:
                  #
                  #     audiences: bookstore_android.apps.googleusercontent.com,
                  #                bookstore_web.apps.googleusercontent.com
            },
          ],
          "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
              # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
              #
              # For requests without credentials, if the service control environment is
              # specified, each incoming request **must** be associated with a service
              # consumer. This can be done by passing an API key that belongs to a consumer
              # project.
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
      "providers": [ # Defines a set of authentication providers that a service supports.
        { # Configuration for an anthentication provider, including support for
            # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
          "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
              # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
              # Optional if the key set document:
              #  - can be retrieved from
              #    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
              #    of the issuer.
              #  - can be inferred from the email domain of the issuer (e.g. a Google service account).
              #
              # Example: https://www.googleapis.com/oauth2/v1/certs
          "id": "A String", # The unique identifier of the auth provider. It will be referred to by
              # `AuthRequirement.provider_id`.
              #
              # Example: "bookstore_auth".
          "issuer": "A String", # Identifies the principal that issued the JWT. See
              # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
              # Usually a URL or an email address.
              #
              # Example: https://securetoken.google.com
              # Example: 1234567-compute@developer.gserviceaccount.com
        },
      ],
    },
    "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
      "rules": [ # A list of usage rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Usage configuration rules for the service.
            #
            # NOTE: Under development.
            #
            #
            # Use this rule to configure unregistered calls for the service. Unregistered
            # calls are calls that do not contain consumer project identity.
            # (Example: calls that do not contain an API key).
            # By default, API methods do not allow unregistered calls, and each method call
            # must be identified by a consumer project identity. Use this rule to
            # allow/disallow unregistered calls.
            #
            # Example of an API that wants to allow unregistered calls for entire service.
            #
            #     usage:
            #       rules:
            #       - selector: "*"
            #         allow_unregistered_calls: true
            #
            # Example of a method that wants to allow unregistered calls.
            #
            #     usage:
            #       rules:
            #       - selector: "google.example.library.v1.LibraryService.CreateBook"
            #         allow_unregistered_calls: true
          "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
              # methods in all APIs.
              #
              # Refer to selector for syntax details.
          "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
        },
      ],
      "requirements": [ # Requirements that must be satisfied before a consumer project can use the
          # service. Each requirement is of the form /;
          # for example 'serviceusage.googleapis.com/billing-enabled'.
        "A String",
      ],
    },
    "configVersion": 42, # The version of the service configuration. The config version may
        # influence interpretation of the configuration, for example, to
        # determine defaults. This is documented together with applicable
        # options. The current default for the config version itself is `3`.
    "producerProjectId": "A String", # The id of the Google developer project that owns the service.
        # Members of this project can manage the service configuration,
        # manage consumption of the service, etc.
    "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
        # HttpRule, each specifying the mapping of an RPC method
        # to one or more HTTP REST API methods.
      "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
            # REST APIs.  The mapping determines what portions of the request
            # message are populated from the path, query parameters, or body of
            # the HTTP request.  The mapping is typically specified as an
            # `google.api.http` annotation, see "google/api/annotations.proto"
            # for details.
            #
            # The mapping consists of a field specifying the path template and
            # method kind.  The path template can refer to fields in the request
            # message, as in the example below which describes a REST GET
            # operation on a resource collection of messages:
            #
            # ```proto
            # service Messaging {
            #   rpc GetMessage(GetMessageRequest) returns (Message) {
            #     option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
            #   }
            # }
            # message GetMessageRequest {
            #   message SubMessage {
            #     string subfield = 1;
            #   }
            #   string message_id = 1; // mapped to the URL
            #   SubMessage sub = 2;    // `sub.subfield` is url-mapped
            # }
            # message Message {
            #   string text = 1; // content of the resource
            # }
            # ```
            #
            # This definition enables an automatic, bidrectional mapping of HTTP
            # JSON to RPC. Example:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
            #
            # In general, not only fields but also field paths can be referenced
            # from a path pattern. Fields mapped to the path pattern cannot be
            # repeated and must have a primitive (non-message) type.
            #
            # Any fields in the request message which are not bound by the path
            # pattern automatically become (optional) HTTP query
            # parameters. Assume the following definition of the request message:
            #
            # ```proto
            # message GetMessageRequest {
            #   message SubMessage {
            #     string subfield = 1;
            #   }
            #   string message_id = 1; // mapped to the URL
            #   int64 revision = 2;    // becomes a parameter
            #   SubMessage sub = 3;    // `sub.subfield` becomes a parameter
            # }
            # ```
            #
            # This enables a HTTP JSON to RPC mapping as below:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
            #
            # Note that fields which are mapped to HTTP parameters must have a
            # primitive type or a repeated primitive type. Message types are not
            # allowed. In the case of a repeated type, the parameter can be
            # repeated in the URL, as in `...?param=A¶m=B`.
            #
            # For HTTP method kinds which allow a request body, the `body` field
            # specifies the mapping. Consider a REST update method on the
            # message resource collection:
            #
            # ```proto
            # service Messaging {
            #   rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
            #     option (google.api.http) = {
            #       put: "/v1/messages/{message_id}"
            #       body: "message"
            #     };
            #   }
            # }
            # message UpdateMessageRequest {
            #   string message_id = 1; // mapped to the URL
            #   Message message = 2;   // mapped to the body
            # }
            # ```
            #
            # The following HTTP JSON to RPC mapping is enabled, where the
            # representation of the JSON in the request body is determined by
            # protos JSON encoding:
            #
            # HTTP | RPC
            # -----|-----
            # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
            #
            # The special name `*` can be used in the body mapping to define that
            # every field not bound by the path template should be mapped to the
            # request body.  This enables the following alternative definition of
            # the update method:
            #
            # ```proto
            # service Messaging {
            #   rpc UpdateMessage(Message) returns (Message) {
            #     option (google.api.http) = {
            #       put: "/v1/messages/{message_id}"
            #       body: "*"
            #     };
            #   }
            # }
            # message Message {
            #   string message_id = 1;
            #   string text = 2;
            # }
            # ```
            #
            # The following HTTP JSON to RPC mapping is enabled:
            #
            # HTTP | RPC
            # -----|-----
            # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
            #
            # Note that when using `*` in the body mapping, it is not possible to
            # have HTTP parameters, as all fields not bound by the path end in
            # the body. This makes this option more rarely used in practice of
            # defining REST APIs. The common usage of `*` is in custom methods
            # which don't use the URL at all for transferring data.
            #
            # It is possible to define multiple HTTP methods for one RPC by using
            # the `additional_bindings` option. Example:
            #
            # ```proto
            # service Messaging {
            #   rpc GetMessage(GetMessageRequest) returns (Message) {
            #     option (google.api.http) = {
            #       get: "/v1/messages/{message_id}"
            #       additional_bindings {
            #         get: "/v1/users/{user_id}/messages/{message_id}"
            #       }
            #     };
            #   }
            # }
            # message GetMessageRequest {
            #   string message_id = 1;
            #   string user_id = 2;
            # }
            # ```
            #
            # This enables the following two alternative HTTP JSON to RPC
            # mappings:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
            # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
            #
            # # Rules for HTTP mapping
            #
            # The rules for mapping HTTP path, query parameters, and body fields
            # to the request message are as follows:
            #
            # 1. The `body` field specifies either `*` or a field path, or is
            #    omitted. If omitted, it assumes there is no HTTP body.
            # 2. Leaf fields (recursive expansion of nested messages in the
            #    request) can be classified into three types:
            #     (a) Matched in the URL template.
            #     (b) Covered by body (if body is `*`, everything except (a) fields;
            #         else everything under the body field)
            #     (c) All other fields.
            # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
            # 4. Any body sent with an HTTP request can contain only (b) fields.
            #
            # The syntax of the path template is as follows:
            #
            #     Template = "/" Segments [ Verb ] ;
            #     Segments = Segment { "/" Segment } ;
            #     Segment  = "*" | "**" | LITERAL | Variable ;
            #     Variable = "{" FieldPath [ "=" Segments ] "}" ;
            #     FieldPath = IDENT { "." IDENT } ;
            #     Verb     = ":" LITERAL ;
            #
            # The syntax `*` matches a single path segment. It follows the semantics of
            # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
            # Expansion.
            #
            # The syntax `**` matches zero or more path segments. It follows the semantics
            # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
            # Expansion.
            #
            # The syntax `LITERAL` matches literal text in the URL path.
            #
            # The syntax `Variable` matches the entire path as specified by its template;
            # this nested template must not contain further variables. If a variable
            # matches a single path segment, its template may be omitted, e.g. `{var}`
            # is equivalent to `{var=*}`.
            #
            # NOTE: the field paths in variables and in the `body` must not refer to
            # repeated fields or map fields.
            #
            # Use CustomHttpPattern to specify any HTTP method that is not included in the
            # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
            # a given URL path rule. The wild-card rule is useful for services that provide
            # content to Web (HTML) clients.
          "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
              # `*` for mapping all fields not captured by the path pattern to the HTTP
              # body. NOTE: the referred field must not be a repeated field and must be
              # present at the top-level of response message type.
          "get": "A String", # Used for listing and getting information about resources.
          "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
            "enabled": True or False, # Whether download is enabled.
          },
          "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
              # not contain an `additional_bindings` field themselves (that is,
              # the nesting may only be one level deep).
            # Object with schema name: HttpRule
          ],
          "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
            "enabled": True or False, # Whether upload is enabled.
          },
          "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
            "path": "A String", # The path matched by this custom verb.
            "kind": "A String", # The name of this custom HTTP verb.
          },
          "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
              # response. Other response fields are ignored. This field is optional. When
              # not set, the response message will be used as HTTP body of response.
              # NOTE: the referred field must be not a repeated field and must be present
              # at the top-level of response message type.
          "put": "A String", # Used for updating a resource.
          "patch": "A String", # Used for updating a resource.
          "post": "A String", # Used for creating a resource.
          "selector": "A String", # Selects methods to which this rule applies.
              #
              # Refer to selector for syntax details.
          "delete": "A String", # Used for deleting a resource.
        },
      ],
    },
    "apis": [ # A list of API interfaces exported by this service. Only the `name` field
        # of the google.protobuf.Api needs to be provided by the configuration
        # author, as the remaining fields will be derived from the IDL during the
        # normalization process. It is an error to specify an API interface here
        # which cannot be resolved against the associated IDL files.
      { # Api is a light-weight descriptor for a protocol buffer service.
        "methods": [ # The methods of this api, in unspecified order.
          { # Method represents a method of an api.
            "name": "A String", # The simple name of this method.
            "requestStreaming": True or False, # If true, the request is streamed.
            "responseTypeUrl": "A String", # The URL of the output message type.
            "requestTypeUrl": "A String", # A URL of the input message type.
            "responseStreaming": True or False, # If true, the response is streamed.
            "syntax": "A String", # The source syntax of this method.
            "options": [ # Any metadata attached to the method.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
          },
        ],
        "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
            # message.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "mixins": [ # Included APIs. See Mixin.
          { # Declares an API to be included in this API. The including API must
              # redeclare all the methods from the included API, but documentation
              # and options are inherited as follows:
              #
              # - If after comment and whitespace stripping, the documentation
              #   string of the redeclared method is empty, it will be inherited
              #   from the original method.
              #
              # - Each annotation belonging to the service config (http,
              #   visibility) which is not set in the redeclared method will be
              #   inherited.
              #
              # - If an http annotation is inherited, the path pattern will be
              #   modified as follows. Any version prefix will be replaced by the
              #   version of the including API plus the root path if specified.
              #
              # Example of a simple mixin:
              #
              #     package google.acl.v1;
              #     service AccessControl {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
              #       }
              #     }
              #
              #     package google.storage.v2;
              #     service Storage {
              #       //       rpc GetAcl(GetAclRequest) returns (Acl);
              #
              #       // Get a data record.
              #       rpc GetData(GetDataRequest) returns (Data) {
              #         option (google.api.http).get = "/v2/{resource=**}";
              #       }
              #     }
              #
              # Example of a mixin configuration:
              #
              #     apis:
              #     - name: google.storage.v2.Storage
              #       mixins:
              #       - name: google.acl.v1.AccessControl
              #
              # The mixin construct implies that all methods in `AccessControl` are
              # also declared with same name and request/response types in
              # `Storage`. A documentation generator or annotation processor will
              # see the effective `Storage.GetAcl` method after inherting
              # documentation and annotations as follows:
              #
              #     service Storage {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
              #       }
              #       ...
              #     }
              #
              # Note how the version in the path pattern changed from `v1` to `v2`.
              #
              # If the `root` field in the mixin is specified, it should be a
              # relative path under which inherited HTTP paths are placed. Example:
              #
              #     apis:
              #     - name: google.storage.v2.Storage
              #       mixins:
              #       - name: google.acl.v1.AccessControl
              #         root: acls
              #
              # This implies the following inherited HTTP annotation:
              #
              #     service Storage {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
              #       }
              #       ...
              #     }
            "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
                # are rooted.
            "name": "A String", # The fully qualified name of the API which is included.
          },
        ],
        "syntax": "A String", # The source syntax of the service.
        "version": "A String", # A version string for this api. If specified, must have the form
            # `major-version.minor-version`, as in `1.10`. If the minor version
            # is omitted, it defaults to zero. If the entire version field is
            # empty, the major version is derived from the package name, as
            # outlined below. If the field is not empty, the version in the
            # package name will be verified to be consistent with what is
            # provided here.
            #
            # The versioning schema uses [semantic
            # versioning](http://semver.org) where the major version number
            # indicates a breaking change and the minor version an additive,
            # non-breaking change. Both version numbers are signals to users
            # what to expect from different versions, and should be carefully
            # chosen based on the product plan.
            #
            # The major version is also reflected in the package name of the
            # API, which must end in `v`, as in
            # `google.feature.v1`. For major versions 0 and 1, the suffix can
            # be omitted. Zero major versions must only be used for
            # experimental, none-GA apis.
        "options": [ # Any metadata attached to the API.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "name": "A String", # The fully qualified name of this api, including package name
            # followed by the api's simple name.
      },
    ],
    "customError": { # Customize service error responses.  For example, list any service # Custom error configuration.
        # specific protobuf types that can appear in error detail lists of
        # error responses.
        #
        # Example:
        #
        #     custom_error:
        #       types:
        #       - google.foo.v1.CustomError
        #       - google.foo.v1.AnotherError
      "rules": [ # The list of custom error rules that apply to individual API messages.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A custom error rule.
          "isErrorType": True or False, # Mark this message as possible payload in error response.  Otherwise,
              # objects of this type will be filtered when they appear in error payload.
          "selector": "A String", # Selects messages to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
      "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
        "A String",
      ],
    },
    "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
        # elements.  Restrictions are specified using visibility labels
        # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
        #
        # Users and projects can have access to more than one visibility label. The
        # effective visibility for multiple labels is the union of each label's
        # elements, plus any unrestricted elements.
        #
        # If an element and its parents have no restrictions, visibility is
        # unconditionally granted.
        #
        # Example:
        #
        #     visibility:
        #       rules:
        #       - selector: google.calendar.Calendar.EnhancedSearch
        #         restriction: TRUSTED_TESTER
        #       - selector: google.calendar.Calendar.Delegate
        #         restriction: GOOGLE_INTERNAL
        #
        # Here, all methods are publicly visible except for the restricted methods
        # EnhancedSearch and Delegate.
      "rules": [ # A list of visibility rules that apply to individual API elements.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A visibility rule provides visibility configuration for an individual API
            # element.
          "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
              # Any of the listed labels can be used to grant the visibility.
              #
              # If a rule has multiple labels, removing one of the labels but not all of
              # them can break clients.
              #
              # Example:
              #
              #     visibility:
              #       rules:
              #       - selector: google.calendar.Calendar.EnhancedSearch
              #         restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
              #
              # Removing GOOGLE_INTERNAL from this restriction will break clients that
              # rely on this method and only had access to it through GOOGLE_INTERNAL.
          "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "metrics": [ # Defines the metrics used by this service.
      { # Defines a metric type and its schema.
        "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
            # Use sentence case without an ending period, for example "Request count".
        "description": "A String", # A detailed description of the metric, which can be used in documentation.
        "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
            # Some combinations of `metric_kind` and `value_type` might not be supported.
        "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
            # Some combinations of `metric_kind` and `value_type` might not be supported.
        "labels": [ # The set of labels that can be used to describe a specific instance of this
            # metric type. For example, the
            # `compute.googleapis.com/instance/network/received_bytes_count` metric type
            # has a label, `loadbalanced`, that specifies whether the traffic was
            # received through a load balanced IP address.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "type": "A String", # The metric type including a DNS name prefix, for example
            # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
            # should use a natural hierarchical grouping such as the following:
            #
            #     compute.googleapis.com/instance/cpu/utilization
            #     compute.googleapis.com/instance/disk/read_ops_count
            #     compute.googleapis.com/instance/network/received_bytes_count
            #
            # Note that if the metric type changes, the monitoring data will be
            # discontinued, and anything depends on it will break, such as monitoring
            # dashboards, alerting rules and quota limits. Therefore, once a metric has
            # been published, its type should be immutable.
        "unit": "A String", # The unit in which the metric value is reported. It is only applicable
            # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
            # supported units are a subset of [The Unified Code for Units of
            # Measure](http://unitsofmeasure.org/ucum.html) standard:
            #
            # **Basic units (UNIT)**
            #
            # * `bit`   bit
            # * `By`    byte
            # * `s`     second
            # * `min`   minute
            # * `h`     hour
            # * `d`     day
            #
            # **Prefixes (PREFIX)**
            #
            # * `k`     kilo    (10**3)
            # * `M`     mega    (10**6)
            # * `G`     giga    (10**9)
            # * `T`     tera    (10**12)
            # * `P`     peta    (10**15)
            # * `E`     exa     (10**18)
            # * `Z`     zetta   (10**21)
            # * `Y`     yotta   (10**24)
            # * `m`     milli   (10**-3)
            # * `u`     micro   (10**-6)
            # * `n`     nano    (10**-9)
            # * `p`     pico    (10**-12)
            # * `f`     femto   (10**-15)
            # * `a`     atto    (10**-18)
            # * `z`     zepto   (10**-21)
            # * `y`     yocto   (10**-24)
            # * `Ki`    kibi    (2**10)
            # * `Mi`    mebi    (2**20)
            # * `Gi`    gibi    (2**30)
            # * `Ti`    tebi    (2**40)
            #
            # **Grammar**
            #
            # The grammar includes the dimensionless unit `1`, such as `1/s`.
            #
            # The grammar also includes these connectors:
            #
            # * `/`    division (as an infix operator, e.g. `1/s`).
            # * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
            #
            # The grammar for a unit is as follows:
            #
            #     Expression = Component { "." Component } { "/" Component } ;
            #
            #     Component = [ PREFIX ] UNIT [ Annotation ]
            #               | Annotation
            #               | "1"
            #               ;
            #
            #     Annotation = "{" NAME "}" ;
            #
            # Notes:
            #
            # * `Annotation` is just a comment if it follows a `UNIT` and is
            #    equivalent to `1` if it is used alone. For examples,
            #    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
            # * `NAME` is a sequence of non-blank printable ASCII characters not
            #    containing '{' or '}'.
        "name": "A String", # Resource name. The format of the name may vary between different
            # implementations. For examples:
            #
            #     projects/{project_id}/metricDescriptors/{type=**}
            #     metricDescriptors/{type=**}
      },
    ],
    "enums": [ # A list of all enum types included in this API service.  Enums
        # referenced directly or indirectly by the `apis` are automatically
        # included.  Enums which are not referenced but shall be included
        # should be listed here by name. Example:
        #
        #     enums:
        #     - name: google.someapi.v1.SomeEnum
      { # Enum type definition.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "enumvalue": [ # Enum value definitions.
          { # Enum value definition.
            "number": 42, # Enum value number.
            "options": [ # Protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "name": "A String", # Enum value name.
          },
        ],
        "options": [ # Protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "name": "A String", # Enum type name.
        "syntax": "A String", # The source syntax.
      },
    ],
    "types": [ # A list of all proto message types included in this API service.
        # Types referenced directly or indirectly by the `apis` are
        # automatically included.  Messages which are not referenced but
        # shall be included, such as types used by the `google.protobuf.Any` type,
        # should be listed here by name. Example:
        #
        #     types:
        #     - name: google.protobuf.Int32
      { # A protocol buffer message type.
        "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
          "A String",
        ],
        "name": "A String", # The fully qualified message name.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "syntax": "A String", # The source syntax.
        "fields": [ # The list of fields.
          { # A single field of a message type.
            "kind": "A String", # The field type.
            "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                # types. The first type has index 1; zero means the type is not in the list.
            "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
            "name": "A String", # The field name.
            "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
            "jsonName": "A String", # The field JSON name.
            "number": 42, # The field number.
            "cardinality": "A String", # The field cardinality.
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "packed": True or False, # Whether to use alternative packed wire representation.
          },
        ],
        "options": [ # The protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
      },
    ],
    "logging": { # Logging configuration of the service. # Logging configuration.
        #
        # The following example shows how to configure logs to be sent to the
        # producer and consumer projects. In the example, the `activity_history`
        # log is sent to both the producer and consumer projects, whereas the
        # `purchase_history` log is only sent to the producer project.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     logs:
        #     - name: activity_history
        #       labels:
        #       - key: /customer_id
        #     - name: purchase_history
        #     logging:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         logs:
        #         - activity_history
        #         - purchase_history
        #       consumer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         logs:
        #         - activity_history
      "producerDestinations": [ # Logging configurations for sending logs to the producer project.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A log can be used in at most
          # one producer destination.
        { # Configuration of a specific logging destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
              # Service.monitored_resources section.
          "logs": [ # Names of the logs to be sent to this destination. Each name must
              # be defined in the Service.logs section. If the log name is
              # not a domain scoped name, it will be automatically prefixed with
              # the service name followed by "/".
            "A String",
          ],
        },
      ],
      "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
          # There can be multiple consumer destinations, each one must have a
          # different monitored resource type. A log can be used in at most
          # one consumer destination.
        { # Configuration of a specific logging destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
              # Service.monitored_resources section.
          "logs": [ # Names of the logs to be sent to this destination. Each name must
              # be defined in the Service.logs section. If the log name is
              # not a domain scoped name, it will be automatically prefixed with
              # the service name followed by "/".
            "A String",
          ],
        },
      ],
    },
    "name": "A String", # The DNS address at which this service is available,
        # e.g. `calendar.googleapis.com`.
    "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
        #
        # Example:
        # 
documentation:
        #   summary: >
        #     The Google Calendar API gives access
        #     to most calendar features.
        #   pages:
        #   - name: Overview
        #     content: (== include google/foo/overview.md ==)
        #   - name: Tutorial
        #     content: (== include google/foo/tutorial.md ==)
        #     subpages;
        #     - name: Java
        #       content: (== include google/foo/tutorial_java.md ==)
        #   rules:
        #   - selector: google.calendar.Calendar.Get
        #     description: >
        #       ...
        #   - selector: google.calendar.Calendar.Put
        #     description: >
        #       ...
        # 

        # Documentation is provided in markdown syntax. In addition to
        # standard markdown features, definition lists, tables and fenced
        # code blocks are supported. Section headers can be provided and are
        # interpreted relative to the section nesting of the context where
        # a documentation fragment is embedded.
        #
        # Documentation from the IDL is merged with documentation defined
        # via the config at normalization time, where documentation provided
        # by config rules overrides IDL provided.
        #
        # A number of constructs specific to the API platform are supported
        # in documentation text.
        #
        # In order to reference a proto element, the following
        # notation can be used:
        # 
[fully.qualified.proto.name][]

        # To override the display text used for the link, this can be used:
        # 
[display text][fully.qualified.proto.name]

        # Text can be excluded from doc using the following notation:
        # 
(-- internal comment --)

        # Comments can be made conditional using a visibility label. The below
        # text will be only rendered if the `BETA` label is available:
        # 
(--BETA: comment for BETA users --)

        # A few directives are available in documentation. Note that
        # directives must appear on a single line to be properly
        # identified. The `include` directive includes a markdown file from
        # an external source:
        # 
(== include path/to/file ==)

        # The `resource_for` directive marks a message to be the resource of
        # a collection in REST view. If it is not specified, tools attempt
        # to infer the resource from the operations in a collection:
        # 
(== resource_for v1.shelves.books ==)

        # The directive `suppress_warning` does not directly affect documentation
        # and is documented together with service config validation.
      "rules": [ # A list of documentation rules that apply to individual API elements.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A documentation rule provides information about individual API elements.
          "description": "A String", # Description of the selected API(s).
          "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
              # element is marked as `deprecated`.
          "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
              # qualified name of the element which may end in "*", indicating a wildcard.
              # Wildcards are only allowed at the end and for a whole component of the
              # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
              # specify a default for all applicable elements, the whole pattern "*"
              # is used.
        },
      ],
      "overview": "A String", # Declares a single overview page. For example:
          # 
documentation:
          #   summary: ...
          #   overview: (== include overview.md ==)
          # 

          # This is a shortcut for the following declaration (using pages style):
          # 
documentation:
          #   summary: ...
          #   pages:
          #   - name: Overview
          #     content: (== include overview.md ==)
          # 

          # Note: you cannot specify both `overview` field and `pages` field.
      "summary": "A String", # A short summary of what the service does. Can only be provided by
          # plain text.
      "pages": [ # The top level pages for the documentation set.
        { # Represents a documentation page. A page can contain subpages to represent
            # nested documentation set structure.
          "content": "A String", # The Markdown content of the page. You can use (== include {path} ==)
              # to include content from a Markdown file.
          "subpages": [ # Subpages of this page. The order of subpages specified here will be
              # honored in the generated docset.
            # Object with schema name: Page
          ],
          "name": "A String", # The name of the page. It will be used as an identity of the page to
              # generate URI of the page, text of the link to this page in navigation,
              # etc. The full page name (start from the root page name to this page
              # concatenated with `.`) can be used as reference to the page in your
              # documentation. For example:
              # 
pages:
              # - name: Tutorial
              #   content: (== include tutorial.md ==)
              #   subpages:
              #   - name: Java
              #     content: (== include tutorial_java.md ==)
              # 

              # You can reference `Java` page using Markdown reference link syntax:
              # `Java`.
        },
      ],
      "documentationRootUrl": "A String", # The URL to the root of documentation.
    },
    "systemTypes": [ # A list of all proto message types included in this API service.
        # It serves similar purpose as [google.api.Service.types], except that
        # these types are not needed by user-defined APIs. Therefore, they will not
        # show up in the generated discovery doc. This field should only be used
        # to define system APIs in ESF.
      { # A protocol buffer message type.
        "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
          "A String",
        ],
        "name": "A String", # The fully qualified message name.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "syntax": "A String", # The source syntax.
        "fields": [ # The list of fields.
          { # A single field of a message type.
            "kind": "A String", # The field type.
            "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                # types. The first type has index 1; zero means the type is not in the list.
            "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
            "name": "A String", # The field name.
            "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
            "jsonName": "A String", # The field JSON name.
            "number": 42, # The field number.
            "cardinality": "A String", # The field cardinality.
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "packed": True or False, # Whether to use alternative packed wire representation.
          },
        ],
        "options": [ # The protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
      },
    ],
    "context": { # `Context` defines which contexts an API requests. # Context configuration.
        #
        # Example:
        #
        #     context:
        #       rules:
        #       - selector: "*"
        #         requested:
        #         - google.rpc.context.ProjectContext
        #         - google.rpc.context.OriginContext
        #
        # The above specifies that all methods in the API request
        # `google.rpc.context.ProjectContext` and
        # `google.rpc.context.OriginContext`.
        #
        # Available context types are defined in package
        # `google.rpc.context`.
      "rules": [ # A list of RPC context rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A context rule provides information about the context for an individual API
            # element.
          "provided": [ # A list of full type names of provided contexts.
            "A String",
          ],
          "requested": [ # A list of full type names of requested contexts.
            "A String",
          ],
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "endpoints": [ # Configuration for network endpoints.  If this is empty, then an endpoint
        # with the same name as the service is automatically generated to service all
        # defined APIs.
      { # `Endpoint` describes a network endpoint that serves a set of APIs.
          # A service may expose any number of endpoints, and all endpoints share the
          # same service configuration, such as quota configuration and monitoring
          # configuration.
          #
          # Example service configuration:
          #
          #     name: library-example.googleapis.com
          #     endpoints:
          #       # Below entry makes 'google.example.library.v1.Library'
          #       # API be served from endpoint address library-example.googleapis.com.
          #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
          #       # it to decide whether the subsequent cross-origin request is
          #       # allowed to proceed.
          #     - name: library-example.googleapis.com
          #       apis: google.example.library.v1.Library
          #       allow_cors: true
          #       # Below entry makes 'google.example.library.v1.Library'
          #       # API be served from endpoint address
          #       # google.example.library-example.v1.LibraryManager.
          #     - name: library-manager.googleapis.com
          #       apis: google.example.library.v1.LibraryManager
          #       # BNS address for a borg job. Can specify a task by appending
          #       # "/taskId" (e.g. "/0") to the job spec.
          #
          # Example OpenAPI extension for endpoint with allow_cors set to true:
          #
          #     {
          #       "swagger": "2.0",
          #       "info": {
          #         "description": "A simple..."
          #       },
          #       "host": "MY_PROJECT_ID.appspot.com",
          #       "x-google-endpoints": [{
          #         "name": "MY_PROJECT_ID.appspot.com",
          #         "allow_cors": "true"
          #       }]
          #     }
        "allowCors": True or False, # Allowing
            # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
            # cross-domain traffic, would allow the backends served from this endpoint to
            # receive and respond to HTTP OPTIONS requests. The response will be used by
            # the browser to determine whether the subsequent cross-origin request is
            # allowed to proceed.
        "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
            # please specify multiple google.api.Endpoint for each of the intented
            # alias.
            #
            # Additional names that this endpoint will be hosted on.
          "A String",
        ],
        "features": [ # The list of features enabled on this endpoint.
          "A String",
        ],
        "name": "A String", # The canonical name of this endpoint.
        "apis": [ # The list of APIs served by this endpoint.
          "A String",
        ],
      },
    ],
  }
get(serviceName=None, configId, x__xgafv=None) 
Gets a service configuration (version) for a managed service.

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  configId: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Service` is the root object of Google service configuration schema. It
      # describes basic information about a service, such as the name and the
      # title, and delegates other aspects to sub-sections. Each sub-section is
      # either a proto message or a repeated proto message that configures a
      # specific aspect, such as auth. See each proto message definition for details.
      #
      # Example:
      #
      #     type: google.api.Service
      #     config_version: 3
      #     name: calendar.googleapis.com
      #     title: Google Calendar API
      #     apis:
      #     - name: google.calendar.v3.Calendar
      #     backend:
      #       rules:
      #       - selector: "google.calendar.v3.*"
      #         address: calendar.example.com
    "control": { # Selects and configures the service controller used by the service.  The # Configuration for the service control plane.
        # service controller handles features like abuse, quota, billing, logging,
        # monitoring, etc.
      "environment": "A String", # The service control environment to use. If empty, no control plane
          # feature (like quota and billing) will be enabled.
    },
    "monitoredResources": [ # Defines the monitored resources used by this service. This is required
        # by the Service.monitoring and Service.logging configurations.
      { # An object that describes the schema of a MonitoredResource object using a
          # type name and a set of labels.  For example, the monitored resource
          # descriptor for Google Compute Engine VM instances has a type of
          # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
          # `"zone"` to identify particular VM instances.
          #
          # Different APIs can support different monitored resource types. APIs generally
          # provide a `list` method that returns the monitored resource descriptors used
          # by the API.
        "type": "A String", # Required. The monitored resource type. For example, the type
            # `"cloudsql_database"` represents databases in Google Cloud SQL.
            # The maximum length of this value is 256 characters.
        "labels": [ # Required. A set of labels used to describe instances of this monitored
            # resource type. For example, an individual Google Cloud SQL database is
            # identified by values for the labels `"database_id"` and `"zone"`.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
            # displayed in user interfaces. It should be a Title Cased Noun Phrase,
            # without any article or other determiners. For example,
            # `"Google Cloud SQL Database"`.
        "description": "A String", # Optional. A detailed description of the monitored resource type that might
            # be used in documentation.
        "name": "A String", # Optional. The resource name of the monitored resource descriptor:
            # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
            # {type} is the value of the `type` field in this object and
            # {project_id} is a project ID that provides API-specific context for
            # accessing the type.  APIs that do not use project information can use the
            # resource name format `"monitoredResourceDescriptors/{type}"`.
      },
    ],
    "logs": [ # Defines the logs used by this service.
      { # A description of a log type. Example in YAML format:
          #
          #     - name: library.googleapis.com/activity_history
          #       description: The history of borrowing and returning library items.
          #       display_name: Activity
          #       labels:
          #       - key: /customer_id
          #         description: Identifier of a library customer
        "labels": [ # The set of labels that are available to describe a specific log entry.
            # Runtime requests that contain labels not specified here are
            # considered invalid.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # The human-readable name for this log. This information appears on
            # the user interface and should be concise.
        "description": "A String", # A human-readable description of this log. This information appears in
            # the documentation and can contain details.
        "name": "A String", # The name of the log. It must be less than 512 characters long and can
            # include the following characters: upper- and lower-case alphanumeric
            # characters [A-Za-z0-9], and punctuation characters including
            # slash, underscore, hyphen, period [/_-.].
      },
    ],
    "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
        #
        # Analytics configuration.
        #
        # The example below shows how to configure monitored resources and metrics
        # for analytics. In the example, a monitored resource and two metrics are
        # defined. The `library.googleapis.com/book/returned_count` and
        # `library.googleapis.com/book/overdue_count` metric are sent
        # to the analytics.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     metrics:
        #     - name: library.googleapis.com/book/returned_count
        #       metric_kind: DELTA
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     - name: library.googleapis.com/book/overdue_count
        #       metric_kind: GAUGE
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     analytics:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #         - library.googleapis.com/book/overdue_count
      "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one producer destination.
        { # Configuration of a specific analytics destination.
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this analytics destination.
              # Each name must be defined in Service.metrics section. Metrics
              # with value type BOOL and STRING must be of GUAGE kind, metrics with
              # value type INT64, DOUBLE and MONEY must be of DELTA kind.
            "A String",
          ],
        },
      ],
    },
    "systemParameters": { # ### System parameter configuration # System parameter configuration.
        #
        # A system parameter is a special kind of parameter defined by the API
        # system, not by an individual API. It is typically mapped to an HTTP header
        # and/or a URL query parameter. This configuration specifies which methods
        # change the names of the system parameters.
      "rules": [ # Define system parameters.
          #
          # The parameters defined here will override the default parameters
          # implemented by the system. If this field is missing from the service
          # config, default system parameters will be used. Default system parameters
          # and names is implementation-dependent.
          #
          # Example: define api key and alt name for all methods
          #
          # system_parameters
          #   rules:
          #     - selector: "*"
          #       parameters:
          #         - name: api_key
          #           url_query_parameter: api_key
          #         - name: alt
          #           http_header: Response-Content-Type
          #
          # Example: define 2 api key names for a specific method.
          #
          # system_parameters
          #   rules:
          #     - selector: "/ListShelves"
          #       parameters:
          #         - name: api_key
          #           http_header: Api-Key1
          #         - name: api_key
          #           http_header: Api-Key2
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Define a system parameter rule mapping system parameter definitions to
            # methods.
          "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
              # For a given method call, only one of them should be used. If multiple
              # names are used the behavior is implementation-dependent.
              # If none of the specified names are present the behavior is
              # parameter-dependent.
            { # Define a parameter's name and location. The parameter may be passed as either
                # an HTTP header or a URL query parameter, and if both are passed the behavior
                # is implementation-dependent.
              "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
                  # sensitive.
              "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
                  # and etc. It is case sensitive.
              "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
                  # insensitive.
            },
          ],
          "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
              # methods in all APIs.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
      "rules": [ # A list of API backend rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A backend rule provides configuration for an individual API element.
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
          "deadline": 3.14, # The number of seconds to wait for a response from a request.  The
              # default depends on the deployment context.
          "address": "A String", # The address of the API backend.
        },
      ],
    },
    "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
        #
        # The example below shows how to configure monitored resources and metrics
        # for monitoring. In the example, a monitored resource and two metrics are
        # defined. The `library.googleapis.com/book/returned_count` metric is sent
        # to both producer and consumer projects, whereas the
        # `library.googleapis.com/book/overdue_count` metric is only sent to the
        # consumer project.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     metrics:
        #     - name: library.googleapis.com/book/returned_count
        #       metric_kind: DELTA
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     - name: library.googleapis.com/book/overdue_count
        #       metric_kind: GAUGE
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     monitoring:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #       consumer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #         - library.googleapis.com/book/overdue_count
      "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one producer destination.
        { # Configuration of a specific monitoring destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this monitoring destination.
              # Each name must be defined in Service.metrics section.
            "A String",
          ],
        },
      ],
      "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
          # There can be multiple consumer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one consumer destination.
        { # Configuration of a specific monitoring destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this monitoring destination.
              # Each name must be defined in Service.metrics section.
            "A String",
          ],
        },
      ],
    },
    "title": "A String", # The product title associated with this service.
    "id": "A String", # A unique ID for a specific instance of this message, typically assigned
        # by the client for tracking purpose. If empty, the server may choose to
        # generate one instead.
    "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
        #
        # Example for an API targeted for external use:
        #
        #     name: calendar.googleapis.com
        #     authentication:
        #       rules:
        #       - selector: "*"
        #         oauth:
        #           canonical_scopes: https://www.googleapis.com/auth/calendar
        #
        #       - selector: google.calendar.Delegate
        #         oauth:
        #           canonical_scopes: https://www.googleapis.com/auth/calendar.read
      "rules": [ # A list of authentication rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Authentication rules for the service.
            #
            # By default, if a method has any authentication requirements, every request
            # must include a valid credential matching one of the requirements.
            # It's an error to include more than one kind of credential in a single
            # request.
            #
            # If a method doesn't have any auth requirements, request credentials will be
            # ignored.
          "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
              # there are scopes defined for "Read-only access to Google Calendar" and
              # "Access to Cloud Platform". Users can consent to a scope for an application,
              # giving it permission to access that data on their behalf.
              #
              # OAuth scope specifications should be fairly coarse grained; a user will need
              # to see and understand the text description of what your scope means.
              #
              # In most cases: use one or at most two OAuth scopes for an entire family of
              # products. If your product has multiple APIs, you should probably be sharing
              # the OAuth scope across all of those APIs.
              #
              # When you need finer grained OAuth consent screens: talk with your product
              # management about how developers will use them in practice.
              #
              # Please note that even though each of the canonical scopes is enough for a
              # request to be accepted and passed to the backend, a request can still fail
              # due to the backend requiring additional scopes or permissions.
            "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
                # OAuth token containing any of these scopes will be accepted.
                #
                # Example:
                #
                #      canonical_scopes: https://www.googleapis.com/auth/calendar,
                #                        https://www.googleapis.com/auth/calendar.read
          },
          "requirements": [ # Requirements for additional authentication providers.
            { # User-defined authentication requirements, including support for
                # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
              "providerId": "A String", # id from authentication provider.
                  #
                  # Example:
                  #
                  #     provider_id: bookstore_auth
              "audiences": "A String", # The list of JWT
                  # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
                  # that are allowed to access. A JWT containing any of these audiences will
                  # be accepted. When this setting is absent, only JWTs with audience
                  # "https://Service_name/API_name"
                  # will be accepted. For example, if no audiences are in the setting,
                  # LibraryService API will only accept JWTs with the following audience
                  # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
                  #
                  # Example:
                  #
                  #     audiences: bookstore_android.apps.googleusercontent.com,
                  #                bookstore_web.apps.googleusercontent.com
            },
          ],
          "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
              # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
              #
              # For requests without credentials, if the service control environment is
              # specified, each incoming request **must** be associated with a service
              # consumer. This can be done by passing an API key that belongs to a consumer
              # project.
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
      "providers": [ # Defines a set of authentication providers that a service supports.
        { # Configuration for an anthentication provider, including support for
            # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
          "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
              # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
              # Optional if the key set document:
              #  - can be retrieved from
              #    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
              #    of the issuer.
              #  - can be inferred from the email domain of the issuer (e.g. a Google service account).
              #
              # Example: https://www.googleapis.com/oauth2/v1/certs
          "id": "A String", # The unique identifier of the auth provider. It will be referred to by
              # `AuthRequirement.provider_id`.
              #
              # Example: "bookstore_auth".
          "issuer": "A String", # Identifies the principal that issued the JWT. See
              # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
              # Usually a URL or an email address.
              #
              # Example: https://securetoken.google.com
              # Example: 1234567-compute@developer.gserviceaccount.com
        },
      ],
    },
    "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
      "rules": [ # A list of usage rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Usage configuration rules for the service.
            #
            # NOTE: Under development.
            #
            #
            # Use this rule to configure unregistered calls for the service. Unregistered
            # calls are calls that do not contain consumer project identity.
            # (Example: calls that do not contain an API key).
            # By default, API methods do not allow unregistered calls, and each method call
            # must be identified by a consumer project identity. Use this rule to
            # allow/disallow unregistered calls.
            #
            # Example of an API that wants to allow unregistered calls for entire service.
            #
            #     usage:
            #       rules:
            #       - selector: "*"
            #         allow_unregistered_calls: true
            #
            # Example of a method that wants to allow unregistered calls.
            #
            #     usage:
            #       rules:
            #       - selector: "google.example.library.v1.LibraryService.CreateBook"
            #         allow_unregistered_calls: true
          "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
              # methods in all APIs.
              #
              # Refer to selector for syntax details.
          "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
        },
      ],
      "requirements": [ # Requirements that must be satisfied before a consumer project can use the
          # service. Each requirement is of the form /;
          # for example 'serviceusage.googleapis.com/billing-enabled'.
        "A String",
      ],
    },
    "configVersion": 42, # The version of the service configuration. The config version may
        # influence interpretation of the configuration, for example, to
        # determine defaults. This is documented together with applicable
        # options. The current default for the config version itself is `3`.
    "producerProjectId": "A String", # The id of the Google developer project that owns the service.
        # Members of this project can manage the service configuration,
        # manage consumption of the service, etc.
    "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
        # HttpRule, each specifying the mapping of an RPC method
        # to one or more HTTP REST API methods.
      "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
            # REST APIs.  The mapping determines what portions of the request
            # message are populated from the path, query parameters, or body of
            # the HTTP request.  The mapping is typically specified as an
            # `google.api.http` annotation, see "google/api/annotations.proto"
            # for details.
            #
            # The mapping consists of a field specifying the path template and
            # method kind.  The path template can refer to fields in the request
            # message, as in the example below which describes a REST GET
            # operation on a resource collection of messages:
            #
            # ```proto
            # service Messaging {
            #   rpc GetMessage(GetMessageRequest) returns (Message) {
            #     option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
            #   }
            # }
            # message GetMessageRequest {
            #   message SubMessage {
            #     string subfield = 1;
            #   }
            #   string message_id = 1; // mapped to the URL
            #   SubMessage sub = 2;    // `sub.subfield` is url-mapped
            # }
            # message Message {
            #   string text = 1; // content of the resource
            # }
            # ```
            #
            # This definition enables an automatic, bidrectional mapping of HTTP
            # JSON to RPC. Example:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
            #
            # In general, not only fields but also field paths can be referenced
            # from a path pattern. Fields mapped to the path pattern cannot be
            # repeated and must have a primitive (non-message) type.
            #
            # Any fields in the request message which are not bound by the path
            # pattern automatically become (optional) HTTP query
            # parameters. Assume the following definition of the request message:
            #
            # ```proto
            # message GetMessageRequest {
            #   message SubMessage {
            #     string subfield = 1;
            #   }
            #   string message_id = 1; // mapped to the URL
            #   int64 revision = 2;    // becomes a parameter
            #   SubMessage sub = 3;    // `sub.subfield` becomes a parameter
            # }
            # ```
            #
            # This enables a HTTP JSON to RPC mapping as below:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
            #
            # Note that fields which are mapped to HTTP parameters must have a
            # primitive type or a repeated primitive type. Message types are not
            # allowed. In the case of a repeated type, the parameter can be
            # repeated in the URL, as in `...?param=A¶m=B`.
            #
            # For HTTP method kinds which allow a request body, the `body` field
            # specifies the mapping. Consider a REST update method on the
            # message resource collection:
            #
            # ```proto
            # service Messaging {
            #   rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
            #     option (google.api.http) = {
            #       put: "/v1/messages/{message_id}"
            #       body: "message"
            #     };
            #   }
            # }
            # message UpdateMessageRequest {
            #   string message_id = 1; // mapped to the URL
            #   Message message = 2;   // mapped to the body
            # }
            # ```
            #
            # The following HTTP JSON to RPC mapping is enabled, where the
            # representation of the JSON in the request body is determined by
            # protos JSON encoding:
            #
            # HTTP | RPC
            # -----|-----
            # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
            #
            # The special name `*` can be used in the body mapping to define that
            # every field not bound by the path template should be mapped to the
            # request body.  This enables the following alternative definition of
            # the update method:
            #
            # ```proto
            # service Messaging {
            #   rpc UpdateMessage(Message) returns (Message) {
            #     option (google.api.http) = {
            #       put: "/v1/messages/{message_id}"
            #       body: "*"
            #     };
            #   }
            # }
            # message Message {
            #   string message_id = 1;
            #   string text = 2;
            # }
            # ```
            #
            # The following HTTP JSON to RPC mapping is enabled:
            #
            # HTTP | RPC
            # -----|-----
            # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
            #
            # Note that when using `*` in the body mapping, it is not possible to
            # have HTTP parameters, as all fields not bound by the path end in
            # the body. This makes this option more rarely used in practice of
            # defining REST APIs. The common usage of `*` is in custom methods
            # which don't use the URL at all for transferring data.
            #
            # It is possible to define multiple HTTP methods for one RPC by using
            # the `additional_bindings` option. Example:
            #
            # ```proto
            # service Messaging {
            #   rpc GetMessage(GetMessageRequest) returns (Message) {
            #     option (google.api.http) = {
            #       get: "/v1/messages/{message_id}"
            #       additional_bindings {
            #         get: "/v1/users/{user_id}/messages/{message_id}"
            #       }
            #     };
            #   }
            # }
            # message GetMessageRequest {
            #   string message_id = 1;
            #   string user_id = 2;
            # }
            # ```
            #
            # This enables the following two alternative HTTP JSON to RPC
            # mappings:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
            # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
            #
            # # Rules for HTTP mapping
            #
            # The rules for mapping HTTP path, query parameters, and body fields
            # to the request message are as follows:
            #
            # 1. The `body` field specifies either `*` or a field path, or is
            #    omitted. If omitted, it assumes there is no HTTP body.
            # 2. Leaf fields (recursive expansion of nested messages in the
            #    request) can be classified into three types:
            #     (a) Matched in the URL template.
            #     (b) Covered by body (if body is `*`, everything except (a) fields;
            #         else everything under the body field)
            #     (c) All other fields.
            # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
            # 4. Any body sent with an HTTP request can contain only (b) fields.
            #
            # The syntax of the path template is as follows:
            #
            #     Template = "/" Segments [ Verb ] ;
            #     Segments = Segment { "/" Segment } ;
            #     Segment  = "*" | "**" | LITERAL | Variable ;
            #     Variable = "{" FieldPath [ "=" Segments ] "}" ;
            #     FieldPath = IDENT { "." IDENT } ;
            #     Verb     = ":" LITERAL ;
            #
            # The syntax `*` matches a single path segment. It follows the semantics of
            # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
            # Expansion.
            #
            # The syntax `**` matches zero or more path segments. It follows the semantics
            # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
            # Expansion.
            #
            # The syntax `LITERAL` matches literal text in the URL path.
            #
            # The syntax `Variable` matches the entire path as specified by its template;
            # this nested template must not contain further variables. If a variable
            # matches a single path segment, its template may be omitted, e.g. `{var}`
            # is equivalent to `{var=*}`.
            #
            # NOTE: the field paths in variables and in the `body` must not refer to
            # repeated fields or map fields.
            #
            # Use CustomHttpPattern to specify any HTTP method that is not included in the
            # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
            # a given URL path rule. The wild-card rule is useful for services that provide
            # content to Web (HTML) clients.
          "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
              # `*` for mapping all fields not captured by the path pattern to the HTTP
              # body. NOTE: the referred field must not be a repeated field and must be
              # present at the top-level of response message type.
          "get": "A String", # Used for listing and getting information about resources.
          "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
            "enabled": True or False, # Whether download is enabled.
          },
          "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
              # not contain an `additional_bindings` field themselves (that is,
              # the nesting may only be one level deep).
            # Object with schema name: HttpRule
          ],
          "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
            "enabled": True or False, # Whether upload is enabled.
          },
          "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
            "path": "A String", # The path matched by this custom verb.
            "kind": "A String", # The name of this custom HTTP verb.
          },
          "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
              # response. Other response fields are ignored. This field is optional. When
              # not set, the response message will be used as HTTP body of response.
              # NOTE: the referred field must be not a repeated field and must be present
              # at the top-level of response message type.
          "put": "A String", # Used for updating a resource.
          "patch": "A String", # Used for updating a resource.
          "post": "A String", # Used for creating a resource.
          "selector": "A String", # Selects methods to which this rule applies.
              #
              # Refer to selector for syntax details.
          "delete": "A String", # Used for deleting a resource.
        },
      ],
    },
    "apis": [ # A list of API interfaces exported by this service. Only the `name` field
        # of the google.protobuf.Api needs to be provided by the configuration
        # author, as the remaining fields will be derived from the IDL during the
        # normalization process. It is an error to specify an API interface here
        # which cannot be resolved against the associated IDL files.
      { # Api is a light-weight descriptor for a protocol buffer service.
        "methods": [ # The methods of this api, in unspecified order.
          { # Method represents a method of an api.
            "name": "A String", # The simple name of this method.
            "requestStreaming": True or False, # If true, the request is streamed.
            "responseTypeUrl": "A String", # The URL of the output message type.
            "requestTypeUrl": "A String", # A URL of the input message type.
            "responseStreaming": True or False, # If true, the response is streamed.
            "syntax": "A String", # The source syntax of this method.
            "options": [ # Any metadata attached to the method.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
          },
        ],
        "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
            # message.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "mixins": [ # Included APIs. See Mixin.
          { # Declares an API to be included in this API. The including API must
              # redeclare all the methods from the included API, but documentation
              # and options are inherited as follows:
              #
              # - If after comment and whitespace stripping, the documentation
              #   string of the redeclared method is empty, it will be inherited
              #   from the original method.
              #
              # - Each annotation belonging to the service config (http,
              #   visibility) which is not set in the redeclared method will be
              #   inherited.
              #
              # - If an http annotation is inherited, the path pattern will be
              #   modified as follows. Any version prefix will be replaced by the
              #   version of the including API plus the root path if specified.
              #
              # Example of a simple mixin:
              #
              #     package google.acl.v1;
              #     service AccessControl {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
              #       }
              #     }
              #
              #     package google.storage.v2;
              #     service Storage {
              #       //       rpc GetAcl(GetAclRequest) returns (Acl);
              #
              #       // Get a data record.
              #       rpc GetData(GetDataRequest) returns (Data) {
              #         option (google.api.http).get = "/v2/{resource=**}";
              #       }
              #     }
              #
              # Example of a mixin configuration:
              #
              #     apis:
              #     - name: google.storage.v2.Storage
              #       mixins:
              #       - name: google.acl.v1.AccessControl
              #
              # The mixin construct implies that all methods in `AccessControl` are
              # also declared with same name and request/response types in
              # `Storage`. A documentation generator or annotation processor will
              # see the effective `Storage.GetAcl` method after inherting
              # documentation and annotations as follows:
              #
              #     service Storage {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
              #       }
              #       ...
              #     }
              #
              # Note how the version in the path pattern changed from `v1` to `v2`.
              #
              # If the `root` field in the mixin is specified, it should be a
              # relative path under which inherited HTTP paths are placed. Example:
              #
              #     apis:
              #     - name: google.storage.v2.Storage
              #       mixins:
              #       - name: google.acl.v1.AccessControl
              #         root: acls
              #
              # This implies the following inherited HTTP annotation:
              #
              #     service Storage {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
              #       }
              #       ...
              #     }
            "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
                # are rooted.
            "name": "A String", # The fully qualified name of the API which is included.
          },
        ],
        "syntax": "A String", # The source syntax of the service.
        "version": "A String", # A version string for this api. If specified, must have the form
            # `major-version.minor-version`, as in `1.10`. If the minor version
            # is omitted, it defaults to zero. If the entire version field is
            # empty, the major version is derived from the package name, as
            # outlined below. If the field is not empty, the version in the
            # package name will be verified to be consistent with what is
            # provided here.
            #
            # The versioning schema uses [semantic
            # versioning](http://semver.org) where the major version number
            # indicates a breaking change and the minor version an additive,
            # non-breaking change. Both version numbers are signals to users
            # what to expect from different versions, and should be carefully
            # chosen based on the product plan.
            #
            # The major version is also reflected in the package name of the
            # API, which must end in `v`, as in
            # `google.feature.v1`. For major versions 0 and 1, the suffix can
            # be omitted. Zero major versions must only be used for
            # experimental, none-GA apis.
        "options": [ # Any metadata attached to the API.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "name": "A String", # The fully qualified name of this api, including package name
            # followed by the api's simple name.
      },
    ],
    "customError": { # Customize service error responses.  For example, list any service # Custom error configuration.
        # specific protobuf types that can appear in error detail lists of
        # error responses.
        #
        # Example:
        #
        #     custom_error:
        #       types:
        #       - google.foo.v1.CustomError
        #       - google.foo.v1.AnotherError
      "rules": [ # The list of custom error rules that apply to individual API messages.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A custom error rule.
          "isErrorType": True or False, # Mark this message as possible payload in error response.  Otherwise,
              # objects of this type will be filtered when they appear in error payload.
          "selector": "A String", # Selects messages to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
      "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
        "A String",
      ],
    },
    "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
        # elements.  Restrictions are specified using visibility labels
        # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
        #
        # Users and projects can have access to more than one visibility label. The
        # effective visibility for multiple labels is the union of each label's
        # elements, plus any unrestricted elements.
        #
        # If an element and its parents have no restrictions, visibility is
        # unconditionally granted.
        #
        # Example:
        #
        #     visibility:
        #       rules:
        #       - selector: google.calendar.Calendar.EnhancedSearch
        #         restriction: TRUSTED_TESTER
        #       - selector: google.calendar.Calendar.Delegate
        #         restriction: GOOGLE_INTERNAL
        #
        # Here, all methods are publicly visible except for the restricted methods
        # EnhancedSearch and Delegate.
      "rules": [ # A list of visibility rules that apply to individual API elements.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A visibility rule provides visibility configuration for an individual API
            # element.
          "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
              # Any of the listed labels can be used to grant the visibility.
              #
              # If a rule has multiple labels, removing one of the labels but not all of
              # them can break clients.
              #
              # Example:
              #
              #     visibility:
              #       rules:
              #       - selector: google.calendar.Calendar.EnhancedSearch
              #         restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
              #
              # Removing GOOGLE_INTERNAL from this restriction will break clients that
              # rely on this method and only had access to it through GOOGLE_INTERNAL.
          "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "metrics": [ # Defines the metrics used by this service.
      { # Defines a metric type and its schema.
        "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
            # Use sentence case without an ending period, for example "Request count".
        "description": "A String", # A detailed description of the metric, which can be used in documentation.
        "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
            # Some combinations of `metric_kind` and `value_type` might not be supported.
        "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
            # Some combinations of `metric_kind` and `value_type` might not be supported.
        "labels": [ # The set of labels that can be used to describe a specific instance of this
            # metric type. For example, the
            # `compute.googleapis.com/instance/network/received_bytes_count` metric type
            # has a label, `loadbalanced`, that specifies whether the traffic was
            # received through a load balanced IP address.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "type": "A String", # The metric type including a DNS name prefix, for example
            # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
            # should use a natural hierarchical grouping such as the following:
            #
            #     compute.googleapis.com/instance/cpu/utilization
            #     compute.googleapis.com/instance/disk/read_ops_count
            #     compute.googleapis.com/instance/network/received_bytes_count
            #
            # Note that if the metric type changes, the monitoring data will be
            # discontinued, and anything depends on it will break, such as monitoring
            # dashboards, alerting rules and quota limits. Therefore, once a metric has
            # been published, its type should be immutable.
        "unit": "A String", # The unit in which the metric value is reported. It is only applicable
            # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
            # supported units are a subset of [The Unified Code for Units of
            # Measure](http://unitsofmeasure.org/ucum.html) standard:
            #
            # **Basic units (UNIT)**
            #
            # * `bit`   bit
            # * `By`    byte
            # * `s`     second
            # * `min`   minute
            # * `h`     hour
            # * `d`     day
            #
            # **Prefixes (PREFIX)**
            #
            # * `k`     kilo    (10**3)
            # * `M`     mega    (10**6)
            # * `G`     giga    (10**9)
            # * `T`     tera    (10**12)
            # * `P`     peta    (10**15)
            # * `E`     exa     (10**18)
            # * `Z`     zetta   (10**21)
            # * `Y`     yotta   (10**24)
            # * `m`     milli   (10**-3)
            # * `u`     micro   (10**-6)
            # * `n`     nano    (10**-9)
            # * `p`     pico    (10**-12)
            # * `f`     femto   (10**-15)
            # * `a`     atto    (10**-18)
            # * `z`     zepto   (10**-21)
            # * `y`     yocto   (10**-24)
            # * `Ki`    kibi    (2**10)
            # * `Mi`    mebi    (2**20)
            # * `Gi`    gibi    (2**30)
            # * `Ti`    tebi    (2**40)
            #
            # **Grammar**
            #
            # The grammar includes the dimensionless unit `1`, such as `1/s`.
            #
            # The grammar also includes these connectors:
            #
            # * `/`    division (as an infix operator, e.g. `1/s`).
            # * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
            #
            # The grammar for a unit is as follows:
            #
            #     Expression = Component { "." Component } { "/" Component } ;
            #
            #     Component = [ PREFIX ] UNIT [ Annotation ]
            #               | Annotation
            #               | "1"
            #               ;
            #
            #     Annotation = "{" NAME "}" ;
            #
            # Notes:
            #
            # * `Annotation` is just a comment if it follows a `UNIT` and is
            #    equivalent to `1` if it is used alone. For examples,
            #    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
            # * `NAME` is a sequence of non-blank printable ASCII characters not
            #    containing '{' or '}'.
        "name": "A String", # Resource name. The format of the name may vary between different
            # implementations. For examples:
            #
            #     projects/{project_id}/metricDescriptors/{type=**}
            #     metricDescriptors/{type=**}
      },
    ],
    "enums": [ # A list of all enum types included in this API service.  Enums
        # referenced directly or indirectly by the `apis` are automatically
        # included.  Enums which are not referenced but shall be included
        # should be listed here by name. Example:
        #
        #     enums:
        #     - name: google.someapi.v1.SomeEnum
      { # Enum type definition.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "enumvalue": [ # Enum value definitions.
          { # Enum value definition.
            "number": 42, # Enum value number.
            "options": [ # Protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "name": "A String", # Enum value name.
          },
        ],
        "options": [ # Protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "name": "A String", # Enum type name.
        "syntax": "A String", # The source syntax.
      },
    ],
    "types": [ # A list of all proto message types included in this API service.
        # Types referenced directly or indirectly by the `apis` are
        # automatically included.  Messages which are not referenced but
        # shall be included, such as types used by the `google.protobuf.Any` type,
        # should be listed here by name. Example:
        #
        #     types:
        #     - name: google.protobuf.Int32
      { # A protocol buffer message type.
        "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
          "A String",
        ],
        "name": "A String", # The fully qualified message name.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "syntax": "A String", # The source syntax.
        "fields": [ # The list of fields.
          { # A single field of a message type.
            "kind": "A String", # The field type.
            "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                # types. The first type has index 1; zero means the type is not in the list.
            "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
            "name": "A String", # The field name.
            "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
            "jsonName": "A String", # The field JSON name.
            "number": 42, # The field number.
            "cardinality": "A String", # The field cardinality.
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "packed": True or False, # Whether to use alternative packed wire representation.
          },
        ],
        "options": [ # The protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
      },
    ],
    "logging": { # Logging configuration of the service. # Logging configuration.
        #
        # The following example shows how to configure logs to be sent to the
        # producer and consumer projects. In the example, the `activity_history`
        # log is sent to both the producer and consumer projects, whereas the
        # `purchase_history` log is only sent to the producer project.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     logs:
        #     - name: activity_history
        #       labels:
        #       - key: /customer_id
        #     - name: purchase_history
        #     logging:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         logs:
        #         - activity_history
        #         - purchase_history
        #       consumer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         logs:
        #         - activity_history
      "producerDestinations": [ # Logging configurations for sending logs to the producer project.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A log can be used in at most
          # one producer destination.
        { # Configuration of a specific logging destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
              # Service.monitored_resources section.
          "logs": [ # Names of the logs to be sent to this destination. Each name must
              # be defined in the Service.logs section. If the log name is
              # not a domain scoped name, it will be automatically prefixed with
              # the service name followed by "/".
            "A String",
          ],
        },
      ],
      "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
          # There can be multiple consumer destinations, each one must have a
          # different monitored resource type. A log can be used in at most
          # one consumer destination.
        { # Configuration of a specific logging destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
              # Service.monitored_resources section.
          "logs": [ # Names of the logs to be sent to this destination. Each name must
              # be defined in the Service.logs section. If the log name is
              # not a domain scoped name, it will be automatically prefixed with
              # the service name followed by "/".
            "A String",
          ],
        },
      ],
    },
    "name": "A String", # The DNS address at which this service is available,
        # e.g. `calendar.googleapis.com`.
    "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
        #
        # Example:
        # 
documentation:
        #   summary: >
        #     The Google Calendar API gives access
        #     to most calendar features.
        #   pages:
        #   - name: Overview
        #     content: (== include google/foo/overview.md ==)
        #   - name: Tutorial
        #     content: (== include google/foo/tutorial.md ==)
        #     subpages;
        #     - name: Java
        #       content: (== include google/foo/tutorial_java.md ==)
        #   rules:
        #   - selector: google.calendar.Calendar.Get
        #     description: >
        #       ...
        #   - selector: google.calendar.Calendar.Put
        #     description: >
        #       ...
        # 

        # Documentation is provided in markdown syntax. In addition to
        # standard markdown features, definition lists, tables and fenced
        # code blocks are supported. Section headers can be provided and are
        # interpreted relative to the section nesting of the context where
        # a documentation fragment is embedded.
        #
        # Documentation from the IDL is merged with documentation defined
        # via the config at normalization time, where documentation provided
        # by config rules overrides IDL provided.
        #
        # A number of constructs specific to the API platform are supported
        # in documentation text.
        #
        # In order to reference a proto element, the following
        # notation can be used:
        # 
[fully.qualified.proto.name][]

        # To override the display text used for the link, this can be used:
        # 
[display text][fully.qualified.proto.name]

        # Text can be excluded from doc using the following notation:
        # 
(-- internal comment --)

        # Comments can be made conditional using a visibility label. The below
        # text will be only rendered if the `BETA` label is available:
        # 
(--BETA: comment for BETA users --)

        # A few directives are available in documentation. Note that
        # directives must appear on a single line to be properly
        # identified. The `include` directive includes a markdown file from
        # an external source:
        # 
(== include path/to/file ==)

        # The `resource_for` directive marks a message to be the resource of
        # a collection in REST view. If it is not specified, tools attempt
        # to infer the resource from the operations in a collection:
        # 
(== resource_for v1.shelves.books ==)

        # The directive `suppress_warning` does not directly affect documentation
        # and is documented together with service config validation.
      "rules": [ # A list of documentation rules that apply to individual API elements.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A documentation rule provides information about individual API elements.
          "description": "A String", # Description of the selected API(s).
          "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
              # element is marked as `deprecated`.
          "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
              # qualified name of the element which may end in "*", indicating a wildcard.
              # Wildcards are only allowed at the end and for a whole component of the
              # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
              # specify a default for all applicable elements, the whole pattern "*"
              # is used.
        },
      ],
      "overview": "A String", # Declares a single overview page. For example:
          # 
documentation:
          #   summary: ...
          #   overview: (== include overview.md ==)
          # 

          # This is a shortcut for the following declaration (using pages style):
          # 
documentation:
          #   summary: ...
          #   pages:
          #   - name: Overview
          #     content: (== include overview.md ==)
          # 

          # Note: you cannot specify both `overview` field and `pages` field.
      "summary": "A String", # A short summary of what the service does. Can only be provided by
          # plain text.
      "pages": [ # The top level pages for the documentation set.
        { # Represents a documentation page. A page can contain subpages to represent
            # nested documentation set structure.
          "content": "A String", # The Markdown content of the page. You can use (== include {path} ==)
              # to include content from a Markdown file.
          "subpages": [ # Subpages of this page. The order of subpages specified here will be
              # honored in the generated docset.
            # Object with schema name: Page
          ],
          "name": "A String", # The name of the page. It will be used as an identity of the page to
              # generate URI of the page, text of the link to this page in navigation,
              # etc. The full page name (start from the root page name to this page
              # concatenated with `.`) can be used as reference to the page in your
              # documentation. For example:
              # 
pages:
              # - name: Tutorial
              #   content: (== include tutorial.md ==)
              #   subpages:
              #   - name: Java
              #     content: (== include tutorial_java.md ==)
              # 

              # You can reference `Java` page using Markdown reference link syntax:
              # `Java`.
        },
      ],
      "documentationRootUrl": "A String", # The URL to the root of documentation.
    },
    "systemTypes": [ # A list of all proto message types included in this API service.
        # It serves similar purpose as [google.api.Service.types], except that
        # these types are not needed by user-defined APIs. Therefore, they will not
        # show up in the generated discovery doc. This field should only be used
        # to define system APIs in ESF.
      { # A protocol buffer message type.
        "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
          "A String",
        ],
        "name": "A String", # The fully qualified message name.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "syntax": "A String", # The source syntax.
        "fields": [ # The list of fields.
          { # A single field of a message type.
            "kind": "A String", # The field type.
            "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                # types. The first type has index 1; zero means the type is not in the list.
            "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
            "name": "A String", # The field name.
            "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
            "jsonName": "A String", # The field JSON name.
            "number": 42, # The field number.
            "cardinality": "A String", # The field cardinality.
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "packed": True or False, # Whether to use alternative packed wire representation.
          },
        ],
        "options": [ # The protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
      },
    ],
    "context": { # `Context` defines which contexts an API requests. # Context configuration.
        #
        # Example:
        #
        #     context:
        #       rules:
        #       - selector: "*"
        #         requested:
        #         - google.rpc.context.ProjectContext
        #         - google.rpc.context.OriginContext
        #
        # The above specifies that all methods in the API request
        # `google.rpc.context.ProjectContext` and
        # `google.rpc.context.OriginContext`.
        #
        # Available context types are defined in package
        # `google.rpc.context`.
      "rules": [ # A list of RPC context rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A context rule provides information about the context for an individual API
            # element.
          "provided": [ # A list of full type names of provided contexts.
            "A String",
          ],
          "requested": [ # A list of full type names of requested contexts.
            "A String",
          ],
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "endpoints": [ # Configuration for network endpoints.  If this is empty, then an endpoint
        # with the same name as the service is automatically generated to service all
        # defined APIs.
      { # `Endpoint` describes a network endpoint that serves a set of APIs.
          # A service may expose any number of endpoints, and all endpoints share the
          # same service configuration, such as quota configuration and monitoring
          # configuration.
          #
          # Example service configuration:
          #
          #     name: library-example.googleapis.com
          #     endpoints:
          #       # Below entry makes 'google.example.library.v1.Library'
          #       # API be served from endpoint address library-example.googleapis.com.
          #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
          #       # it to decide whether the subsequent cross-origin request is
          #       # allowed to proceed.
          #     - name: library-example.googleapis.com
          #       apis: google.example.library.v1.Library
          #       allow_cors: true
          #       # Below entry makes 'google.example.library.v1.Library'
          #       # API be served from endpoint address
          #       # google.example.library-example.v1.LibraryManager.
          #     - name: library-manager.googleapis.com
          #       apis: google.example.library.v1.LibraryManager
          #       # BNS address for a borg job. Can specify a task by appending
          #       # "/taskId" (e.g. "/0") to the job spec.
          #
          # Example OpenAPI extension for endpoint with allow_cors set to true:
          #
          #     {
          #       "swagger": "2.0",
          #       "info": {
          #         "description": "A simple..."
          #       },
          #       "host": "MY_PROJECT_ID.appspot.com",
          #       "x-google-endpoints": [{
          #         "name": "MY_PROJECT_ID.appspot.com",
          #         "allow_cors": "true"
          #       }]
          #     }
        "allowCors": True or False, # Allowing
            # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
            # cross-domain traffic, would allow the backends served from this endpoint to
            # receive and respond to HTTP OPTIONS requests. The response will be used by
            # the browser to determine whether the subsequent cross-origin request is
            # allowed to proceed.
        "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
            # please specify multiple google.api.Endpoint for each of the intented
            # alias.
            #
            # Additional names that this endpoint will be hosted on.
          "A String",
        ],
        "features": [ # The list of features enabled on this endpoint.
          "A String",
        ],
        "name": "A String", # The canonical name of this endpoint.
        "apis": [ # The list of APIs served by this endpoint.
          "A String",
        ],
      },
    ],
  }
list(serviceName=None, pageSize=None, pageToken=None, x__xgafv=None) 
Lists the history of the service configuration for a managed service,
from the newest to the oldest.

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  pageSize: integer, The max number of items to include in the response list.
  pageToken: string, The token of the page to retrieve.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListServiceConfigs method.
    "nextPageToken": "A String", # The token of the next page of results.
    "serviceConfigs": [ # The list of service configuration resources.
      { # `Service` is the root object of Google service configuration schema. It
          # describes basic information about a service, such as the name and the
          # title, and delegates other aspects to sub-sections. Each sub-section is
          # either a proto message or a repeated proto message that configures a
          # specific aspect, such as auth. See each proto message definition for details.
          #
          # Example:
          #
          #     type: google.api.Service
          #     config_version: 3
          #     name: calendar.googleapis.com
          #     title: Google Calendar API
          #     apis:
          #     - name: google.calendar.v3.Calendar
          #     backend:
          #       rules:
          #       - selector: "google.calendar.v3.*"
          #         address: calendar.example.com
        "control": { # Selects and configures the service controller used by the service.  The # Configuration for the service control plane.
            # service controller handles features like abuse, quota, billing, logging,
            # monitoring, etc.
          "environment": "A String", # The service control environment to use. If empty, no control plane
              # feature (like quota and billing) will be enabled.
        },
        "monitoredResources": [ # Defines the monitored resources used by this service. This is required
            # by the Service.monitoring and Service.logging configurations.
          { # An object that describes the schema of a MonitoredResource object using a
              # type name and a set of labels.  For example, the monitored resource
              # descriptor for Google Compute Engine VM instances has a type of
              # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
              # `"zone"` to identify particular VM instances.
              #
              # Different APIs can support different monitored resource types. APIs generally
              # provide a `list` method that returns the monitored resource descriptors used
              # by the API.
            "type": "A String", # Required. The monitored resource type. For example, the type
                # `"cloudsql_database"` represents databases in Google Cloud SQL.
                # The maximum length of this value is 256 characters.
            "labels": [ # Required. A set of labels used to describe instances of this monitored
                # resource type. For example, an individual Google Cloud SQL database is
                # identified by values for the labels `"database_id"` and `"zone"`.
              { # A description of a label.
                "valueType": "A String", # The type of data that can be assigned to the label.
                "description": "A String", # A human-readable description for the label.
                "key": "A String", # The label key.
              },
            ],
            "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
                # displayed in user interfaces. It should be a Title Cased Noun Phrase,
                # without any article or other determiners. For example,
                # `"Google Cloud SQL Database"`.
            "description": "A String", # Optional. A detailed description of the monitored resource type that might
                # be used in documentation.
            "name": "A String", # Optional. The resource name of the monitored resource descriptor:
                # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
                # {type} is the value of the `type` field in this object and
                # {project_id} is a project ID that provides API-specific context for
                # accessing the type.  APIs that do not use project information can use the
                # resource name format `"monitoredResourceDescriptors/{type}"`.
          },
        ],
        "logs": [ # Defines the logs used by this service.
          { # A description of a log type. Example in YAML format:
              #
              #     - name: library.googleapis.com/activity_history
              #       description: The history of borrowing and returning library items.
              #       display_name: Activity
              #       labels:
              #       - key: /customer_id
              #         description: Identifier of a library customer
            "labels": [ # The set of labels that are available to describe a specific log entry.
                # Runtime requests that contain labels not specified here are
                # considered invalid.
              { # A description of a label.
                "valueType": "A String", # The type of data that can be assigned to the label.
                "description": "A String", # A human-readable description for the label.
                "key": "A String", # The label key.
              },
            ],
            "displayName": "A String", # The human-readable name for this log. This information appears on
                # the user interface and should be concise.
            "description": "A String", # A human-readable description of this log. This information appears in
                # the documentation and can contain details.
            "name": "A String", # The name of the log. It must be less than 512 characters long and can
                # include the following characters: upper- and lower-case alphanumeric
                # characters [A-Za-z0-9], and punctuation characters including
                # slash, underscore, hyphen, period [/_-.].
          },
        ],
        "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
            #
            # Analytics configuration.
            #
            # The example below shows how to configure monitored resources and metrics
            # for analytics. In the example, a monitored resource and two metrics are
            # defined. The `library.googleapis.com/book/returned_count` and
            # `library.googleapis.com/book/overdue_count` metric are sent
            # to the analytics.
            #
            #     monitored_resources:
            #     - type: library.googleapis.com/branch
            #       labels:
            #       - key: /city
            #         description: The city where the library branch is located in.
            #       - key: /name
            #         description: The name of the branch.
            #     metrics:
            #     - name: library.googleapis.com/book/returned_count
            #       metric_kind: DELTA
            #       value_type: INT64
            #       labels:
            #       - key: /customer_id
            #     - name: library.googleapis.com/book/overdue_count
            #       metric_kind: GAUGE
            #       value_type: INT64
            #       labels:
            #       - key: /customer_id
            #     analytics:
            #       producer_destinations:
            #       - monitored_resource: library.googleapis.com/branch
            #         metrics:
            #         - library.googleapis.com/book/returned_count
            #         - library.googleapis.com/book/overdue_count
          "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
              # There can be multiple producer destinations, each one must have a
              # different monitored resource type. A metric can be used in at most
              # one producer destination.
            { # Configuration of a specific analytics destination.
              "monitoredResource": "A String", # The monitored resource type. The type must be defined in
                  # Service.monitored_resources section.
              "metrics": [ # Names of the metrics to report to this analytics destination.
                  # Each name must be defined in Service.metrics section. Metrics
                  # with value type BOOL and STRING must be of GUAGE kind, metrics with
                  # value type INT64, DOUBLE and MONEY must be of DELTA kind.
                "A String",
              ],
            },
          ],
        },
        "systemParameters": { # ### System parameter configuration # System parameter configuration.
            #
            # A system parameter is a special kind of parameter defined by the API
            # system, not by an individual API. It is typically mapped to an HTTP header
            # and/or a URL query parameter. This configuration specifies which methods
            # change the names of the system parameters.
          "rules": [ # Define system parameters.
              #
              # The parameters defined here will override the default parameters
              # implemented by the system. If this field is missing from the service
              # config, default system parameters will be used. Default system parameters
              # and names is implementation-dependent.
              #
              # Example: define api key and alt name for all methods
              #
              # system_parameters
              #   rules:
              #     - selector: "*"
              #       parameters:
              #         - name: api_key
              #           url_query_parameter: api_key
              #         - name: alt
              #           http_header: Response-Content-Type
              #
              # Example: define 2 api key names for a specific method.
              #
              # system_parameters
              #   rules:
              #     - selector: "/ListShelves"
              #       parameters:
              #         - name: api_key
              #           http_header: Api-Key1
              #         - name: api_key
              #           http_header: Api-Key2
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # Define a system parameter rule mapping system parameter definitions to
                # methods.
              "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
                  # For a given method call, only one of them should be used. If multiple
                  # names are used the behavior is implementation-dependent.
                  # If none of the specified names are present the behavior is
                  # parameter-dependent.
                { # Define a parameter's name and location. The parameter may be passed as either
                    # an HTTP header or a URL query parameter, and if both are passed the behavior
                    # is implementation-dependent.
                  "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
                      # sensitive.
                  "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
                      # and etc. It is case sensitive.
                  "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
                      # insensitive.
                },
              ],
              "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
                  # methods in all APIs.
                  #
                  # Refer to selector for syntax details.
            },
          ],
        },
        "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
          "rules": [ # A list of API backend rules that apply to individual API methods.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # A backend rule provides configuration for an individual API element.
              "selector": "A String", # Selects the methods to which this rule applies.
                  #
                  # Refer to selector for syntax details.
              "deadline": 3.14, # The number of seconds to wait for a response from a request.  The
                  # default depends on the deployment context.
              "address": "A String", # The address of the API backend.
            },
          ],
        },
        "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
            #
            # The example below shows how to configure monitored resources and metrics
            # for monitoring. In the example, a monitored resource and two metrics are
            # defined. The `library.googleapis.com/book/returned_count` metric is sent
            # to both producer and consumer projects, whereas the
            # `library.googleapis.com/book/overdue_count` metric is only sent to the
            # consumer project.
            #
            #     monitored_resources:
            #     - type: library.googleapis.com/branch
            #       labels:
            #       - key: /city
            #         description: The city where the library branch is located in.
            #       - key: /name
            #         description: The name of the branch.
            #     metrics:
            #     - name: library.googleapis.com/book/returned_count
            #       metric_kind: DELTA
            #       value_type: INT64
            #       labels:
            #       - key: /customer_id
            #     - name: library.googleapis.com/book/overdue_count
            #       metric_kind: GAUGE
            #       value_type: INT64
            #       labels:
            #       - key: /customer_id
            #     monitoring:
            #       producer_destinations:
            #       - monitored_resource: library.googleapis.com/branch
            #         metrics:
            #         - library.googleapis.com/book/returned_count
            #       consumer_destinations:
            #       - monitored_resource: library.googleapis.com/branch
            #         metrics:
            #         - library.googleapis.com/book/returned_count
            #         - library.googleapis.com/book/overdue_count
          "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
              # There can be multiple producer destinations, each one must have a
              # different monitored resource type. A metric can be used in at most
              # one producer destination.
            { # Configuration of a specific monitoring destination (the producer project
                # or the consumer project).
              "monitoredResource": "A String", # The monitored resource type. The type must be defined in
                  # Service.monitored_resources section.
              "metrics": [ # Names of the metrics to report to this monitoring destination.
                  # Each name must be defined in Service.metrics section.
                "A String",
              ],
            },
          ],
          "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
              # There can be multiple consumer destinations, each one must have a
              # different monitored resource type. A metric can be used in at most
              # one consumer destination.
            { # Configuration of a specific monitoring destination (the producer project
                # or the consumer project).
              "monitoredResource": "A String", # The monitored resource type. The type must be defined in
                  # Service.monitored_resources section.
              "metrics": [ # Names of the metrics to report to this monitoring destination.
                  # Each name must be defined in Service.metrics section.
                "A String",
              ],
            },
          ],
        },
        "title": "A String", # The product title associated with this service.
        "id": "A String", # A unique ID for a specific instance of this message, typically assigned
            # by the client for tracking purpose. If empty, the server may choose to
            # generate one instead.
        "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
            #
            # Example for an API targeted for external use:
            #
            #     name: calendar.googleapis.com
            #     authentication:
            #       rules:
            #       - selector: "*"
            #         oauth:
            #           canonical_scopes: https://www.googleapis.com/auth/calendar
            #
            #       - selector: google.calendar.Delegate
            #         oauth:
            #           canonical_scopes: https://www.googleapis.com/auth/calendar.read
          "rules": [ # A list of authentication rules that apply to individual API methods.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # Authentication rules for the service.
                #
                # By default, if a method has any authentication requirements, every request
                # must include a valid credential matching one of the requirements.
                # It's an error to include more than one kind of credential in a single
                # request.
                #
                # If a method doesn't have any auth requirements, request credentials will be
                # ignored.
              "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
                  # there are scopes defined for "Read-only access to Google Calendar" and
                  # "Access to Cloud Platform". Users can consent to a scope for an application,
                  # giving it permission to access that data on their behalf.
                  #
                  # OAuth scope specifications should be fairly coarse grained; a user will need
                  # to see and understand the text description of what your scope means.
                  #
                  # In most cases: use one or at most two OAuth scopes for an entire family of
                  # products. If your product has multiple APIs, you should probably be sharing
                  # the OAuth scope across all of those APIs.
                  #
                  # When you need finer grained OAuth consent screens: talk with your product
                  # management about how developers will use them in practice.
                  #
                  # Please note that even though each of the canonical scopes is enough for a
                  # request to be accepted and passed to the backend, a request can still fail
                  # due to the backend requiring additional scopes or permissions.
                "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
                    # OAuth token containing any of these scopes will be accepted.
                    #
                    # Example:
                    #
                    #      canonical_scopes: https://www.googleapis.com/auth/calendar,
                    #                        https://www.googleapis.com/auth/calendar.read
              },
              "requirements": [ # Requirements for additional authentication providers.
                { # User-defined authentication requirements, including support for
                    # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
                  "providerId": "A String", # id from authentication provider.
                      #
                      # Example:
                      #
                      #     provider_id: bookstore_auth
                  "audiences": "A String", # The list of JWT
                      # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
                      # that are allowed to access. A JWT containing any of these audiences will
                      # be accepted. When this setting is absent, only JWTs with audience
                      # "https://Service_name/API_name"
                      # will be accepted. For example, if no audiences are in the setting,
                      # LibraryService API will only accept JWTs with the following audience
                      # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
                      #
                      # Example:
                      #
                      #     audiences: bookstore_android.apps.googleusercontent.com,
                      #                bookstore_web.apps.googleusercontent.com
                },
              ],
              "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
                  # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
                  #
                  # For requests without credentials, if the service control environment is
                  # specified, each incoming request **must** be associated with a service
                  # consumer. This can be done by passing an API key that belongs to a consumer
                  # project.
              "selector": "A String", # Selects the methods to which this rule applies.
                  #
                  # Refer to selector for syntax details.
            },
          ],
          "providers": [ # Defines a set of authentication providers that a service supports.
            { # Configuration for an anthentication provider, including support for
                # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
              "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
                  # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
                  # Optional if the key set document:
                  #  - can be retrieved from
                  #    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
                  #    of the issuer.
                  #  - can be inferred from the email domain of the issuer (e.g. a Google service account).
                  #
                  # Example: https://www.googleapis.com/oauth2/v1/certs
              "id": "A String", # The unique identifier of the auth provider. It will be referred to by
                  # `AuthRequirement.provider_id`.
                  #
                  # Example: "bookstore_auth".
              "issuer": "A String", # Identifies the principal that issued the JWT. See
                  # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
                  # Usually a URL or an email address.
                  #
                  # Example: https://securetoken.google.com
                  # Example: 1234567-compute@developer.gserviceaccount.com
            },
          ],
        },
        "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
          "rules": [ # A list of usage rules that apply to individual API methods.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # Usage configuration rules for the service.
                #
                # NOTE: Under development.
                #
                #
                # Use this rule to configure unregistered calls for the service. Unregistered
                # calls are calls that do not contain consumer project identity.
                # (Example: calls that do not contain an API key).
                # By default, API methods do not allow unregistered calls, and each method call
                # must be identified by a consumer project identity. Use this rule to
                # allow/disallow unregistered calls.
                #
                # Example of an API that wants to allow unregistered calls for entire service.
                #
                #     usage:
                #       rules:
                #       - selector: "*"
                #         allow_unregistered_calls: true
                #
                # Example of a method that wants to allow unregistered calls.
                #
                #     usage:
                #       rules:
                #       - selector: "google.example.library.v1.LibraryService.CreateBook"
                #         allow_unregistered_calls: true
              "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
                  # methods in all APIs.
                  #
                  # Refer to selector for syntax details.
              "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
            },
          ],
          "requirements": [ # Requirements that must be satisfied before a consumer project can use the
              # service. Each requirement is of the form /;
              # for example 'serviceusage.googleapis.com/billing-enabled'.
            "A String",
          ],
        },
        "configVersion": 42, # The version of the service configuration. The config version may
            # influence interpretation of the configuration, for example, to
            # determine defaults. This is documented together with applicable
            # options. The current default for the config version itself is `3`.
        "producerProjectId": "A String", # The id of the Google developer project that owns the service.
            # Members of this project can manage the service configuration,
            # manage consumption of the service, etc.
        "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
            # HttpRule, each specifying the mapping of an RPC method
            # to one or more HTTP REST API methods.
          "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
                # REST APIs.  The mapping determines what portions of the request
                # message are populated from the path, query parameters, or body of
                # the HTTP request.  The mapping is typically specified as an
                # `google.api.http` annotation, see "google/api/annotations.proto"
                # for details.
                #
                # The mapping consists of a field specifying the path template and
                # method kind.  The path template can refer to fields in the request
                # message, as in the example below which describes a REST GET
                # operation on a resource collection of messages:
                #
                # ```proto
                # service Messaging {
                #   rpc GetMessage(GetMessageRequest) returns (Message) {
                #     option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
                #   }
                # }
                # message GetMessageRequest {
                #   message SubMessage {
                #     string subfield = 1;
                #   }
                #   string message_id = 1; // mapped to the URL
                #   SubMessage sub = 2;    // `sub.subfield` is url-mapped
                # }
                # message Message {
                #   string text = 1; // content of the resource
                # }
                # ```
                #
                # This definition enables an automatic, bidrectional mapping of HTTP
                # JSON to RPC. Example:
                #
                # HTTP | RPC
                # -----|-----
                # `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
                #
                # In general, not only fields but also field paths can be referenced
                # from a path pattern. Fields mapped to the path pattern cannot be
                # repeated and must have a primitive (non-message) type.
                #
                # Any fields in the request message which are not bound by the path
                # pattern automatically become (optional) HTTP query
                # parameters. Assume the following definition of the request message:
                #
                # ```proto
                # message GetMessageRequest {
                #   message SubMessage {
                #     string subfield = 1;
                #   }
                #   string message_id = 1; // mapped to the URL
                #   int64 revision = 2;    // becomes a parameter
                #   SubMessage sub = 3;    // `sub.subfield` becomes a parameter
                # }
                # ```
                #
                # This enables a HTTP JSON to RPC mapping as below:
                #
                # HTTP | RPC
                # -----|-----
                # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
                #
                # Note that fields which are mapped to HTTP parameters must have a
                # primitive type or a repeated primitive type. Message types are not
                # allowed. In the case of a repeated type, the parameter can be
                # repeated in the URL, as in `...?param=A¶m=B`.
                #
                # For HTTP method kinds which allow a request body, the `body` field
                # specifies the mapping. Consider a REST update method on the
                # message resource collection:
                #
                # ```proto
                # service Messaging {
                #   rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
                #     option (google.api.http) = {
                #       put: "/v1/messages/{message_id}"
                #       body: "message"
                #     };
                #   }
                # }
                # message UpdateMessageRequest {
                #   string message_id = 1; // mapped to the URL
                #   Message message = 2;   // mapped to the body
                # }
                # ```
                #
                # The following HTTP JSON to RPC mapping is enabled, where the
                # representation of the JSON in the request body is determined by
                # protos JSON encoding:
                #
                # HTTP | RPC
                # -----|-----
                # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
                #
                # The special name `*` can be used in the body mapping to define that
                # every field not bound by the path template should be mapped to the
                # request body.  This enables the following alternative definition of
                # the update method:
                #
                # ```proto
                # service Messaging {
                #   rpc UpdateMessage(Message) returns (Message) {
                #     option (google.api.http) = {
                #       put: "/v1/messages/{message_id}"
                #       body: "*"
                #     };
                #   }
                # }
                # message Message {
                #   string message_id = 1;
                #   string text = 2;
                # }
                # ```
                #
                # The following HTTP JSON to RPC mapping is enabled:
                #
                # HTTP | RPC
                # -----|-----
                # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
                #
                # Note that when using `*` in the body mapping, it is not possible to
                # have HTTP parameters, as all fields not bound by the path end in
                # the body. This makes this option more rarely used in practice of
                # defining REST APIs. The common usage of `*` is in custom methods
                # which don't use the URL at all for transferring data.
                #
                # It is possible to define multiple HTTP methods for one RPC by using
                # the `additional_bindings` option. Example:
                #
                # ```proto
                # service Messaging {
                #   rpc GetMessage(GetMessageRequest) returns (Message) {
                #     option (google.api.http) = {
                #       get: "/v1/messages/{message_id}"
                #       additional_bindings {
                #         get: "/v1/users/{user_id}/messages/{message_id}"
                #       }
                #     };
                #   }
                # }
                # message GetMessageRequest {
                #   string message_id = 1;
                #   string user_id = 2;
                # }
                # ```
                #
                # This enables the following two alternative HTTP JSON to RPC
                # mappings:
                #
                # HTTP | RPC
                # -----|-----
                # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
                # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
                #
                # # Rules for HTTP mapping
                #
                # The rules for mapping HTTP path, query parameters, and body fields
                # to the request message are as follows:
                #
                # 1. The `body` field specifies either `*` or a field path, or is
                #    omitted. If omitted, it assumes there is no HTTP body.
                # 2. Leaf fields (recursive expansion of nested messages in the
                #    request) can be classified into three types:
                #     (a) Matched in the URL template.
                #     (b) Covered by body (if body is `*`, everything except (a) fields;
                #         else everything under the body field)
                #     (c) All other fields.
                # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
                # 4. Any body sent with an HTTP request can contain only (b) fields.
                #
                # The syntax of the path template is as follows:
                #
                #     Template = "/" Segments [ Verb ] ;
                #     Segments = Segment { "/" Segment } ;
                #     Segment  = "*" | "**" | LITERAL | Variable ;
                #     Variable = "{" FieldPath [ "=" Segments ] "}" ;
                #     FieldPath = IDENT { "." IDENT } ;
                #     Verb     = ":" LITERAL ;
                #
                # The syntax `*` matches a single path segment. It follows the semantics of
                # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
                # Expansion.
                #
                # The syntax `**` matches zero or more path segments. It follows the semantics
                # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
                # Expansion.
                #
                # The syntax `LITERAL` matches literal text in the URL path.
                #
                # The syntax `Variable` matches the entire path as specified by its template;
                # this nested template must not contain further variables. If a variable
                # matches a single path segment, its template may be omitted, e.g. `{var}`
                # is equivalent to `{var=*}`.
                #
                # NOTE: the field paths in variables and in the `body` must not refer to
                # repeated fields or map fields.
                #
                # Use CustomHttpPattern to specify any HTTP method that is not included in the
                # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
                # a given URL path rule. The wild-card rule is useful for services that provide
                # content to Web (HTML) clients.
              "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
                  # `*` for mapping all fields not captured by the path pattern to the HTTP
                  # body. NOTE: the referred field must not be a repeated field and must be
                  # present at the top-level of response message type.
              "get": "A String", # Used for listing and getting information about resources.
              "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
                  # [][google.bytestream.RestByteStream] as an API to your
                  # configuration.
                  # [][google.bytestream.RestByteStream] as an API to your
                  # configuration.
                "enabled": True or False, # Whether download is enabled.
              },
              "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
                  # not contain an `additional_bindings` field themselves (that is,
                  # the nesting may only be one level deep).
                # Object with schema name: HttpRule
              ],
              "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
                  # [][google.bytestream.RestByteStream] as an API to your
                  # configuration.
                  # [][google.bytestream.RestByteStream] as an API to your
                  # configuration.
                "enabled": True or False, # Whether upload is enabled.
              },
              "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
                "path": "A String", # The path matched by this custom verb.
                "kind": "A String", # The name of this custom HTTP verb.
              },
              "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
                  # response. Other response fields are ignored. This field is optional. When
                  # not set, the response message will be used as HTTP body of response.
                  # NOTE: the referred field must be not a repeated field and must be present
                  # at the top-level of response message type.
              "put": "A String", # Used for updating a resource.
              "patch": "A String", # Used for updating a resource.
              "post": "A String", # Used for creating a resource.
              "selector": "A String", # Selects methods to which this rule applies.
                  #
                  # Refer to selector for syntax details.
              "delete": "A String", # Used for deleting a resource.
            },
          ],
        },
        "apis": [ # A list of API interfaces exported by this service. Only the `name` field
            # of the google.protobuf.Api needs to be provided by the configuration
            # author, as the remaining fields will be derived from the IDL during the
            # normalization process. It is an error to specify an API interface here
            # which cannot be resolved against the associated IDL files.
          { # Api is a light-weight descriptor for a protocol buffer service.
            "methods": [ # The methods of this api, in unspecified order.
              { # Method represents a method of an api.
                "name": "A String", # The simple name of this method.
                "requestStreaming": True or False, # If true, the request is streamed.
                "responseTypeUrl": "A String", # The URL of the output message type.
                "requestTypeUrl": "A String", # A URL of the input message type.
                "responseStreaming": True or False, # If true, the response is streamed.
                "syntax": "A String", # The source syntax of this method.
                "options": [ # Any metadata attached to the method.
                  { # A protocol buffer option, which can be attached to a message, field,
                      # enumeration, etc.
                    "name": "A String", # The option's name. For example, `"java_package"`.
                    "value": { # The option's value. For example, `"com.google.protobuf"`.
                      "a_key": "", # Properties of the object. Contains field @type with type URL.
                    },
                  },
                ],
              },
            ],
            "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
                # message.
                # protobuf element, like the file in which it is defined.
              "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
                  # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
            },
            "mixins": [ # Included APIs. See Mixin.
              { # Declares an API to be included in this API. The including API must
                  # redeclare all the methods from the included API, but documentation
                  # and options are inherited as follows:
                  #
                  # - If after comment and whitespace stripping, the documentation
                  #   string of the redeclared method is empty, it will be inherited
                  #   from the original method.
                  #
                  # - Each annotation belonging to the service config (http,
                  #   visibility) which is not set in the redeclared method will be
                  #   inherited.
                  #
                  # - If an http annotation is inherited, the path pattern will be
                  #   modified as follows. Any version prefix will be replaced by the
                  #   version of the including API plus the root path if specified.
                  #
                  # Example of a simple mixin:
                  #
                  #     package google.acl.v1;
                  #     service AccessControl {
                  #       // Get the underlying ACL object.
                  #       rpc GetAcl(GetAclRequest) returns (Acl) {
                  #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
                  #       }
                  #     }
                  #
                  #     package google.storage.v2;
                  #     service Storage {
                  #       //       rpc GetAcl(GetAclRequest) returns (Acl);
                  #
                  #       // Get a data record.
                  #       rpc GetData(GetDataRequest) returns (Data) {
                  #         option (google.api.http).get = "/v2/{resource=**}";
                  #       }
                  #     }
                  #
                  # Example of a mixin configuration:
                  #
                  #     apis:
                  #     - name: google.storage.v2.Storage
                  #       mixins:
                  #       - name: google.acl.v1.AccessControl
                  #
                  # The mixin construct implies that all methods in `AccessControl` are
                  # also declared with same name and request/response types in
                  # `Storage`. A documentation generator or annotation processor will
                  # see the effective `Storage.GetAcl` method after inherting
                  # documentation and annotations as follows:
                  #
                  #     service Storage {
                  #       // Get the underlying ACL object.
                  #       rpc GetAcl(GetAclRequest) returns (Acl) {
                  #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
                  #       }
                  #       ...
                  #     }
                  #
                  # Note how the version in the path pattern changed from `v1` to `v2`.
                  #
                  # If the `root` field in the mixin is specified, it should be a
                  # relative path under which inherited HTTP paths are placed. Example:
                  #
                  #     apis:
                  #     - name: google.storage.v2.Storage
                  #       mixins:
                  #       - name: google.acl.v1.AccessControl
                  #         root: acls
                  #
                  # This implies the following inherited HTTP annotation:
                  #
                  #     service Storage {
                  #       // Get the underlying ACL object.
                  #       rpc GetAcl(GetAclRequest) returns (Acl) {
                  #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
                  #       }
                  #       ...
                  #     }
                "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
                    # are rooted.
                "name": "A String", # The fully qualified name of the API which is included.
              },
            ],
            "syntax": "A String", # The source syntax of the service.
            "version": "A String", # A version string for this api. If specified, must have the form
                # `major-version.minor-version`, as in `1.10`. If the minor version
                # is omitted, it defaults to zero. If the entire version field is
                # empty, the major version is derived from the package name, as
                # outlined below. If the field is not empty, the version in the
                # package name will be verified to be consistent with what is
                # provided here.
                #
                # The versioning schema uses [semantic
                # versioning](http://semver.org) where the major version number
                # indicates a breaking change and the minor version an additive,
                # non-breaking change. Both version numbers are signals to users
                # what to expect from different versions, and should be carefully
                # chosen based on the product plan.
                #
                # The major version is also reflected in the package name of the
                # API, which must end in `v`, as in
                # `google.feature.v1`. For major versions 0 and 1, the suffix can
                # be omitted. Zero major versions must only be used for
                # experimental, none-GA apis.
            "options": [ # Any metadata attached to the API.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "name": "A String", # The fully qualified name of this api, including package name
                # followed by the api's simple name.
          },
        ],
        "customError": { # Customize service error responses.  For example, list any service # Custom error configuration.
            # specific protobuf types that can appear in error detail lists of
            # error responses.
            #
            # Example:
            #
            #     custom_error:
            #       types:
            #       - google.foo.v1.CustomError
            #       - google.foo.v1.AnotherError
          "rules": [ # The list of custom error rules that apply to individual API messages.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # A custom error rule.
              "isErrorType": True or False, # Mark this message as possible payload in error response.  Otherwise,
                  # objects of this type will be filtered when they appear in error payload.
              "selector": "A String", # Selects messages to which this rule applies.
                  #
                  # Refer to selector for syntax details.
            },
          ],
          "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
            "A String",
          ],
        },
        "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
            # elements.  Restrictions are specified using visibility labels
            # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
            #
            # Users and projects can have access to more than one visibility label. The
            # effective visibility for multiple labels is the union of each label's
            # elements, plus any unrestricted elements.
            #
            # If an element and its parents have no restrictions, visibility is
            # unconditionally granted.
            #
            # Example:
            #
            #     visibility:
            #       rules:
            #       - selector: google.calendar.Calendar.EnhancedSearch
            #         restriction: TRUSTED_TESTER
            #       - selector: google.calendar.Calendar.Delegate
            #         restriction: GOOGLE_INTERNAL
            #
            # Here, all methods are publicly visible except for the restricted methods
            # EnhancedSearch and Delegate.
          "rules": [ # A list of visibility rules that apply to individual API elements.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # A visibility rule provides visibility configuration for an individual API
                # element.
              "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
                  # Any of the listed labels can be used to grant the visibility.
                  #
                  # If a rule has multiple labels, removing one of the labels but not all of
                  # them can break clients.
                  #
                  # Example:
                  #
                  #     visibility:
                  #       rules:
                  #       - selector: google.calendar.Calendar.EnhancedSearch
                  #         restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
                  #
                  # Removing GOOGLE_INTERNAL from this restriction will break clients that
                  # rely on this method and only had access to it through GOOGLE_INTERNAL.
              "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
                  #
                  # Refer to selector for syntax details.
            },
          ],
        },
        "metrics": [ # Defines the metrics used by this service.
          { # Defines a metric type and its schema.
            "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
                # Use sentence case without an ending period, for example "Request count".
            "description": "A String", # A detailed description of the metric, which can be used in documentation.
            "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
                # Some combinations of `metric_kind` and `value_type` might not be supported.
            "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
                # Some combinations of `metric_kind` and `value_type` might not be supported.
            "labels": [ # The set of labels that can be used to describe a specific instance of this
                # metric type. For example, the
                # `compute.googleapis.com/instance/network/received_bytes_count` metric type
                # has a label, `loadbalanced`, that specifies whether the traffic was
                # received through a load balanced IP address.
              { # A description of a label.
                "valueType": "A String", # The type of data that can be assigned to the label.
                "description": "A String", # A human-readable description for the label.
                "key": "A String", # The label key.
              },
            ],
            "type": "A String", # The metric type including a DNS name prefix, for example
                # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
                # should use a natural hierarchical grouping such as the following:
                #
                #     compute.googleapis.com/instance/cpu/utilization
                #     compute.googleapis.com/instance/disk/read_ops_count
                #     compute.googleapis.com/instance/network/received_bytes_count
                #
                # Note that if the metric type changes, the monitoring data will be
                # discontinued, and anything depends on it will break, such as monitoring
                # dashboards, alerting rules and quota limits. Therefore, once a metric has
                # been published, its type should be immutable.
            "unit": "A String", # The unit in which the metric value is reported. It is only applicable
                # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
                # supported units are a subset of [The Unified Code for Units of
                # Measure](http://unitsofmeasure.org/ucum.html) standard:
                #
                # **Basic units (UNIT)**
                #
                # * `bit`   bit
                # * `By`    byte
                # * `s`     second
                # * `min`   minute
                # * `h`     hour
                # * `d`     day
                #
                # **Prefixes (PREFIX)**
                #
                # * `k`     kilo    (10**3)
                # * `M`     mega    (10**6)
                # * `G`     giga    (10**9)
                # * `T`     tera    (10**12)
                # * `P`     peta    (10**15)
                # * `E`     exa     (10**18)
                # * `Z`     zetta   (10**21)
                # * `Y`     yotta   (10**24)
                # * `m`     milli   (10**-3)
                # * `u`     micro   (10**-6)
                # * `n`     nano    (10**-9)
                # * `p`     pico    (10**-12)
                # * `f`     femto   (10**-15)
                # * `a`     atto    (10**-18)
                # * `z`     zepto   (10**-21)
                # * `y`     yocto   (10**-24)
                # * `Ki`    kibi    (2**10)
                # * `Mi`    mebi    (2**20)
                # * `Gi`    gibi    (2**30)
                # * `Ti`    tebi    (2**40)
                #
                # **Grammar**
                #
                # The grammar includes the dimensionless unit `1`, such as `1/s`.
                #
                # The grammar also includes these connectors:
                #
                # * `/`    division (as an infix operator, e.g. `1/s`).
                # * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
                #
                # The grammar for a unit is as follows:
                #
                #     Expression = Component { "." Component } { "/" Component } ;
                #
                #     Component = [ PREFIX ] UNIT [ Annotation ]
                #               | Annotation
                #               | "1"
                #               ;
                #
                #     Annotation = "{" NAME "}" ;
                #
                # Notes:
                #
                # * `Annotation` is just a comment if it follows a `UNIT` and is
                #    equivalent to `1` if it is used alone. For examples,
                #    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
                # * `NAME` is a sequence of non-blank printable ASCII characters not
                #    containing '{' or '}'.
            "name": "A String", # Resource name. The format of the name may vary between different
                # implementations. For examples:
                #
                #     projects/{project_id}/metricDescriptors/{type=**}
                #     metricDescriptors/{type=**}
          },
        ],
        "enums": [ # A list of all enum types included in this API service.  Enums
            # referenced directly or indirectly by the `apis` are automatically
            # included.  Enums which are not referenced but shall be included
            # should be listed here by name. Example:
            #
            #     enums:
            #     - name: google.someapi.v1.SomeEnum
          { # Enum type definition.
            "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
                # protobuf element, like the file in which it is defined.
              "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
                  # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
            },
            "enumvalue": [ # Enum value definitions.
              { # Enum value definition.
                "number": 42, # Enum value number.
                "options": [ # Protocol buffer options.
                  { # A protocol buffer option, which can be attached to a message, field,
                      # enumeration, etc.
                    "name": "A String", # The option's name. For example, `"java_package"`.
                    "value": { # The option's value. For example, `"com.google.protobuf"`.
                      "a_key": "", # Properties of the object. Contains field @type with type URL.
                    },
                  },
                ],
                "name": "A String", # Enum value name.
              },
            ],
            "options": [ # Protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "name": "A String", # Enum type name.
            "syntax": "A String", # The source syntax.
          },
        ],
        "types": [ # A list of all proto message types included in this API service.
            # Types referenced directly or indirectly by the `apis` are
            # automatically included.  Messages which are not referenced but
            # shall be included, such as types used by the `google.protobuf.Any` type,
            # should be listed here by name. Example:
            #
            #     types:
            #     - name: google.protobuf.Int32
          { # A protocol buffer message type.
            "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
              "A String",
            ],
            "name": "A String", # The fully qualified message name.
            "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
                # protobuf element, like the file in which it is defined.
              "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
                  # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
            },
            "syntax": "A String", # The source syntax.
            "fields": [ # The list of fields.
              { # A single field of a message type.
                "kind": "A String", # The field type.
                "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                    # types. The first type has index 1; zero means the type is not in the list.
                "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                    # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
                "name": "A String", # The field name.
                "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
                "jsonName": "A String", # The field JSON name.
                "number": 42, # The field number.
                "cardinality": "A String", # The field cardinality.
                "options": [ # The protocol buffer options.
                  { # A protocol buffer option, which can be attached to a message, field,
                      # enumeration, etc.
                    "name": "A String", # The option's name. For example, `"java_package"`.
                    "value": { # The option's value. For example, `"com.google.protobuf"`.
                      "a_key": "", # Properties of the object. Contains field @type with type URL.
                    },
                  },
                ],
                "packed": True or False, # Whether to use alternative packed wire representation.
              },
            ],
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
          },
        ],
        "logging": { # Logging configuration of the service. # Logging configuration.
            #
            # The following example shows how to configure logs to be sent to the
            # producer and consumer projects. In the example, the `activity_history`
            # log is sent to both the producer and consumer projects, whereas the
            # `purchase_history` log is only sent to the producer project.
            #
            #     monitored_resources:
            #     - type: library.googleapis.com/branch
            #       labels:
            #       - key: /city
            #         description: The city where the library branch is located in.
            #       - key: /name
            #         description: The name of the branch.
            #     logs:
            #     - name: activity_history
            #       labels:
            #       - key: /customer_id
            #     - name: purchase_history
            #     logging:
            #       producer_destinations:
            #       - monitored_resource: library.googleapis.com/branch
            #         logs:
            #         - activity_history
            #         - purchase_history
            #       consumer_destinations:
            #       - monitored_resource: library.googleapis.com/branch
            #         logs:
            #         - activity_history
          "producerDestinations": [ # Logging configurations for sending logs to the producer project.
              # There can be multiple producer destinations, each one must have a
              # different monitored resource type. A log can be used in at most
              # one producer destination.
            { # Configuration of a specific logging destination (the producer project
                # or the consumer project).
              "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
                  # Service.monitored_resources section.
              "logs": [ # Names of the logs to be sent to this destination. Each name must
                  # be defined in the Service.logs section. If the log name is
                  # not a domain scoped name, it will be automatically prefixed with
                  # the service name followed by "/".
                "A String",
              ],
            },
          ],
          "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
              # There can be multiple consumer destinations, each one must have a
              # different monitored resource type. A log can be used in at most
              # one consumer destination.
            { # Configuration of a specific logging destination (the producer project
                # or the consumer project).
              "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
                  # Service.monitored_resources section.
              "logs": [ # Names of the logs to be sent to this destination. Each name must
                  # be defined in the Service.logs section. If the log name is
                  # not a domain scoped name, it will be automatically prefixed with
                  # the service name followed by "/".
                "A String",
              ],
            },
          ],
        },
        "name": "A String", # The DNS address at which this service is available,
            # e.g. `calendar.googleapis.com`.
        "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
            #
            # Example:
            # 
documentation:
            #   summary: >
            #     The Google Calendar API gives access
            #     to most calendar features.
            #   pages:
            #   - name: Overview
            #     content: (== include google/foo/overview.md ==)
            #   - name: Tutorial
            #     content: (== include google/foo/tutorial.md ==)
            #     subpages;
            #     - name: Java
            #       content: (== include google/foo/tutorial_java.md ==)
            #   rules:
            #   - selector: google.calendar.Calendar.Get
            #     description: >
            #       ...
            #   - selector: google.calendar.Calendar.Put
            #     description: >
            #       ...
            # 

            # Documentation is provided in markdown syntax. In addition to
            # standard markdown features, definition lists, tables and fenced
            # code blocks are supported. Section headers can be provided and are
            # interpreted relative to the section nesting of the context where
            # a documentation fragment is embedded.
            #
            # Documentation from the IDL is merged with documentation defined
            # via the config at normalization time, where documentation provided
            # by config rules overrides IDL provided.
            #
            # A number of constructs specific to the API platform are supported
            # in documentation text.
            #
            # In order to reference a proto element, the following
            # notation can be used:
            # 
[fully.qualified.proto.name][]

            # To override the display text used for the link, this can be used:
            # 
[display text][fully.qualified.proto.name]

            # Text can be excluded from doc using the following notation:
            # 
(-- internal comment --)

            # Comments can be made conditional using a visibility label. The below
            # text will be only rendered if the `BETA` label is available:
            # 
(--BETA: comment for BETA users --)

            # A few directives are available in documentation. Note that
            # directives must appear on a single line to be properly
            # identified. The `include` directive includes a markdown file from
            # an external source:
            # 
(== include path/to/file ==)

            # The `resource_for` directive marks a message to be the resource of
            # a collection in REST view. If it is not specified, tools attempt
            # to infer the resource from the operations in a collection:
            # 
(== resource_for v1.shelves.books ==)

            # The directive `suppress_warning` does not directly affect documentation
            # and is documented together with service config validation.
          "rules": [ # A list of documentation rules that apply to individual API elements.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # A documentation rule provides information about individual API elements.
              "description": "A String", # Description of the selected API(s).
              "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
                  # element is marked as `deprecated`.
              "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
                  # qualified name of the element which may end in "*", indicating a wildcard.
                  # Wildcards are only allowed at the end and for a whole component of the
                  # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
                  # specify a default for all applicable elements, the whole pattern "*"
                  # is used.
            },
          ],
          "overview": "A String", # Declares a single overview page. For example:
              # 
documentation:
              #   summary: ...
              #   overview: (== include overview.md ==)
              # 

              # This is a shortcut for the following declaration (using pages style):
              # 
documentation:
              #   summary: ...
              #   pages:
              #   - name: Overview
              #     content: (== include overview.md ==)
              # 

              # Note: you cannot specify both `overview` field and `pages` field.
          "summary": "A String", # A short summary of what the service does. Can only be provided by
              # plain text.
          "pages": [ # The top level pages for the documentation set.
            { # Represents a documentation page. A page can contain subpages to represent
                # nested documentation set structure.
              "content": "A String", # The Markdown content of the page. You can use (== include {path} ==)
                  # to include content from a Markdown file.
              "subpages": [ # Subpages of this page. The order of subpages specified here will be
                  # honored in the generated docset.
                # Object with schema name: Page
              ],
              "name": "A String", # The name of the page. It will be used as an identity of the page to
                  # generate URI of the page, text of the link to this page in navigation,
                  # etc. The full page name (start from the root page name to this page
                  # concatenated with `.`) can be used as reference to the page in your
                  # documentation. For example:
                  # 
pages:
                  # - name: Tutorial
                  #   content: (== include tutorial.md ==)
                  #   subpages:
                  #   - name: Java
                  #     content: (== include tutorial_java.md ==)
                  # 

                  # You can reference `Java` page using Markdown reference link syntax:
                  # `Java`.
            },
          ],
          "documentationRootUrl": "A String", # The URL to the root of documentation.
        },
        "systemTypes": [ # A list of all proto message types included in this API service.
            # It serves similar purpose as [google.api.Service.types], except that
            # these types are not needed by user-defined APIs. Therefore, they will not
            # show up in the generated discovery doc. This field should only be used
            # to define system APIs in ESF.
          { # A protocol buffer message type.
            "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
              "A String",
            ],
            "name": "A String", # The fully qualified message name.
            "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
                # protobuf element, like the file in which it is defined.
              "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
                  # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
            },
            "syntax": "A String", # The source syntax.
            "fields": [ # The list of fields.
              { # A single field of a message type.
                "kind": "A String", # The field type.
                "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                    # types. The first type has index 1; zero means the type is not in the list.
                "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                    # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
                "name": "A String", # The field name.
                "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
                "jsonName": "A String", # The field JSON name.
                "number": 42, # The field number.
                "cardinality": "A String", # The field cardinality.
                "options": [ # The protocol buffer options.
                  { # A protocol buffer option, which can be attached to a message, field,
                      # enumeration, etc.
                    "name": "A String", # The option's name. For example, `"java_package"`.
                    "value": { # The option's value. For example, `"com.google.protobuf"`.
                      "a_key": "", # Properties of the object. Contains field @type with type URL.
                    },
                  },
                ],
                "packed": True or False, # Whether to use alternative packed wire representation.
              },
            ],
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
          },
        ],
        "context": { # `Context` defines which contexts an API requests. # Context configuration.
            #
            # Example:
            #
            #     context:
            #       rules:
            #       - selector: "*"
            #         requested:
            #         - google.rpc.context.ProjectContext
            #         - google.rpc.context.OriginContext
            #
            # The above specifies that all methods in the API request
            # `google.rpc.context.ProjectContext` and
            # `google.rpc.context.OriginContext`.
            #
            # Available context types are defined in package
            # `google.rpc.context`.
          "rules": [ # A list of RPC context rules that apply to individual API methods.
              #
              # **NOTE:** All service configuration rules follow "last one wins" order.
            { # A context rule provides information about the context for an individual API
                # element.
              "provided": [ # A list of full type names of provided contexts.
                "A String",
              ],
              "requested": [ # A list of full type names of requested contexts.
                "A String",
              ],
              "selector": "A String", # Selects the methods to which this rule applies.
                  #
                  # Refer to selector for syntax details.
            },
          ],
        },
        "endpoints": [ # Configuration for network endpoints.  If this is empty, then an endpoint
            # with the same name as the service is automatically generated to service all
            # defined APIs.
          { # `Endpoint` describes a network endpoint that serves a set of APIs.
              # A service may expose any number of endpoints, and all endpoints share the
              # same service configuration, such as quota configuration and monitoring
              # configuration.
              #
              # Example service configuration:
              #
              #     name: library-example.googleapis.com
              #     endpoints:
              #       # Below entry makes 'google.example.library.v1.Library'
              #       # API be served from endpoint address library-example.googleapis.com.
              #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
              #       # it to decide whether the subsequent cross-origin request is
              #       # allowed to proceed.
              #     - name: library-example.googleapis.com
              #       apis: google.example.library.v1.Library
              #       allow_cors: true
              #       # Below entry makes 'google.example.library.v1.Library'
              #       # API be served from endpoint address
              #       # google.example.library-example.v1.LibraryManager.
              #     - name: library-manager.googleapis.com
              #       apis: google.example.library.v1.LibraryManager
              #       # BNS address for a borg job. Can specify a task by appending
              #       # "/taskId" (e.g. "/0") to the job spec.
              #
              # Example OpenAPI extension for endpoint with allow_cors set to true:
              #
              #     {
              #       "swagger": "2.0",
              #       "info": {
              #         "description": "A simple..."
              #       },
              #       "host": "MY_PROJECT_ID.appspot.com",
              #       "x-google-endpoints": [{
              #         "name": "MY_PROJECT_ID.appspot.com",
              #         "allow_cors": "true"
              #       }]
              #     }
            "allowCors": True or False, # Allowing
                # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
                # cross-domain traffic, would allow the backends served from this endpoint to
                # receive and respond to HTTP OPTIONS requests. The response will be used by
                # the browser to determine whether the subsequent cross-origin request is
                # allowed to proceed.
            "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
                # please specify multiple google.api.Endpoint for each of the intented
                # alias.
                #
                # Additional names that this endpoint will be hosted on.
              "A String",
            ],
            "features": [ # The list of features enabled on this endpoint.
              "A String",
            ],
            "name": "A String", # The canonical name of this endpoint.
            "apis": [ # The list of APIs served by this endpoint.
              "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.
submit(serviceName=None, body, x__xgafv=None) 
Creates a new service configuration (version) for a managed service based
on
user-supplied configuration source files (for example: OpenAPI
Specification). This method stores the source configurations as well as the
generated service configuration. To rollout the service configuration to
other services,
please call CreateServiceRollout.

Operation

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for SubmitConfigSource method.
    "validateOnly": True or False, # Optional. If set, this will result in the generation of a
        # `google.api.Service` configuration based on the `ConfigSource` provided,
        # but the generated config and the sources will NOT be persisted.
    "configSource": { # Represents a source file which is used to generate the service configuration # The source configuration for the service.
        # defined by `google.api.Service`.
      "files": [ # Set of source configuration files that are used to generate a service
          # configuration (`google.api.Service`).
        { # Generic specification of a source configuration file
          "fileContents": "A String", # The bytes that constitute the file.
          "fileType": "A String", # The type of configuration file this represents.
          "filePath": "A String", # The file name of the configuration file (full or relative path).
        },
      ],
      "id": "A String", # A unique ID for a specific instance of this message, typically assigned
          # by the client for tracking purpose. If empty, the server may choose to
          # generate one instead.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/servicemanagement_v1.services.html000066400000000000000000004421001300622755700267050ustar00rootroot00000000000000

Google Service Management API . services

Instance Methods

configs()

Returns the configs Resource.

rollouts()

Returns the rollouts Resource.

create(body, x__xgafv=None)

Creates a new managed service.

delete(serviceName=None, x__xgafv=None)

Deletes a managed service. This method will change the serivce in the

disable(serviceName=None, body, x__xgafv=None)

Disable a managed service for a project.

enable(serviceName=None, body, x__xgafv=None)

Enable a managed service for a project with default setting.

generateConfigReport(body, x__xgafv=None)

Generates and returns a report (errors, warnings and changes from

get(serviceName=None, x__xgafv=None)

Gets a managed service.

getConfig(serviceName=None, configId=None, x__xgafv=None)

Gets a service configuration (version) for a managed service.

getIamPolicy(resource=None, body, x__xgafv=None)

Gets the access control policy for a resource.

list(producerProjectId=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all managed services.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource=None, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any

testIamPermissions(resource=None, body, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

undelete(serviceName=None, x__xgafv=None)

Revives a previously deleted managed service. The method restores the

Method Details

create(body, x__xgafv=None) 
Creates a new managed service.
Please note one producer project can own no more than 20 services.

Operation

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The full representation of a Service that is managed by
    # Google Service Management.
  "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
      # for naming requirements.
  "producerProjectId": "A String", # ID of the project that produces and owns this service.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
delete(serviceName=None, x__xgafv=None) 
Deletes a managed service. This method will change the serivce in the
`Soft-Delete` state for 30 days. Within this period, service producers may
call UndeleteService to restore the service.
After 30 days, the service will be permanently deleted.

Operation

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
disable(serviceName=None, body, x__xgafv=None) 
Disable a managed service for a project.

Operation

Args:
  serviceName: string, Name of the service to disable. Specifying an unknown service name
will cause the request to fail. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for DisableService method.
    "consumerId": "A String", # The identity of consumer resource which service disablement will be
        # applied to.
        # 
        # The Google Service Management implementation accepts the following
        # forms: "project:", "project_number:".
        # 
        # Note: this is made compatible with
        # google.api.servicecontrol.v1.Operation.consumer_id.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
enable(serviceName=None, body, x__xgafv=None) 
Enable a managed service for a project with default setting.

Operation

google.rpc.Status errors may contain a
google.rpc.PreconditionFailure error detail.

Args:
  serviceName: string, Name of the service to enable. Specifying an unknown service name will
cause the request to fail. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for EnableService method.
    "consumerId": "A String", # The identity of consumer resource which service enablement will be
        # applied to.
        # 
        # The Google Service Management implementation accepts the following
        # forms: "project:", "project_number:".
        # 
        # Note: this is made compatible with
        # google.api.servicecontrol.v1.Operation.consumer_id.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
generateConfigReport(body, x__xgafv=None) 
Generates and returns a report (errors, warnings and changes from
existing configurations) associated with
GenerateConfigReportRequest.new_value

If GenerateConfigReportRequest.old_value is specified,
GenerateConfigReportRequest will contain a single ChangeReport based on the
comparison between GenerateConfigReportRequest.new_value and
GenerateConfigReportRequest.old_value.
If GenerateConfigReportRequest.old_value is not specified, this method
will compare GenerateConfigReportRequest.new_value with the last pushed
service configuration.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for GenerateConfigReport method.
    "newConfig": { # Service configuration for which we want to generate the report.
        # For this version of API, the supported types are
        # google.api.servicemanagement.v1.ConfigRef,
        # google.api.servicemanagement.v1.ConfigSource,
        # and google.api.Service
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "oldConfig": { # Service configuration against which the comparison will be done.
        # For this version of API, the supported types are
        # google.api.servicemanagement.v1.ConfigRef,
        # google.api.servicemanagement.v1.ConfigSource,
        # and google.api.Service
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for GenerateConfigReport method.
    "serviceName": "A String", # Name of the service this report belongs to.
    "changeReports": [ # list of ChangeReport, each corresponding to comparison between two
        # service configurations.
      { # Change report associated with a particular service configuration.
          #
          # It contains a list of ConfigChanges based on the comparison between
          # two service configurations.
        "configChanges": [ # List of changes between two service configurations.
            # The changes will be alphabetically sorted based on the identifier
            # of each change.
            # A ConfigChange identifier is a dot separated path to the configuration.
            # Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
          { # Output generated from semantically comparing two versions of a service
              # configuration.
              #
              # Includes detailed information about a field that have changed with
              # applicable advice about potential consequences for the change, such as
              # backwards-incompatibility.
            "advices": [ # Collection of advice provided for this change, useful for determining the
                # possible impact of this change.
              { # Generated advice about this change, used for providing more
                  # information about how a change will affect the existing service.
                "description": "A String", # Useful description for why this advice was applied and what actions should
                    # be taken to mitigate any implied risks.
              },
            ],
            "changeType": "A String", # The type for this change, either ADDED, REMOVED, or MODIFIED.
            "newValue": "A String", # Value of the changed object in the new Service configuration,
                # in JSON format. This field will not be populated if ChangeType == REMOVED.
            "oldValue": "A String", # Value of the changed object in the old Service configuration,
                # in JSON format. This field will not be populated if ChangeType == ADDED.
            "element": "A String", # Object hierarchy path to the change, with levels separated by a '.'
                # character. For repeated fields, an applicable unique identifier field is
                # used for the index (usually selector, name, or id). For maps, the term
                # 'key' is used. If the field has no unique identifier, the numeric index
                # is used.
                # Examples:
                # - visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
                # - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
                # - logging.producer_destinations[0]
          },
        ],
      },
    ],
    "id": "A String", # ID of the service configuration this report belongs to.
    "diagnostics": [ # Errors / Linter warnings associated with the service definition this
        # report
        # belongs to.
      { # Represents a diagnostic message (error or warning)
        "kind": "A String", # The kind of diagnostic information provided.
        "message": "A String", # Message describing the error or warning.
        "location": "A String", # File name and line number of the error or warning.
      },
    ],
  }
get(serviceName=None, x__xgafv=None) 
Gets a managed service.

Args:
  serviceName: string, The name of the service.  See the `ServiceManager` overview for naming
requirements.  For example: `example.googleapis.com`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The full representation of a Service that is managed by
      # Google Service Management.
    "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
        # for naming requirements.
    "producerProjectId": "A String", # ID of the project that produces and owns this service.
  }
getConfig(serviceName=None, configId=None, x__xgafv=None) 
Gets a service configuration (version) for a managed service.

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  configId: string, A parameter
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `Service` is the root object of Google service configuration schema. It
      # describes basic information about a service, such as the name and the
      # title, and delegates other aspects to sub-sections. Each sub-section is
      # either a proto message or a repeated proto message that configures a
      # specific aspect, such as auth. See each proto message definition for details.
      #
      # Example:
      #
      #     type: google.api.Service
      #     config_version: 3
      #     name: calendar.googleapis.com
      #     title: Google Calendar API
      #     apis:
      #     - name: google.calendar.v3.Calendar
      #     backend:
      #       rules:
      #       - selector: "google.calendar.v3.*"
      #         address: calendar.example.com
    "control": { # Selects and configures the service controller used by the service.  The # Configuration for the service control plane.
        # service controller handles features like abuse, quota, billing, logging,
        # monitoring, etc.
      "environment": "A String", # The service control environment to use. If empty, no control plane
          # feature (like quota and billing) will be enabled.
    },
    "monitoredResources": [ # Defines the monitored resources used by this service. This is required
        # by the Service.monitoring and Service.logging configurations.
      { # An object that describes the schema of a MonitoredResource object using a
          # type name and a set of labels.  For example, the monitored resource
          # descriptor for Google Compute Engine VM instances has a type of
          # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
          # `"zone"` to identify particular VM instances.
          #
          # Different APIs can support different monitored resource types. APIs generally
          # provide a `list` method that returns the monitored resource descriptors used
          # by the API.
        "type": "A String", # Required. The monitored resource type. For example, the type
            # `"cloudsql_database"` represents databases in Google Cloud SQL.
            # The maximum length of this value is 256 characters.
        "labels": [ # Required. A set of labels used to describe instances of this monitored
            # resource type. For example, an individual Google Cloud SQL database is
            # identified by values for the labels `"database_id"` and `"zone"`.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
            # displayed in user interfaces. It should be a Title Cased Noun Phrase,
            # without any article or other determiners. For example,
            # `"Google Cloud SQL Database"`.
        "description": "A String", # Optional. A detailed description of the monitored resource type that might
            # be used in documentation.
        "name": "A String", # Optional. The resource name of the monitored resource descriptor:
            # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
            # {type} is the value of the `type` field in this object and
            # {project_id} is a project ID that provides API-specific context for
            # accessing the type.  APIs that do not use project information can use the
            # resource name format `"monitoredResourceDescriptors/{type}"`.
      },
    ],
    "logs": [ # Defines the logs used by this service.
      { # A description of a log type. Example in YAML format:
          #
          #     - name: library.googleapis.com/activity_history
          #       description: The history of borrowing and returning library items.
          #       display_name: Activity
          #       labels:
          #       - key: /customer_id
          #         description: Identifier of a library customer
        "labels": [ # The set of labels that are available to describe a specific log entry.
            # Runtime requests that contain labels not specified here are
            # considered invalid.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "displayName": "A String", # The human-readable name for this log. This information appears on
            # the user interface and should be concise.
        "description": "A String", # A human-readable description of this log. This information appears in
            # the documentation and can contain details.
        "name": "A String", # The name of the log. It must be less than 512 characters long and can
            # include the following characters: upper- and lower-case alphanumeric
            # characters [A-Za-z0-9], and punctuation characters including
            # slash, underscore, hyphen, period [/_-.].
      },
    ],
    "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
        #
        # Analytics configuration.
        #
        # The example below shows how to configure monitored resources and metrics
        # for analytics. In the example, a monitored resource and two metrics are
        # defined. The `library.googleapis.com/book/returned_count` and
        # `library.googleapis.com/book/overdue_count` metric are sent
        # to the analytics.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     metrics:
        #     - name: library.googleapis.com/book/returned_count
        #       metric_kind: DELTA
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     - name: library.googleapis.com/book/overdue_count
        #       metric_kind: GAUGE
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     analytics:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #         - library.googleapis.com/book/overdue_count
      "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one producer destination.
        { # Configuration of a specific analytics destination.
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this analytics destination.
              # Each name must be defined in Service.metrics section. Metrics
              # with value type BOOL and STRING must be of GUAGE kind, metrics with
              # value type INT64, DOUBLE and MONEY must be of DELTA kind.
            "A String",
          ],
        },
      ],
    },
    "systemParameters": { # ### System parameter configuration # System parameter configuration.
        #
        # A system parameter is a special kind of parameter defined by the API
        # system, not by an individual API. It is typically mapped to an HTTP header
        # and/or a URL query parameter. This configuration specifies which methods
        # change the names of the system parameters.
      "rules": [ # Define system parameters.
          #
          # The parameters defined here will override the default parameters
          # implemented by the system. If this field is missing from the service
          # config, default system parameters will be used. Default system parameters
          # and names is implementation-dependent.
          #
          # Example: define api key and alt name for all methods
          #
          # system_parameters
          #   rules:
          #     - selector: "*"
          #       parameters:
          #         - name: api_key
          #           url_query_parameter: api_key
          #         - name: alt
          #           http_header: Response-Content-Type
          #
          # Example: define 2 api key names for a specific method.
          #
          # system_parameters
          #   rules:
          #     - selector: "/ListShelves"
          #       parameters:
          #         - name: api_key
          #           http_header: Api-Key1
          #         - name: api_key
          #           http_header: Api-Key2
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Define a system parameter rule mapping system parameter definitions to
            # methods.
          "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
              # For a given method call, only one of them should be used. If multiple
              # names are used the behavior is implementation-dependent.
              # If none of the specified names are present the behavior is
              # parameter-dependent.
            { # Define a parameter's name and location. The parameter may be passed as either
                # an HTTP header or a URL query parameter, and if both are passed the behavior
                # is implementation-dependent.
              "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
                  # sensitive.
              "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
                  # and etc. It is case sensitive.
              "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
                  # insensitive.
            },
          ],
          "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
              # methods in all APIs.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
      "rules": [ # A list of API backend rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A backend rule provides configuration for an individual API element.
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
          "deadline": 3.14, # The number of seconds to wait for a response from a request.  The
              # default depends on the deployment context.
          "address": "A String", # The address of the API backend.
        },
      ],
    },
    "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
        #
        # The example below shows how to configure monitored resources and metrics
        # for monitoring. In the example, a monitored resource and two metrics are
        # defined. The `library.googleapis.com/book/returned_count` metric is sent
        # to both producer and consumer projects, whereas the
        # `library.googleapis.com/book/overdue_count` metric is only sent to the
        # consumer project.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     metrics:
        #     - name: library.googleapis.com/book/returned_count
        #       metric_kind: DELTA
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     - name: library.googleapis.com/book/overdue_count
        #       metric_kind: GAUGE
        #       value_type: INT64
        #       labels:
        #       - key: /customer_id
        #     monitoring:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #       consumer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         metrics:
        #         - library.googleapis.com/book/returned_count
        #         - library.googleapis.com/book/overdue_count
      "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one producer destination.
        { # Configuration of a specific monitoring destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this monitoring destination.
              # Each name must be defined in Service.metrics section.
            "A String",
          ],
        },
      ],
      "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
          # There can be multiple consumer destinations, each one must have a
          # different monitored resource type. A metric can be used in at most
          # one consumer destination.
        { # Configuration of a specific monitoring destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in
              # Service.monitored_resources section.
          "metrics": [ # Names of the metrics to report to this monitoring destination.
              # Each name must be defined in Service.metrics section.
            "A String",
          ],
        },
      ],
    },
    "title": "A String", # The product title associated with this service.
    "id": "A String", # A unique ID for a specific instance of this message, typically assigned
        # by the client for tracking purpose. If empty, the server may choose to
        # generate one instead.
    "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
        #
        # Example for an API targeted for external use:
        #
        #     name: calendar.googleapis.com
        #     authentication:
        #       rules:
        #       - selector: "*"
        #         oauth:
        #           canonical_scopes: https://www.googleapis.com/auth/calendar
        #
        #       - selector: google.calendar.Delegate
        #         oauth:
        #           canonical_scopes: https://www.googleapis.com/auth/calendar.read
      "rules": [ # A list of authentication rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Authentication rules for the service.
            #
            # By default, if a method has any authentication requirements, every request
            # must include a valid credential matching one of the requirements.
            # It's an error to include more than one kind of credential in a single
            # request.
            #
            # If a method doesn't have any auth requirements, request credentials will be
            # ignored.
          "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
              # there are scopes defined for "Read-only access to Google Calendar" and
              # "Access to Cloud Platform". Users can consent to a scope for an application,
              # giving it permission to access that data on their behalf.
              #
              # OAuth scope specifications should be fairly coarse grained; a user will need
              # to see and understand the text description of what your scope means.
              #
              # In most cases: use one or at most two OAuth scopes for an entire family of
              # products. If your product has multiple APIs, you should probably be sharing
              # the OAuth scope across all of those APIs.
              #
              # When you need finer grained OAuth consent screens: talk with your product
              # management about how developers will use them in practice.
              #
              # Please note that even though each of the canonical scopes is enough for a
              # request to be accepted and passed to the backend, a request can still fail
              # due to the backend requiring additional scopes or permissions.
            "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
                # OAuth token containing any of these scopes will be accepted.
                #
                # Example:
                #
                #      canonical_scopes: https://www.googleapis.com/auth/calendar,
                #                        https://www.googleapis.com/auth/calendar.read
          },
          "requirements": [ # Requirements for additional authentication providers.
            { # User-defined authentication requirements, including support for
                # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
              "providerId": "A String", # id from authentication provider.
                  #
                  # Example:
                  #
                  #     provider_id: bookstore_auth
              "audiences": "A String", # The list of JWT
                  # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
                  # that are allowed to access. A JWT containing any of these audiences will
                  # be accepted. When this setting is absent, only JWTs with audience
                  # "https://Service_name/API_name"
                  # will be accepted. For example, if no audiences are in the setting,
                  # LibraryService API will only accept JWTs with the following audience
                  # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
                  #
                  # Example:
                  #
                  #     audiences: bookstore_android.apps.googleusercontent.com,
                  #                bookstore_web.apps.googleusercontent.com
            },
          ],
          "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
              # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
              #
              # For requests without credentials, if the service control environment is
              # specified, each incoming request **must** be associated with a service
              # consumer. This can be done by passing an API key that belongs to a consumer
              # project.
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
      "providers": [ # Defines a set of authentication providers that a service supports.
        { # Configuration for an anthentication provider, including support for
            # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
          "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
              # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
              # Optional if the key set document:
              #  - can be retrieved from
              #    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
              #    of the issuer.
              #  - can be inferred from the email domain of the issuer (e.g. a Google service account).
              #
              # Example: https://www.googleapis.com/oauth2/v1/certs
          "id": "A String", # The unique identifier of the auth provider. It will be referred to by
              # `AuthRequirement.provider_id`.
              #
              # Example: "bookstore_auth".
          "issuer": "A String", # Identifies the principal that issued the JWT. See
              # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
              # Usually a URL or an email address.
              #
              # Example: https://securetoken.google.com
              # Example: 1234567-compute@developer.gserviceaccount.com
        },
      ],
    },
    "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
      "rules": [ # A list of usage rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # Usage configuration rules for the service.
            #
            # NOTE: Under development.
            #
            #
            # Use this rule to configure unregistered calls for the service. Unregistered
            # calls are calls that do not contain consumer project identity.
            # (Example: calls that do not contain an API key).
            # By default, API methods do not allow unregistered calls, and each method call
            # must be identified by a consumer project identity. Use this rule to
            # allow/disallow unregistered calls.
            #
            # Example of an API that wants to allow unregistered calls for entire service.
            #
            #     usage:
            #       rules:
            #       - selector: "*"
            #         allow_unregistered_calls: true
            #
            # Example of a method that wants to allow unregistered calls.
            #
            #     usage:
            #       rules:
            #       - selector: "google.example.library.v1.LibraryService.CreateBook"
            #         allow_unregistered_calls: true
          "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
              # methods in all APIs.
              #
              # Refer to selector for syntax details.
          "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
        },
      ],
      "requirements": [ # Requirements that must be satisfied before a consumer project can use the
          # service. Each requirement is of the form /;
          # for example 'serviceusage.googleapis.com/billing-enabled'.
        "A String",
      ],
    },
    "configVersion": 42, # The version of the service configuration. The config version may
        # influence interpretation of the configuration, for example, to
        # determine defaults. This is documented together with applicable
        # options. The current default for the config version itself is `3`.
    "producerProjectId": "A String", # The id of the Google developer project that owns the service.
        # Members of this project can manage the service configuration,
        # manage consumption of the service, etc.
    "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
        # HttpRule, each specifying the mapping of an RPC method
        # to one or more HTTP REST API methods.
      "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
            # REST APIs.  The mapping determines what portions of the request
            # message are populated from the path, query parameters, or body of
            # the HTTP request.  The mapping is typically specified as an
            # `google.api.http` annotation, see "google/api/annotations.proto"
            # for details.
            #
            # The mapping consists of a field specifying the path template and
            # method kind.  The path template can refer to fields in the request
            # message, as in the example below which describes a REST GET
            # operation on a resource collection of messages:
            #
            # ```proto
            # service Messaging {
            #   rpc GetMessage(GetMessageRequest) returns (Message) {
            #     option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
            #   }
            # }
            # message GetMessageRequest {
            #   message SubMessage {
            #     string subfield = 1;
            #   }
            #   string message_id = 1; // mapped to the URL
            #   SubMessage sub = 2;    // `sub.subfield` is url-mapped
            # }
            # message Message {
            #   string text = 1; // content of the resource
            # }
            # ```
            #
            # This definition enables an automatic, bidrectional mapping of HTTP
            # JSON to RPC. Example:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
            #
            # In general, not only fields but also field paths can be referenced
            # from a path pattern. Fields mapped to the path pattern cannot be
            # repeated and must have a primitive (non-message) type.
            #
            # Any fields in the request message which are not bound by the path
            # pattern automatically become (optional) HTTP query
            # parameters. Assume the following definition of the request message:
            #
            # ```proto
            # message GetMessageRequest {
            #   message SubMessage {
            #     string subfield = 1;
            #   }
            #   string message_id = 1; // mapped to the URL
            #   int64 revision = 2;    // becomes a parameter
            #   SubMessage sub = 3;    // `sub.subfield` becomes a parameter
            # }
            # ```
            #
            # This enables a HTTP JSON to RPC mapping as below:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
            #
            # Note that fields which are mapped to HTTP parameters must have a
            # primitive type or a repeated primitive type. Message types are not
            # allowed. In the case of a repeated type, the parameter can be
            # repeated in the URL, as in `...?param=A¶m=B`.
            #
            # For HTTP method kinds which allow a request body, the `body` field
            # specifies the mapping. Consider a REST update method on the
            # message resource collection:
            #
            # ```proto
            # service Messaging {
            #   rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
            #     option (google.api.http) = {
            #       put: "/v1/messages/{message_id}"
            #       body: "message"
            #     };
            #   }
            # }
            # message UpdateMessageRequest {
            #   string message_id = 1; // mapped to the URL
            #   Message message = 2;   // mapped to the body
            # }
            # ```
            #
            # The following HTTP JSON to RPC mapping is enabled, where the
            # representation of the JSON in the request body is determined by
            # protos JSON encoding:
            #
            # HTTP | RPC
            # -----|-----
            # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
            #
            # The special name `*` can be used in the body mapping to define that
            # every field not bound by the path template should be mapped to the
            # request body.  This enables the following alternative definition of
            # the update method:
            #
            # ```proto
            # service Messaging {
            #   rpc UpdateMessage(Message) returns (Message) {
            #     option (google.api.http) = {
            #       put: "/v1/messages/{message_id}"
            #       body: "*"
            #     };
            #   }
            # }
            # message Message {
            #   string message_id = 1;
            #   string text = 2;
            # }
            # ```
            #
            # The following HTTP JSON to RPC mapping is enabled:
            #
            # HTTP | RPC
            # -----|-----
            # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
            #
            # Note that when using `*` in the body mapping, it is not possible to
            # have HTTP parameters, as all fields not bound by the path end in
            # the body. This makes this option more rarely used in practice of
            # defining REST APIs. The common usage of `*` is in custom methods
            # which don't use the URL at all for transferring data.
            #
            # It is possible to define multiple HTTP methods for one RPC by using
            # the `additional_bindings` option. Example:
            #
            # ```proto
            # service Messaging {
            #   rpc GetMessage(GetMessageRequest) returns (Message) {
            #     option (google.api.http) = {
            #       get: "/v1/messages/{message_id}"
            #       additional_bindings {
            #         get: "/v1/users/{user_id}/messages/{message_id}"
            #       }
            #     };
            #   }
            # }
            # message GetMessageRequest {
            #   string message_id = 1;
            #   string user_id = 2;
            # }
            # ```
            #
            # This enables the following two alternative HTTP JSON to RPC
            # mappings:
            #
            # HTTP | RPC
            # -----|-----
            # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
            # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
            #
            # # Rules for HTTP mapping
            #
            # The rules for mapping HTTP path, query parameters, and body fields
            # to the request message are as follows:
            #
            # 1. The `body` field specifies either `*` or a field path, or is
            #    omitted. If omitted, it assumes there is no HTTP body.
            # 2. Leaf fields (recursive expansion of nested messages in the
            #    request) can be classified into three types:
            #     (a) Matched in the URL template.
            #     (b) Covered by body (if body is `*`, everything except (a) fields;
            #         else everything under the body field)
            #     (c) All other fields.
            # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
            # 4. Any body sent with an HTTP request can contain only (b) fields.
            #
            # The syntax of the path template is as follows:
            #
            #     Template = "/" Segments [ Verb ] ;
            #     Segments = Segment { "/" Segment } ;
            #     Segment  = "*" | "**" | LITERAL | Variable ;
            #     Variable = "{" FieldPath [ "=" Segments ] "}" ;
            #     FieldPath = IDENT { "." IDENT } ;
            #     Verb     = ":" LITERAL ;
            #
            # The syntax `*` matches a single path segment. It follows the semantics of
            # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
            # Expansion.
            #
            # The syntax `**` matches zero or more path segments. It follows the semantics
            # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
            # Expansion.
            #
            # The syntax `LITERAL` matches literal text in the URL path.
            #
            # The syntax `Variable` matches the entire path as specified by its template;
            # this nested template must not contain further variables. If a variable
            # matches a single path segment, its template may be omitted, e.g. `{var}`
            # is equivalent to `{var=*}`.
            #
            # NOTE: the field paths in variables and in the `body` must not refer to
            # repeated fields or map fields.
            #
            # Use CustomHttpPattern to specify any HTTP method that is not included in the
            # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
            # a given URL path rule. The wild-card rule is useful for services that provide
            # content to Web (HTML) clients.
          "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
              # `*` for mapping all fields not captured by the path pattern to the HTTP
              # body. NOTE: the referred field must not be a repeated field and must be
              # present at the top-level of response message type.
          "get": "A String", # Used for listing and getting information about resources.
          "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
            "enabled": True or False, # Whether download is enabled.
          },
          "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
              # not contain an `additional_bindings` field themselves (that is,
              # the nesting may only be one level deep).
            # Object with schema name: HttpRule
          ],
          "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
              # [][google.bytestream.RestByteStream] as an API to your
              # configuration.
            "enabled": True or False, # Whether upload is enabled.
          },
          "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
            "path": "A String", # The path matched by this custom verb.
            "kind": "A String", # The name of this custom HTTP verb.
          },
          "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
              # response. Other response fields are ignored. This field is optional. When
              # not set, the response message will be used as HTTP body of response.
              # NOTE: the referred field must be not a repeated field and must be present
              # at the top-level of response message type.
          "put": "A String", # Used for updating a resource.
          "patch": "A String", # Used for updating a resource.
          "post": "A String", # Used for creating a resource.
          "selector": "A String", # Selects methods to which this rule applies.
              #
              # Refer to selector for syntax details.
          "delete": "A String", # Used for deleting a resource.
        },
      ],
    },
    "apis": [ # A list of API interfaces exported by this service. Only the `name` field
        # of the google.protobuf.Api needs to be provided by the configuration
        # author, as the remaining fields will be derived from the IDL during the
        # normalization process. It is an error to specify an API interface here
        # which cannot be resolved against the associated IDL files.
      { # Api is a light-weight descriptor for a protocol buffer service.
        "methods": [ # The methods of this api, in unspecified order.
          { # Method represents a method of an api.
            "name": "A String", # The simple name of this method.
            "requestStreaming": True or False, # If true, the request is streamed.
            "responseTypeUrl": "A String", # The URL of the output message type.
            "requestTypeUrl": "A String", # A URL of the input message type.
            "responseStreaming": True or False, # If true, the response is streamed.
            "syntax": "A String", # The source syntax of this method.
            "options": [ # Any metadata attached to the method.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
          },
        ],
        "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
            # message.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "mixins": [ # Included APIs. See Mixin.
          { # Declares an API to be included in this API. The including API must
              # redeclare all the methods from the included API, but documentation
              # and options are inherited as follows:
              #
              # - If after comment and whitespace stripping, the documentation
              #   string of the redeclared method is empty, it will be inherited
              #   from the original method.
              #
              # - Each annotation belonging to the service config (http,
              #   visibility) which is not set in the redeclared method will be
              #   inherited.
              #
              # - If an http annotation is inherited, the path pattern will be
              #   modified as follows. Any version prefix will be replaced by the
              #   version of the including API plus the root path if specified.
              #
              # Example of a simple mixin:
              #
              #     package google.acl.v1;
              #     service AccessControl {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
              #       }
              #     }
              #
              #     package google.storage.v2;
              #     service Storage {
              #       //       rpc GetAcl(GetAclRequest) returns (Acl);
              #
              #       // Get a data record.
              #       rpc GetData(GetDataRequest) returns (Data) {
              #         option (google.api.http).get = "/v2/{resource=**}";
              #       }
              #     }
              #
              # Example of a mixin configuration:
              #
              #     apis:
              #     - name: google.storage.v2.Storage
              #       mixins:
              #       - name: google.acl.v1.AccessControl
              #
              # The mixin construct implies that all methods in `AccessControl` are
              # also declared with same name and request/response types in
              # `Storage`. A documentation generator or annotation processor will
              # see the effective `Storage.GetAcl` method after inherting
              # documentation and annotations as follows:
              #
              #     service Storage {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
              #       }
              #       ...
              #     }
              #
              # Note how the version in the path pattern changed from `v1` to `v2`.
              #
              # If the `root` field in the mixin is specified, it should be a
              # relative path under which inherited HTTP paths are placed. Example:
              #
              #     apis:
              #     - name: google.storage.v2.Storage
              #       mixins:
              #       - name: google.acl.v1.AccessControl
              #         root: acls
              #
              # This implies the following inherited HTTP annotation:
              #
              #     service Storage {
              #       // Get the underlying ACL object.
              #       rpc GetAcl(GetAclRequest) returns (Acl) {
              #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
              #       }
              #       ...
              #     }
            "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
                # are rooted.
            "name": "A String", # The fully qualified name of the API which is included.
          },
        ],
        "syntax": "A String", # The source syntax of the service.
        "version": "A String", # A version string for this api. If specified, must have the form
            # `major-version.minor-version`, as in `1.10`. If the minor version
            # is omitted, it defaults to zero. If the entire version field is
            # empty, the major version is derived from the package name, as
            # outlined below. If the field is not empty, the version in the
            # package name will be verified to be consistent with what is
            # provided here.
            #
            # The versioning schema uses [semantic
            # versioning](http://semver.org) where the major version number
            # indicates a breaking change and the minor version an additive,
            # non-breaking change. Both version numbers are signals to users
            # what to expect from different versions, and should be carefully
            # chosen based on the product plan.
            #
            # The major version is also reflected in the package name of the
            # API, which must end in `v`, as in
            # `google.feature.v1`. For major versions 0 and 1, the suffix can
            # be omitted. Zero major versions must only be used for
            # experimental, none-GA apis.
        "options": [ # Any metadata attached to the API.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "name": "A String", # The fully qualified name of this api, including package name
            # followed by the api's simple name.
      },
    ],
    "customError": { # Customize service error responses.  For example, list any service # Custom error configuration.
        # specific protobuf types that can appear in error detail lists of
        # error responses.
        #
        # Example:
        #
        #     custom_error:
        #       types:
        #       - google.foo.v1.CustomError
        #       - google.foo.v1.AnotherError
      "rules": [ # The list of custom error rules that apply to individual API messages.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A custom error rule.
          "isErrorType": True or False, # Mark this message as possible payload in error response.  Otherwise,
              # objects of this type will be filtered when they appear in error payload.
          "selector": "A String", # Selects messages to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
      "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
        "A String",
      ],
    },
    "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
        # elements.  Restrictions are specified using visibility labels
        # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
        #
        # Users and projects can have access to more than one visibility label. The
        # effective visibility for multiple labels is the union of each label's
        # elements, plus any unrestricted elements.
        #
        # If an element and its parents have no restrictions, visibility is
        # unconditionally granted.
        #
        # Example:
        #
        #     visibility:
        #       rules:
        #       - selector: google.calendar.Calendar.EnhancedSearch
        #         restriction: TRUSTED_TESTER
        #       - selector: google.calendar.Calendar.Delegate
        #         restriction: GOOGLE_INTERNAL
        #
        # Here, all methods are publicly visible except for the restricted methods
        # EnhancedSearch and Delegate.
      "rules": [ # A list of visibility rules that apply to individual API elements.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A visibility rule provides visibility configuration for an individual API
            # element.
          "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
              # Any of the listed labels can be used to grant the visibility.
              #
              # If a rule has multiple labels, removing one of the labels but not all of
              # them can break clients.
              #
              # Example:
              #
              #     visibility:
              #       rules:
              #       - selector: google.calendar.Calendar.EnhancedSearch
              #         restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
              #
              # Removing GOOGLE_INTERNAL from this restriction will break clients that
              # rely on this method and only had access to it through GOOGLE_INTERNAL.
          "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "metrics": [ # Defines the metrics used by this service.
      { # Defines a metric type and its schema.
        "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
            # Use sentence case without an ending period, for example "Request count".
        "description": "A String", # A detailed description of the metric, which can be used in documentation.
        "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
            # Some combinations of `metric_kind` and `value_type` might not be supported.
        "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
            # Some combinations of `metric_kind` and `value_type` might not be supported.
        "labels": [ # The set of labels that can be used to describe a specific instance of this
            # metric type. For example, the
            # `compute.googleapis.com/instance/network/received_bytes_count` metric type
            # has a label, `loadbalanced`, that specifies whether the traffic was
            # received through a load balanced IP address.
          { # A description of a label.
            "valueType": "A String", # The type of data that can be assigned to the label.
            "description": "A String", # A human-readable description for the label.
            "key": "A String", # The label key.
          },
        ],
        "type": "A String", # The metric type including a DNS name prefix, for example
            # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
            # should use a natural hierarchical grouping such as the following:
            #
            #     compute.googleapis.com/instance/cpu/utilization
            #     compute.googleapis.com/instance/disk/read_ops_count
            #     compute.googleapis.com/instance/network/received_bytes_count
            #
            # Note that if the metric type changes, the monitoring data will be
            # discontinued, and anything depends on it will break, such as monitoring
            # dashboards, alerting rules and quota limits. Therefore, once a metric has
            # been published, its type should be immutable.
        "unit": "A String", # The unit in which the metric value is reported. It is only applicable
            # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
            # supported units are a subset of [The Unified Code for Units of
            # Measure](http://unitsofmeasure.org/ucum.html) standard:
            #
            # **Basic units (UNIT)**
            #
            # * `bit`   bit
            # * `By`    byte
            # * `s`     second
            # * `min`   minute
            # * `h`     hour
            # * `d`     day
            #
            # **Prefixes (PREFIX)**
            #
            # * `k`     kilo    (10**3)
            # * `M`     mega    (10**6)
            # * `G`     giga    (10**9)
            # * `T`     tera    (10**12)
            # * `P`     peta    (10**15)
            # * `E`     exa     (10**18)
            # * `Z`     zetta   (10**21)
            # * `Y`     yotta   (10**24)
            # * `m`     milli   (10**-3)
            # * `u`     micro   (10**-6)
            # * `n`     nano    (10**-9)
            # * `p`     pico    (10**-12)
            # * `f`     femto   (10**-15)
            # * `a`     atto    (10**-18)
            # * `z`     zepto   (10**-21)
            # * `y`     yocto   (10**-24)
            # * `Ki`    kibi    (2**10)
            # * `Mi`    mebi    (2**20)
            # * `Gi`    gibi    (2**30)
            # * `Ti`    tebi    (2**40)
            #
            # **Grammar**
            #
            # The grammar includes the dimensionless unit `1`, such as `1/s`.
            #
            # The grammar also includes these connectors:
            #
            # * `/`    division (as an infix operator, e.g. `1/s`).
            # * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
            #
            # The grammar for a unit is as follows:
            #
            #     Expression = Component { "." Component } { "/" Component } ;
            #
            #     Component = [ PREFIX ] UNIT [ Annotation ]
            #               | Annotation
            #               | "1"
            #               ;
            #
            #     Annotation = "{" NAME "}" ;
            #
            # Notes:
            #
            # * `Annotation` is just a comment if it follows a `UNIT` and is
            #    equivalent to `1` if it is used alone. For examples,
            #    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
            # * `NAME` is a sequence of non-blank printable ASCII characters not
            #    containing '{' or '}'.
        "name": "A String", # Resource name. The format of the name may vary between different
            # implementations. For examples:
            #
            #     projects/{project_id}/metricDescriptors/{type=**}
            #     metricDescriptors/{type=**}
      },
    ],
    "enums": [ # A list of all enum types included in this API service.  Enums
        # referenced directly or indirectly by the `apis` are automatically
        # included.  Enums which are not referenced but shall be included
        # should be listed here by name. Example:
        #
        #     enums:
        #     - name: google.someapi.v1.SomeEnum
      { # Enum type definition.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "enumvalue": [ # Enum value definitions.
          { # Enum value definition.
            "number": 42, # Enum value number.
            "options": [ # Protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "name": "A String", # Enum value name.
          },
        ],
        "options": [ # Protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "name": "A String", # Enum type name.
        "syntax": "A String", # The source syntax.
      },
    ],
    "types": [ # A list of all proto message types included in this API service.
        # Types referenced directly or indirectly by the `apis` are
        # automatically included.  Messages which are not referenced but
        # shall be included, such as types used by the `google.protobuf.Any` type,
        # should be listed here by name. Example:
        #
        #     types:
        #     - name: google.protobuf.Int32
      { # A protocol buffer message type.
        "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
          "A String",
        ],
        "name": "A String", # The fully qualified message name.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "syntax": "A String", # The source syntax.
        "fields": [ # The list of fields.
          { # A single field of a message type.
            "kind": "A String", # The field type.
            "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                # types. The first type has index 1; zero means the type is not in the list.
            "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
            "name": "A String", # The field name.
            "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
            "jsonName": "A String", # The field JSON name.
            "number": 42, # The field number.
            "cardinality": "A String", # The field cardinality.
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "packed": True or False, # Whether to use alternative packed wire representation.
          },
        ],
        "options": [ # The protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
      },
    ],
    "logging": { # Logging configuration of the service. # Logging configuration.
        #
        # The following example shows how to configure logs to be sent to the
        # producer and consumer projects. In the example, the `activity_history`
        # log is sent to both the producer and consumer projects, whereas the
        # `purchase_history` log is only sent to the producer project.
        #
        #     monitored_resources:
        #     - type: library.googleapis.com/branch
        #       labels:
        #       - key: /city
        #         description: The city where the library branch is located in.
        #       - key: /name
        #         description: The name of the branch.
        #     logs:
        #     - name: activity_history
        #       labels:
        #       - key: /customer_id
        #     - name: purchase_history
        #     logging:
        #       producer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         logs:
        #         - activity_history
        #         - purchase_history
        #       consumer_destinations:
        #       - monitored_resource: library.googleapis.com/branch
        #         logs:
        #         - activity_history
      "producerDestinations": [ # Logging configurations for sending logs to the producer project.
          # There can be multiple producer destinations, each one must have a
          # different monitored resource type. A log can be used in at most
          # one producer destination.
        { # Configuration of a specific logging destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
              # Service.monitored_resources section.
          "logs": [ # Names of the logs to be sent to this destination. Each name must
              # be defined in the Service.logs section. If the log name is
              # not a domain scoped name, it will be automatically prefixed with
              # the service name followed by "/".
            "A String",
          ],
        },
      ],
      "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
          # There can be multiple consumer destinations, each one must have a
          # different monitored resource type. A log can be used in at most
          # one consumer destination.
        { # Configuration of a specific logging destination (the producer project
            # or the consumer project).
          "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
              # Service.monitored_resources section.
          "logs": [ # Names of the logs to be sent to this destination. Each name must
              # be defined in the Service.logs section. If the log name is
              # not a domain scoped name, it will be automatically prefixed with
              # the service name followed by "/".
            "A String",
          ],
        },
      ],
    },
    "name": "A String", # The DNS address at which this service is available,
        # e.g. `calendar.googleapis.com`.
    "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
        #
        # Example:
        # 
documentation:
        #   summary: >
        #     The Google Calendar API gives access
        #     to most calendar features.
        #   pages:
        #   - name: Overview
        #     content: (== include google/foo/overview.md ==)
        #   - name: Tutorial
        #     content: (== include google/foo/tutorial.md ==)
        #     subpages;
        #     - name: Java
        #       content: (== include google/foo/tutorial_java.md ==)
        #   rules:
        #   - selector: google.calendar.Calendar.Get
        #     description: >
        #       ...
        #   - selector: google.calendar.Calendar.Put
        #     description: >
        #       ...
        # 

        # Documentation is provided in markdown syntax. In addition to
        # standard markdown features, definition lists, tables and fenced
        # code blocks are supported. Section headers can be provided and are
        # interpreted relative to the section nesting of the context where
        # a documentation fragment is embedded.
        #
        # Documentation from the IDL is merged with documentation defined
        # via the config at normalization time, where documentation provided
        # by config rules overrides IDL provided.
        #
        # A number of constructs specific to the API platform are supported
        # in documentation text.
        #
        # In order to reference a proto element, the following
        # notation can be used:
        # 
[fully.qualified.proto.name][]

        # To override the display text used for the link, this can be used:
        # 
[display text][fully.qualified.proto.name]

        # Text can be excluded from doc using the following notation:
        # 
(-- internal comment --)

        # Comments can be made conditional using a visibility label. The below
        # text will be only rendered if the `BETA` label is available:
        # 
(--BETA: comment for BETA users --)

        # A few directives are available in documentation. Note that
        # directives must appear on a single line to be properly
        # identified. The `include` directive includes a markdown file from
        # an external source:
        # 
(== include path/to/file ==)

        # The `resource_for` directive marks a message to be the resource of
        # a collection in REST view. If it is not specified, tools attempt
        # to infer the resource from the operations in a collection:
        # 
(== resource_for v1.shelves.books ==)

        # The directive `suppress_warning` does not directly affect documentation
        # and is documented together with service config validation.
      "rules": [ # A list of documentation rules that apply to individual API elements.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A documentation rule provides information about individual API elements.
          "description": "A String", # Description of the selected API(s).
          "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
              # element is marked as `deprecated`.
          "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
              # qualified name of the element which may end in "*", indicating a wildcard.
              # Wildcards are only allowed at the end and for a whole component of the
              # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
              # specify a default for all applicable elements, the whole pattern "*"
              # is used.
        },
      ],
      "overview": "A String", # Declares a single overview page. For example:
          # 
documentation:
          #   summary: ...
          #   overview: (== include overview.md ==)
          # 

          # This is a shortcut for the following declaration (using pages style):
          # 
documentation:
          #   summary: ...
          #   pages:
          #   - name: Overview
          #     content: (== include overview.md ==)
          # 

          # Note: you cannot specify both `overview` field and `pages` field.
      "summary": "A String", # A short summary of what the service does. Can only be provided by
          # plain text.
      "pages": [ # The top level pages for the documentation set.
        { # Represents a documentation page. A page can contain subpages to represent
            # nested documentation set structure.
          "content": "A String", # The Markdown content of the page. You can use (== include {path} ==)
              # to include content from a Markdown file.
          "subpages": [ # Subpages of this page. The order of subpages specified here will be
              # honored in the generated docset.
            # Object with schema name: Page
          ],
          "name": "A String", # The name of the page. It will be used as an identity of the page to
              # generate URI of the page, text of the link to this page in navigation,
              # etc. The full page name (start from the root page name to this page
              # concatenated with `.`) can be used as reference to the page in your
              # documentation. For example:
              # 
pages:
              # - name: Tutorial
              #   content: (== include tutorial.md ==)
              #   subpages:
              #   - name: Java
              #     content: (== include tutorial_java.md ==)
              # 

              # You can reference `Java` page using Markdown reference link syntax:
              # `Java`.
        },
      ],
      "documentationRootUrl": "A String", # The URL to the root of documentation.
    },
    "systemTypes": [ # A list of all proto message types included in this API service.
        # It serves similar purpose as [google.api.Service.types], except that
        # these types are not needed by user-defined APIs. Therefore, they will not
        # show up in the generated discovery doc. This field should only be used
        # to define system APIs in ESF.
      { # A protocol buffer message type.
        "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
          "A String",
        ],
        "name": "A String", # The fully qualified message name.
        "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
            # protobuf element, like the file in which it is defined.
          "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
              # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
        },
        "syntax": "A String", # The source syntax.
        "fields": [ # The list of fields.
          { # A single field of a message type.
            "kind": "A String", # The field type.
            "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
                # types. The first type has index 1; zero means the type is not in the list.
            "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
                # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
            "name": "A String", # The field name.
            "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
            "jsonName": "A String", # The field JSON name.
            "number": 42, # The field number.
            "cardinality": "A String", # The field cardinality.
            "options": [ # The protocol buffer options.
              { # A protocol buffer option, which can be attached to a message, field,
                  # enumeration, etc.
                "name": "A String", # The option's name. For example, `"java_package"`.
                "value": { # The option's value. For example, `"com.google.protobuf"`.
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              },
            ],
            "packed": True or False, # Whether to use alternative packed wire representation.
          },
        ],
        "options": [ # The protocol buffer options.
          { # A protocol buffer option, which can be attached to a message, field,
              # enumeration, etc.
            "name": "A String", # The option's name. For example, `"java_package"`.
            "value": { # The option's value. For example, `"com.google.protobuf"`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
      },
    ],
    "context": { # `Context` defines which contexts an API requests. # Context configuration.
        #
        # Example:
        #
        #     context:
        #       rules:
        #       - selector: "*"
        #         requested:
        #         - google.rpc.context.ProjectContext
        #         - google.rpc.context.OriginContext
        #
        # The above specifies that all methods in the API request
        # `google.rpc.context.ProjectContext` and
        # `google.rpc.context.OriginContext`.
        #
        # Available context types are defined in package
        # `google.rpc.context`.
      "rules": [ # A list of RPC context rules that apply to individual API methods.
          #
          # **NOTE:** All service configuration rules follow "last one wins" order.
        { # A context rule provides information about the context for an individual API
            # element.
          "provided": [ # A list of full type names of provided contexts.
            "A String",
          ],
          "requested": [ # A list of full type names of requested contexts.
            "A String",
          ],
          "selector": "A String", # Selects the methods to which this rule applies.
              #
              # Refer to selector for syntax details.
        },
      ],
    },
    "endpoints": [ # Configuration for network endpoints.  If this is empty, then an endpoint
        # with the same name as the service is automatically generated to service all
        # defined APIs.
      { # `Endpoint` describes a network endpoint that serves a set of APIs.
          # A service may expose any number of endpoints, and all endpoints share the
          # same service configuration, such as quota configuration and monitoring
          # configuration.
          #
          # Example service configuration:
          #
          #     name: library-example.googleapis.com
          #     endpoints:
          #       # Below entry makes 'google.example.library.v1.Library'
          #       # API be served from endpoint address library-example.googleapis.com.
          #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
          #       # it to decide whether the subsequent cross-origin request is
          #       # allowed to proceed.
          #     - name: library-example.googleapis.com
          #       apis: google.example.library.v1.Library
          #       allow_cors: true
          #       # Below entry makes 'google.example.library.v1.Library'
          #       # API be served from endpoint address
          #       # google.example.library-example.v1.LibraryManager.
          #     - name: library-manager.googleapis.com
          #       apis: google.example.library.v1.LibraryManager
          #       # BNS address for a borg job. Can specify a task by appending
          #       # "/taskId" (e.g. "/0") to the job spec.
          #
          # Example OpenAPI extension for endpoint with allow_cors set to true:
          #
          #     {
          #       "swagger": "2.0",
          #       "info": {
          #         "description": "A simple..."
          #       },
          #       "host": "MY_PROJECT_ID.appspot.com",
          #       "x-google-endpoints": [{
          #         "name": "MY_PROJECT_ID.appspot.com",
          #         "allow_cors": "true"
          #       }]
          #     }
        "allowCors": True or False, # Allowing
            # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
            # cross-domain traffic, would allow the backends served from this endpoint to
            # receive and respond to HTTP OPTIONS requests. The response will be used by
            # the browser to determine whether the subsequent cross-origin request is
            # allowed to proceed.
        "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
            # please specify multiple google.api.Endpoint for each of the intented
            # alias.
            #
            # Additional names that this endpoint will be hosted on.
          "A String",
        ],
        "features": [ # The list of features enabled on this endpoint.
          "A String",
        ],
        "name": "A String", # The canonical name of this endpoint.
        "apis": [ # The list of APIs served by this endpoint.
          "A String",
        ],
      },
    ],
  }
getIamPolicy(resource=None, body, x__xgafv=None) 
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested.
`resource` is usually specified as a path. For example, a Project
resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to
      # specify access control policies for Cloud Platform resources.
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
      # `members` to a `role`, where the members can be user accounts, Google groups,
      # Google domains, and service accounts. A `role` is a named list of permissions
      # defined by IAM.
      #
      # **Example**
      #
      #     {
      #       "bindings": [
      #         {
      #           "role": "roles/owner",
      #           "members": [
      #             "user:mike@example.com",
      #             "group:admins@example.com",
      #             "domain:google.com",
      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com",
      #           ]
      #         },
      #         {
      #           "role": "roles/viewer",
      #           "members": ["user:sean@example.com"]
      #         }
      #       ]
      #     }
      #
      # For a description of IAM and its features, see the
      # [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access".
        # "data access": generally refers to data reads/writes and admin reads.
        # "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always
        # enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list
          # of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit
            # logging for the `service` specified above.
            # Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit
            # logging.
            # For example, `resourcemanager`, `storage`, `compute`.
            # `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following
        # manner:
        # - All matching LOG rules are always applied.
        # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
        #   Logging will be applied if one or more matching rule requires logging.
        # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
        #   granted.
        #   Logging will be applied if one or more matching rule requires logging.
        # - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
            # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
            # The format for in and not_in entries is the same as for members in a
            # Binding (see google/iam/v1/policy.proto).
          "A String",
        ],
        "description": "A String", # Human-readable description of the rule.
        "in": [ # If one or more 'in' clauses are specified, the rule matches if
            # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
                # the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
            # that match the LOG action.
          { # Specifies what kind of log the caller must write
              # Increment a streamz counter with the specified metric and field names.
              #
              # Metric names should start with a '/', generally be lowercase-only,
              # and end in "_count". Field names should not contain an initial slash.
              # The actual exported metric names will have "/iam/policy" prepended.
              #
              # Field names correspond to IAM request parameters and field values are
              # their respective values.
              #
              # At present the only supported field names are
              #    - "iam_principal", corresponding to IAMContext.principal;
              #    - "" (empty string), resulting in one aggretated counter with no field.
              #
              # Examples:
              #   counter { metric: "/debug_access_count"  field: "iam_principal" }
              #   ==> increment counter /iam/policy/backend_debug_access_count
              #                         {iam_principal=[value of IAMContext.principal]}
              #
              # At this time we do not support:
              # * multiple field names (though this may be supported in the future)
              # * decrementing the counter
              # * incrementing it by anything other than 1
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
            "dataAccess": { # Write a Data Access (Gin) log # Data access options.
            },
            "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
            },
          },
        ],
        "permissions": [ # A permission is a string of form '..'
            # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
            # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
        # prevent simultaneous updates of a policy from overwriting each other.
        # It is strongly suggested that systems make use of the `etag` in the
        # read-modify-write cycle to perform policy updates in order to avoid race
        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
        # systems are expected to put that etag in the request to `setIamPolicy` to
        # ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing
        # policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`.
        # Multiple `bindings` must not be specified for the same `role`.
        # `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`.
            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
            # Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
            # `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is
            #    on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone
            #    who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google
            #    account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service
            #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group.
            #    For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the
            #    users of that domain. For example, `google.com` or `example.com`.
            #
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
list(producerProjectId=None, pageSize=None, pageToken=None, x__xgafv=None) 
Lists all managed services.

Args:
  producerProjectId: string, Include services produced by the specified project.
  pageSize: integer, Requested size of the next page of data.
  pageToken: string, Token identifying which result to start with; returned by a previous list
call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `ListServices` method.
    "nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.
    "services": [ # The results of the query.
      { # The full representation of a Service that is managed by
          # Google Service Management.
        "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
            # for naming requirements.
        "producerProjectId": "A String", # ID of the project that produces and owns this service.
      },
    ],
  }
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.
setIamPolicy(resource=None, body, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any
existing policy.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified.
`resource` is usually specified as a path. For example, a Project
resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
        # the policy is limited to a few 10s of KB. An empty policy is a
        # valid policy but certain Cloud Platform services (such as Projects)
        # might reject them.
        # specify access control policies for Cloud Platform resources.
        #
        #
        # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
        # `members` to a `role`, where the members can be user accounts, Google groups,
        # Google domains, and service accounts. A `role` is a named list of permissions
        # defined by IAM.
        #
        # **Example**
        #
        #     {
        #       "bindings": [
        #         {
        #           "role": "roles/owner",
        #           "members": [
        #             "user:mike@example.com",
        #             "group:admins@example.com",
        #             "domain:google.com",
        #             "serviceAccount:my-other-app@appspot.gserviceaccount.com",
        #           ]
        #         },
        #         {
        #           "role": "roles/viewer",
        #           "members": ["user:sean@example.com"]
        #         }
        #       ]
        #     }
        #
        # For a description of IAM and its features, see the
        # [IAM developer's guide](https://cloud.google.com/iam).
      "auditConfigs": [ # Specifies audit logging configs for "data access".
          # "data access": generally refers to data reads/writes and admin reads.
          # "admin activity": generally refers to admin writes.
          #
          # Note: `AuditConfig` doesn't apply to "admin activity", which always
          # enables audit logging.
        { # Enables "data access" audit logging for a service and specifies a list
            # of members that are log-exempted.
          "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit
              # logging for the `service` specified above.
              # Follows the same format of Binding.members.
            "A String",
          ],
          "service": "A String", # Specifies a service that will be enabled for "data access" audit
              # logging.
              # For example, `resourcemanager`, `storage`, `compute`.
              # `allServices` is a special value that covers all services.
        },
      ],
      "rules": [ # If more than one rule is specified, the rules are applied in the following
          # manner:
          # - All matching LOG rules are always applied.
          # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
          #   Logging will be applied if one or more matching rule requires logging.
          # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
          #   granted.
          #   Logging will be applied if one or more matching rule requires logging.
          # - Otherwise, if no rule applies, permission is denied.
        { # A rule to be applied in a Policy.
          "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
              # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
              # The format for in and not_in entries is the same as for members in a
              # Binding (see google/iam/v1/policy.proto).
            "A String",
          ],
          "description": "A String", # Human-readable description of the rule.
          "in": [ # If one or more 'in' clauses are specified, the rule matches if
              # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
            "A String",
          ],
          "action": "A String", # Required
          "conditions": [ # Additional restrictions that must be met
            { # A condition to be met.
              "iam": "A String", # Trusted attributes supplied by the IAM system.
              "svc": "A String", # Trusted attributes discharged by the service.
              "value": "A String", # DEPRECATED. Use 'values' instead.
              "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
                  # the IAM system for access control.
              "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
                "A String",
              ],
              "op": "A String", # An operator to apply the subject with.
            },
          ],
          "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
              # that match the LOG action.
            { # Specifies what kind of log the caller must write
                # Increment a streamz counter with the specified metric and field names.
                #
                # Metric names should start with a '/', generally be lowercase-only,
                # and end in "_count". Field names should not contain an initial slash.
                # The actual exported metric names will have "/iam/policy" prepended.
                #
                # Field names correspond to IAM request parameters and field values are
                # their respective values.
                #
                # At present the only supported field names are
                #    - "iam_principal", corresponding to IAMContext.principal;
                #    - "" (empty string), resulting in one aggretated counter with no field.
                #
                # Examples:
                #   counter { metric: "/debug_access_count"  field: "iam_principal" }
                #   ==> increment counter /iam/policy/backend_debug_access_count
                #                         {iam_principal=[value of IAMContext.principal]}
                #
                # At this time we do not support:
                # * multiple field names (though this may be supported in the future)
                # * decrementing the counter
                # * incrementing it by anything other than 1
              "counter": { # Options for counters # Counter options.
                "field": "A String", # The field value to attribute.
                "metric": "A String", # The metric to update.
              },
              "dataAccess": { # Write a Data Access (Gin) log # Data access options.
              },
              "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
              },
            },
          ],
          "permissions": [ # A permission is a string of form '..'
              # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
              # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
            "A String",
          ],
        },
      ],
      "version": 42, # Version of the `Policy`. The default version is 0.
      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
          # prevent simultaneous updates of a policy from overwriting each other.
          # It is strongly suggested that systems make use of the `etag` in the
          # read-modify-write cycle to perform policy updates in order to avoid race
          # conditions: An `etag` is returned in the response to `getIamPolicy`, and
          # systems are expected to put that etag in the request to `setIamPolicy` to
          # ensure that their change will be applied to the same version of the policy.
          #
          # If no `etag` is provided in the call to `setIamPolicy`, then the existing
          # policy is overwritten blindly.
      "bindings": [ # Associates a list of `members` to a `role`.
          # Multiple `bindings` must not be specified for the same `role`.
          # `bindings` with no members will result in an error.
        { # Associates `members` with a `role`.
          "role": "A String", # Role that is assigned to `members`.
              # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
              # Required
          "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
              # `members` can have the following values:
              #
              # * `allUsers`: A special identifier that represents anyone who is
              #    on the internet; with or without a Google account.
              #
              # * `allAuthenticatedUsers`: A special identifier that represents anyone
              #    who is authenticated with a Google account or a service account.
              #
              # * `user:{emailid}`: An email address that represents a specific Google
              #    account. For example, `alice@gmail.com` or `joe@example.com`.
              #
              #
              # * `serviceAccount:{emailid}`: An email address that represents a service
              #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
              #
              # * `group:{emailid}`: An email address that represents a Google group.
              #    For example, `admins@example.com`.
              #
              # * `domain:{domain}`: A Google Apps domain name that represents all the
              #    users of that domain. For example, `google.com` or `example.com`.
              #
            "A String",
          ],
        },
      ],
      "iamOwned": True or False,
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines an Identity and Access Management (IAM) policy. It is used to
      # specify access control policies for Cloud Platform resources.
      #
      #
      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
      # `members` to a `role`, where the members can be user accounts, Google groups,
      # Google domains, and service accounts. A `role` is a named list of permissions
      # defined by IAM.
      #
      # **Example**
      #
      #     {
      #       "bindings": [
      #         {
      #           "role": "roles/owner",
      #           "members": [
      #             "user:mike@example.com",
      #             "group:admins@example.com",
      #             "domain:google.com",
      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com",
      #           ]
      #         },
      #         {
      #           "role": "roles/viewer",
      #           "members": ["user:sean@example.com"]
      #         }
      #       ]
      #     }
      #
      # For a description of IAM and its features, see the
      # [IAM developer's guide](https://cloud.google.com/iam).
    "auditConfigs": [ # Specifies audit logging configs for "data access".
        # "data access": generally refers to data reads/writes and admin reads.
        # "admin activity": generally refers to admin writes.
        #
        # Note: `AuditConfig` doesn't apply to "admin activity", which always
        # enables audit logging.
      { # Enables "data access" audit logging for a service and specifies a list
          # of members that are log-exempted.
        "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit
            # logging for the `service` specified above.
            # Follows the same format of Binding.members.
          "A String",
        ],
        "service": "A String", # Specifies a service that will be enabled for "data access" audit
            # logging.
            # For example, `resourcemanager`, `storage`, `compute`.
            # `allServices` is a special value that covers all services.
      },
    ],
    "rules": [ # If more than one rule is specified, the rules are applied in the following
        # manner:
        # - All matching LOG rules are always applied.
        # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
        #   Logging will be applied if one or more matching rule requires logging.
        # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
        #   granted.
        #   Logging will be applied if one or more matching rule requires logging.
        # - Otherwise, if no rule applies, permission is denied.
      { # A rule to be applied in a Policy.
        "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
            # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
            # The format for in and not_in entries is the same as for members in a
            # Binding (see google/iam/v1/policy.proto).
          "A String",
        ],
        "description": "A String", # Human-readable description of the rule.
        "in": [ # If one or more 'in' clauses are specified, the rule matches if
            # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
          "A String",
        ],
        "action": "A String", # Required
        "conditions": [ # Additional restrictions that must be met
          { # A condition to be met.
            "iam": "A String", # Trusted attributes supplied by the IAM system.
            "svc": "A String", # Trusted attributes discharged by the service.
            "value": "A String", # DEPRECATED. Use 'values' instead.
            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
                # the IAM system for access control.
            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
              "A String",
            ],
            "op": "A String", # An operator to apply the subject with.
          },
        ],
        "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
            # that match the LOG action.
          { # Specifies what kind of log the caller must write
              # Increment a streamz counter with the specified metric and field names.
              #
              # Metric names should start with a '/', generally be lowercase-only,
              # and end in "_count". Field names should not contain an initial slash.
              # The actual exported metric names will have "/iam/policy" prepended.
              #
              # Field names correspond to IAM request parameters and field values are
              # their respective values.
              #
              # At present the only supported field names are
              #    - "iam_principal", corresponding to IAMContext.principal;
              #    - "" (empty string), resulting in one aggretated counter with no field.
              #
              # Examples:
              #   counter { metric: "/debug_access_count"  field: "iam_principal" }
              #   ==> increment counter /iam/policy/backend_debug_access_count
              #                         {iam_principal=[value of IAMContext.principal]}
              #
              # At this time we do not support:
              # * multiple field names (though this may be supported in the future)
              # * decrementing the counter
              # * incrementing it by anything other than 1
            "counter": { # Options for counters # Counter options.
              "field": "A String", # The field value to attribute.
              "metric": "A String", # The metric to update.
            },
            "dataAccess": { # Write a Data Access (Gin) log # Data access options.
            },
            "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
            },
          },
        ],
        "permissions": [ # A permission is a string of form '..'
            # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
            # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
          "A String",
        ],
      },
    ],
    "version": 42, # Version of the `Policy`. The default version is 0.
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
        # prevent simultaneous updates of a policy from overwriting each other.
        # It is strongly suggested that systems make use of the `etag` in the
        # read-modify-write cycle to perform policy updates in order to avoid race
        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
        # systems are expected to put that etag in the request to `setIamPolicy` to
        # ensure that their change will be applied to the same version of the policy.
        #
        # If no `etag` is provided in the call to `setIamPolicy`, then the existing
        # policy is overwritten blindly.
    "bindings": [ # Associates a list of `members` to a `role`.
        # Multiple `bindings` must not be specified for the same `role`.
        # `bindings` with no members will result in an error.
      { # Associates `members` with a `role`.
        "role": "A String", # Role that is assigned to `members`.
            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
            # Required
        "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
            # `members` can have the following values:
            #
            # * `allUsers`: A special identifier that represents anyone who is
            #    on the internet; with or without a Google account.
            #
            # * `allAuthenticatedUsers`: A special identifier that represents anyone
            #    who is authenticated with a Google account or a service account.
            #
            # * `user:{emailid}`: An email address that represents a specific Google
            #    account. For example, `alice@gmail.com` or `joe@example.com`.
            #
            #
            # * `serviceAccount:{emailid}`: An email address that represents a service
            #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
            #
            # * `group:{emailid}`: An email address that represents a Google group.
            #    For example, `admins@example.com`.
            #
            # * `domain:{domain}`: A Google Apps domain name that represents all the
            #    users of that domain. For example, `google.com` or `example.com`.
            #
          "A String",
        ],
      },
    ],
    "iamOwned": True or False,
  }
testIamPermissions(resource=None, body, x__xgafv=None) 
Returns permissions that a caller has on the specified resource.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested.
`resource` is usually specified as a path. For example, a Project
resource is specified as `projects/{project}`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with
        # wildcards (such as '*' or 'storage.*') are not allowed. For more
        # information see
        # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
        # allowed.
      "A String",
    ],
  }
undelete(serviceName=None, x__xgafv=None) 
Revives a previously deleted managed service. The method restores the
service using the configuration at the time the service was deleted.
The target service must exist and must have been deleted within the
last 30 days.

Operation

Args:
  serviceName: string, The name of the service. See the [overview](/service-management/overview)
for naming requirements. For example: `example.googleapis.com`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/servicemanagement_v1.services.rollouts.html000066400000000000000000000455631300622755700306030ustar00rootroot00000000000000

Google Service Management API . services . rollouts

Instance Methods

create(serviceName=None, body, x__xgafv=None)

Creates a new service configuration rollout. Based on rollout, the

get(serviceName=None, rolloutId, x__xgafv=None)

Gets a service configuration rollout.

list(serviceName=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the history of the service configuration rollouts for a managed

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(serviceName=None, body, x__xgafv=None) 
Creates a new service configuration rollout. Based on rollout, the
Google Service Management will roll out the service configurations to
different backend services. For example, the logging configuration will be
pushed to Google Cloud Logging.

Please note that any previous pending and running Rollouts and associated
Operations will be automatically cancelled so that the latest Rollout will
not be blocked by previous Rollouts.

Operation

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A rollout resource that defines how service configuration versions are pushed
      # to control plane systems. Typically, you create a new version of the
      # service config, and then create a Rollout to push the service config.
    "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
        # the system will automatically rollback to the current Rollout
        # version. Readonly.
    "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
        #  and '-' are allowed.
        # 
        # If not specified by client, the server will generate one. The generated id
        # will have the form of , where "date" is the create
        # date in ISO 8601 format.  "revision number" is a monotonically increasing
        # positive number that is reset every day for each service.
        # An example of the generated rollout_id is '2016-02-16r1'
    "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
        # traffic percentage.
        # different
        # versions of service configurations based on traffic percentage.
        #
        # One example of how to gradually rollout a new service configuration using
        # this
        # strategy:
        # Day 1
        #
        #     Rollout {
        #       id: "example.googleapis.com/rollout_20160206"
        #       traffic_percent_strategy {
        #         percentages: {
        #           "example.googleapis.com/20160201": 70.00
        #           "example.googleapis.com/20160206": 30.00
        #         }
        #       }
        #     }
        #
        # Day 2
        #
        #     Rollout {
        #       id: "example.googleapis.com/rollout_20160207"
        #       traffic_percent_strategy: {
        #         percentages: {
        #           "example.googleapis.com/20160206": 100.00
        #         }
        #       }
        #     }
      "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
          # Key is the service configuration ID, Value is the traffic percentage
          # which must be greater than 0.0 and the sum must equal to 100.0.
        "a_key": 3.14,
      },
    },
    "createdBy": "A String", # The user who created the Rollout. Readonly.
    "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
        # Readonly.
        # used by the system generated rollout to delete a service.
    },
    "serviceName": "A String", # The name of the service associated with this Rollout.
    "createTime": "A String", # Creation time of the rollout. Readonly.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
get(serviceName=None, rolloutId, x__xgafv=None) 
Gets a service configuration rollout.

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  rolloutId: string, The id of the rollout resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A rollout resource that defines how service configuration versions are pushed
        # to control plane systems. Typically, you create a new version of the
        # service config, and then create a Rollout to push the service config.
      "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
          # the system will automatically rollback to the current Rollout
          # version. Readonly.
      "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
          #  and '-' are allowed.
          #
          # If not specified by client, the server will generate one. The generated id
          # will have the form of , where "date" is the create
          # date in ISO 8601 format.  "revision number" is a monotonically increasing
          # positive number that is reset every day for each service.
          # An example of the generated rollout_id is '2016-02-16r1'
      "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
          # traffic percentage.
          # different
          # versions of service configurations based on traffic percentage.
          #
          # One example of how to gradually rollout a new service configuration using
          # this
          # strategy:
          # Day 1
          #
          #     Rollout {
          #       id: "example.googleapis.com/rollout_20160206"
          #       traffic_percent_strategy {
          #         percentages: {
          #           "example.googleapis.com/20160201": 70.00
          #           "example.googleapis.com/20160206": 30.00
          #         }
          #       }
          #     }
          #
          # Day 2
          #
          #     Rollout {
          #       id: "example.googleapis.com/rollout_20160207"
          #       traffic_percent_strategy: {
          #         percentages: {
          #           "example.googleapis.com/20160206": 100.00
          #         }
          #       }
          #     }
        "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
            # Key is the service configuration ID, Value is the traffic percentage
            # which must be greater than 0.0 and the sum must equal to 100.0.
          "a_key": 3.14,
        },
      },
      "createdBy": "A String", # The user who created the Rollout. Readonly.
      "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
          # Readonly.
          # used by the system generated rollout to delete a service.
      },
      "serviceName": "A String", # The name of the service associated with this Rollout.
      "createTime": "A String", # Creation time of the rollout. Readonly.
    }
list(serviceName=None, pageSize=None, pageToken=None, x__xgafv=None) 
Lists the history of the service configuration rollouts for a managed
service, from the newest to the oldest.

Args:
  serviceName: string, The name of the service.  See the [overview](/service-management/overview)
for naming requirements.  For example: `example.googleapis.com`. (required)
  pageSize: integer, The max number of items to include in the response list.
  pageToken: string, The token of the page to retrieve.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListServiceRollouts method.
    "nextPageToken": "A String", # The token of the next page of results.
    "rollouts": [ # The list of rollout resources.
      { # A rollout resource that defines how service configuration versions are pushed
            # to control plane systems. Typically, you create a new version of the
            # service config, and then create a Rollout to push the service config.
          "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
              # the system will automatically rollback to the current Rollout
              # version. Readonly.
          "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
              #  and '-' are allowed.
              #
              # If not specified by client, the server will generate one. The generated id
              # will have the form of , where "date" is the create
              # date in ISO 8601 format.  "revision number" is a monotonically increasing
              # positive number that is reset every day for each service.
              # An example of the generated rollout_id is '2016-02-16r1'
          "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
              # traffic percentage.
              # different
              # versions of service configurations based on traffic percentage.
              #
              # One example of how to gradually rollout a new service configuration using
              # this
              # strategy:
              # Day 1
              #
              #     Rollout {
              #       id: "example.googleapis.com/rollout_20160206"
              #       traffic_percent_strategy {
              #         percentages: {
              #           "example.googleapis.com/20160201": 70.00
              #           "example.googleapis.com/20160206": 30.00
              #         }
              #       }
              #     }
              #
              # Day 2
              #
              #     Rollout {
              #       id: "example.googleapis.com/rollout_20160207"
              #       traffic_percent_strategy: {
              #         percentages: {
              #           "example.googleapis.com/20160206": 100.00
              #         }
              #       }
              #     }
            "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
                # Key is the service configuration ID, Value is the traffic percentage
                # which must be greater than 0.0 and the sum must equal to 100.0.
              "a_key": 3.14,
            },
          },
          "createdBy": "A String", # The user who created the Rollout. Readonly.
          "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
              # Readonly.
              # used by the system generated rollout to delete a service.
          },
          "serviceName": "A String", # The name of the service associated with this Rollout.
          "createTime": "A String", # Creation time of the rollout. Readonly.
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/sheets_v4.html000066400000000000000000000041321300622755700226630ustar00rootroot00000000000000

Google Sheets API

Instance Methods

spreadsheets()

Returns the spreadsheets Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/sheets_v4.spreadsheets.html000066400000000000000000101642631300622755700253710ustar00rootroot00000000000000

Google Sheets API . spreadsheets

Instance Methods

sheets()

Returns the sheets Resource.

values()

Returns the values Resource.

batchUpdate(spreadsheetId, body, x__xgafv=None)

Applies one or more updates to the spreadsheet.

create(body, x__xgafv=None)

Creates a spreadsheet, returning the newly created spreadsheet.

get(spreadsheetId, ranges=None, x__xgafv=None, includeGridData=None)

Returns the spreadsheet at the given ID.

Method Details

batchUpdate(spreadsheetId, body, x__xgafv=None) 
Applies one or more updates to the spreadsheet.

Each request is validated before
being applied. If any request is not valid then the entire request will
fail and nothing will be applied.

Some requests have replies to
give you some information about how
they are applied. The replies will mirror the requests.  For example,
if you applied 4 updates and the 3rd one had a reply, then the
response will have 2 empty replies, the actual reply, and another empty
reply, in that order.

Due to the collaborative nature of spreadsheets, it is not guaranteed that
the spreadsheet will reflect exactly your changes after this completes,
however it is guaranteed that the updates in the request will be
applied together atomically. Your changes may be altered with respect to
collaborator changes. If there are no collaborators, the spreadsheet
should reflect your changes.

Args:
  spreadsheetId: string, The spreadsheet to apply the updates to. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for updating any aspect of a spreadsheet.
    "requests": [ # A list of updates to apply to the spreadsheet.
      { # A single kind of update to apply to a spreadsheet.
        "duplicateFilterView": { # Duplicates a particular filter view. # Duplicates a filter view.
          "filterId": 42, # The ID of the filter being duplicated.
        },
        "sortRange": { # Sorts data in rows based on a sort order per column. # Sorts data in a range.
          "range": { # A range on a sheet. # The range to sort.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "sortSpecs": [ # The sort order per column. Later specifications are used when values
              # are equal in the earlier specifications.
            { # A sort order associated with a specific column or row.
              "sortOrder": "A String", # The order data should be sorted.
              "dimensionIndex": 42, # The dimension the sort should be applied to.
            },
          ],
        },
        "updateEmbeddedObjectPosition": { # Update an embedded object's position (such as a moving or resizing a # Updates an embedded object's (e.g. chart, image) position.
            # chart or image).
          "newPosition": { # The position of an embedded object such as a chart. # An explicit position to move the embedded object to.
              # If newPosition.sheetId is set,
              # a new sheet with that ID will be created.
              # If newPosition.newSheet is set to true,
              # a new sheet will be created with an ID that will be chosen for you.
            "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                # is chosen for you. Used only when writing.
            "sheetId": 42, # The sheet this is on. Set only if the embedded object
                # is on its own sheet. Must be non-negative.
            "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
              "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                  # All indexes are zero-based.
                "rowIndex": 42, # The row index of the coordinate.
                "columnIndex": 42, # The column index of the coordinate.
                "sheetId": 42, # The sheet this coordinate is on.
              },
              "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                  # from the anchor cell.
              "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
              "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                  # from the anchor cell.
              "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
            },
          },
          "fields": "A String", # The fields of OverlayPosition
              # that should be updated when setting a new position. Used only if
              # newPosition.overlayPosition
              # is set, in which case at least one field must
              # be specified.  The root `newPosition.overlayPosition` is implied and
              # should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "objectId": 42, # The ID of the object to moved.
        },
        "updateConditionalFormatRule": { # Updates a conditional format rule at the given index, # Updates an existing conditional format rule.
            # or moves a conditional format rule to another index.
          "index": 42, # The zero-based index of the rule that should be replaced or moved.
          "newIndex": 42, # The zero-based new index the rule should end up at.
          "sheetId": 42, # The sheet of the rule to move.  Required if new_index is set,
              # unused otherwise.
          "rule": { # A rule describing a conditional format. # The rule that should replace the rule at the given index.
            "ranges": [ # The ranges that will be formatted if the condition is true.
                # All the ranges must be on the same grid.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
              "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                  # the format will be applied.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
              "format": { # The format of a cell. # The format to apply.
                  # Conditional formatting can only apply a subset of formatting:
                  # bold, italic,
                  # strikethrough,
                  # foreground color &
                  # background color.
                "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                  "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                      # the user's locale will be used if necessary for the given type.
                      # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                      # information about the supported patterns.
                  "type": "A String", # The type of the number format.
                      # When writing, this field must be set.
                },
                "textDirection": "A String", # The direction of the text in the cell.
                "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                    # When updating padding, every field must be specified.
                  "top": 42, # The top padding of the cell.
                  "right": 42, # The right padding of the cell.
                  "bottom": 42, # The bottom padding of the cell.
                  "left": 42, # The left padding of the cell.
                },
                "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
                "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                "borders": { # The borders of the cell. # The borders of the cell.
                  "top": { # A border along a cell. # The top border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "right": { # A border along a cell. # The right border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "bottom": { # A border along a cell. # The bottom border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "left": { # A border along a cell. # The left border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                },
                "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
              },
            },
            "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                # the interpolation points listed. The format of a cell will vary
                # based on its contents as compared to the values of the interpolation
                # points.
              "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
            },
          },
        },
        "updateProtectedRange": { # Updates an existing protected range with the specified # Updates a protected range.
            # protectedRangeId.
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root `protectedRange` is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "protectedRange": { # A protected range. # The protected range to update with the new properties.
            "unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.
                # Unprotected ranges are only supported on protected sheets.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the
                # protected area.
                # This field is read-only.
            "description": "A String", # The description of this protected range.
            "namedRangeId": "A String", # The named range this protected range is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.
                # This field is only visible to users with edit access to the protected
                # range and the document.
                # Editors are not supported with warning_only protection.
              "domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected
                  # range.  Domain protection is only supported on documents within a domain.
              "users": [ # The email addresses of users with edit access to the protected range.
                "A String",
              ],
              "groups": [ # The email addresses of groups with edit access to the protected range.
                "A String",
              ],
            },
            "protectedRangeId": 42, # The ID of the protected range.
                # This field is read-only.
            "warningOnly": True or False, # True if this protected range will show a warning when editing.
                # Warning-based protection means that every user can edit data in the
                # protected range, except editing will prompt a warning asking the user
                # to confirm the edit.
                #
                # When writing: if this field is true, then editors is ignored.
                # Additionally, if this field is changed from true to false and the
                # `editors` field is not set (nor included in the field mask), then
                # the editors will be set to all the editors in the document.
            "range": { # A range on a sheet. # The range that is being protected.
                # The range may be fully unbounded, in which case this is considered
                # a protected sheet.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
          },
        },
        "deleteDimension": { # Deletes the dimensions from the sheet. # Deletes rows or columns in a sheet.
          "range": { # A range along a single dimension on a sheet. # The dimensions to delete from the sheet.
              # All indexes are zero-based.
              # Indexes are half open: the start index is inclusive
              # and the end index is exclusive.
              # Missing indexes indicate the range is unbounded on that side.
            "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
            "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
            "sheetId": 42, # The sheet this span is on.
            "dimension": "A String", # The dimension of the span.
          },
        },
        "addProtectedRange": { # Adds a new protected range. # Adds a protected range.
          "protectedRange": { # A protected range. # The protected range to be added. The
              # protectedRangeId field is optional; if
              # one is not set, an id will be randomly generated. (It is an error to
              # specify the ID of a range that already exists.)
            "unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.
                # Unprotected ranges are only supported on protected sheets.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the
                # protected area.
                # This field is read-only.
            "description": "A String", # The description of this protected range.
            "namedRangeId": "A String", # The named range this protected range is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.
                # This field is only visible to users with edit access to the protected
                # range and the document.
                # Editors are not supported with warning_only protection.
              "domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected
                  # range.  Domain protection is only supported on documents within a domain.
              "users": [ # The email addresses of users with edit access to the protected range.
                "A String",
              ],
              "groups": [ # The email addresses of groups with edit access to the protected range.
                "A String",
              ],
            },
            "protectedRangeId": 42, # The ID of the protected range.
                # This field is read-only.
            "warningOnly": True or False, # True if this protected range will show a warning when editing.
                # Warning-based protection means that every user can edit data in the
                # protected range, except editing will prompt a warning asking the user
                # to confirm the edit.
                #
                # When writing: if this field is true, then editors is ignored.
                # Additionally, if this field is changed from true to false and the
                # `editors` field is not set (nor included in the field mask), then
                # the editors will be set to all the editors in the document.
            "range": { # A range on a sheet. # The range that is being protected.
                # The range may be fully unbounded, in which case this is considered
                # a protected sheet.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
          },
        },
        "deleteEmbeddedObject": { # Deletes the embedded object with the given ID. # Deletes an embedded object (e.g, chart, image) in a sheet.
          "objectId": 42, # The ID of the embedded object to delete.
        },
        "pasteData": { # Inserts data into the spreadsheet starting at the specified coordinate. # Pastes data (HTML or delimited) into a sheet.
          "coordinate": { # A coordinate in a sheet. # The coordinate at which the data should start being inserted.
              # All indexes are zero-based.
            "rowIndex": 42, # The row index of the coordinate.
            "columnIndex": 42, # The column index of the coordinate.
            "sheetId": 42, # The sheet this coordinate is on.
          },
          "type": "A String", # How the data should be pasted.
          "delimiter": "A String", # The delimiter in the data.
          "html": True or False, # True if the data is HTML.
          "data": "A String", # The data to insert.
        },
        "appendCells": { # Adds new cells after the last row with data in a sheet, # Appends cells after the last row with data in a sheet.
            # inserting new rows into the sheet if necessary.
          "fields": "A String", # The fields of CellData that should be updated.
              # At least one field must be specified.
              # The root is the CellData; 'row.values.' should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "rows": [ # The data to append.
            { # Data about each cell in a row.
              "values": [ # The values in the row, one per column.
                { # Data about a specific cell.
                  "pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself
                      # is computed dynamically based on its data, grouping, filters, values,
                      # etc. Only the top-left cell of the pivot table contains the pivot table
                      # definition. The other cells will contain the calculated values of the
                      # results of the pivot in their effective_value fields.
                    "valueLayout": "A String", # Whether values should be listed horizontally (as columns)
                        # or vertically (as rows).
                    "rows": [ # Each row grouping in the pivot table.
                      { # A single grouping (either row or column) in a pivot table.
                        "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                        "valueMetadata": [ # Metadata about values in the grouping.
                          { # Metadata about a value in a pivot grouping.
                            "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                            "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                # (Note that formulaValue is not valid,
                                #  because the values will be calculated.)
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          },
                        ],
                        "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                            # If not specified, sorting is alphabetical by this group's values.
                          "buckets": [ # Determines the bucket from which values are chosen to sort.
                              #
                              # For example, in a pivot table with one row group & two column groups,
                              # the row group can list up to two values. The first value corresponds
                              # to a value within the first column group, and the second value
                              # corresponds to a value in the second column group.  If no values
                              # are listed, this would indicate that the row should be sorted according
                              # to the "Grand Total" over the column groups. If a single value is listed,
                              # this would correspond to using the "Total" of that bucket.
                            { # The kinds of value that a cell in a spreadsheet can have.
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          ],
                          "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                              # grouping should be sorted by.
                        },
                        "sortOrder": "A String", # The order the values in this group should be sorted.
                        "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                            #
                            # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                            # means this group refers to column `C`, whereas the offset `1` would refer
                            # to column `D`.
                      },
                    ],
                    "source": { # A range on a sheet. # The range the pivot table is reading data from.
                        # All indexes are zero-based.
                        # Indexes are half open, e.g the start index is inclusive
                        # and the end index is exclusive -- [start_index, end_index).
                        # Missing indexes indicate the range is unbounded on that side.
                        #
                        # For example, if `"Sheet1"` is sheet ID 0, then:
                        #
                        #   `Sheet1!A1:A1 == sheet_id: 0,
                        #                   start_row_index: 0, end_row_index: 1,
                        #                   start_column_index: 0, end_column_index: 1`
                        #
                        #   `Sheet1!A3:B4 == sheet_id: 0,
                        #                   start_row_index: 2, end_row_index: 4,
                        #                   start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A:B == sheet_id: 0,
                        #                 start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A5:B == sheet_id: 0,
                        #                  start_row_index: 4,
                        #                  start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1 == sheet_id:0`
                        #
                        # The start index must always be less than or equal to the end index.
                        # If the start index equals the end index, then the range is empty.
                        # Empty ranges are typically not meaningful and are usually rendered in the
                        # UI as `#REF!`.
                      "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                      "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                      "sheetId": 42, # The sheet this range is on.
                      "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                      "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                    },
                    "values": [ # A list of values to include in the pivot table.
                      { # The definition of how a value in a pivot table should be calculated.
                        "formula": "A String", # A custom formula to calculate the value.  The formula must start
                            # with an `=` character.
                        "summarizeFunction": "A String", # A function to summarize the value.
                            # If formula is set, the only supported values are
                            # SUM and
                            # CUSTOM.
                            # If sourceColumnOffset is set, then `CUSTOM`
                            # is not supported.
                        "sourceColumnOffset": 42, # The column offset of the source range that this value reads from.
                            #
                            # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                            # means this value refers to column `C`, whereas the offset `1` would
                            # refer to column `D`.
                        "name": "A String", # A name to use for the value. This is only used if formula was set.
                            # Otherwise, the column name is used.
                      },
                    ],
                    "criteria": { # An optional mapping of filters per source column offset.
                        #
                        # The filters will be applied before aggregating data into the pivot table.
                        # The map's key is the column offset of the source range that you want to
                        # filter, and the value is the criteria for that column.
                        #
                        # For example, if the source was `C10:E15`, a key of `0` will have the filter
                        # for column `C`, whereas the key `1` is for column `D`.
                      "a_key": { # Criteria for showing/hiding rows in a pivot table.
                        "visibleValues": [ # Values that should be included.  Values not listed here are excluded.
                          "A String",
                        ],
                      },
                    },
                    "columns": [ # Each column grouping in the pivot table.
                      { # A single grouping (either row or column) in a pivot table.
                        "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                        "valueMetadata": [ # Metadata about values in the grouping.
                          { # Metadata about a value in a pivot grouping.
                            "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                            "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                # (Note that formulaValue is not valid,
                                #  because the values will be calculated.)
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          },
                        ],
                        "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                            # If not specified, sorting is alphabetical by this group's values.
                          "buckets": [ # Determines the bucket from which values are chosen to sort.
                              #
                              # For example, in a pivot table with one row group & two column groups,
                              # the row group can list up to two values. The first value corresponds
                              # to a value within the first column group, and the second value
                              # corresponds to a value in the second column group.  If no values
                              # are listed, this would indicate that the row should be sorted according
                              # to the "Grand Total" over the column groups. If a single value is listed,
                              # this would correspond to using the "Total" of that bucket.
                            { # The kinds of value that a cell in a spreadsheet can have.
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          ],
                          "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                              # grouping should be sorted by.
                        },
                        "sortOrder": "A String", # The order the values in this group should be sorted.
                        "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                            #
                            # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                            # means this group refers to column `C`, whereas the offset `1` would refer
                            # to column `D`.
                      },
                    ],
                  },
                  "hyperlink": "A String", # A hyperlink this cell points to, if any.
                      # This field is read-only.  (To set it, use a `=HYPERLINK` formula.)
                  "effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be
                      # the calculated value.  For cells with literals, this will be
                      # the same as the user_entered_value.
                      # This field is read-only.
                    "numberValue": 3.14, # Represents a double value.
                        # Note: Dates, Times and DateTimes are represented as doubles in
                        # "serial number" format.
                    "boolValue": True or False, # Represents a boolean value.
                    "formulaValue": "A String", # Represents a formula.
                    "stringValue": "A String", # Represents a string value.
                        # Leading single quotes are not included. For example, if the user typed
                        # `'123` into the UI, this would be represented as a `stringValue` of
                        # `"123"`.
                    "errorValue": { # An error in a cell. # Represents an error.
                        # This field is read-only.
                      "message": "A String", # A message with more information about the error
                          # (in the spreadsheet's locale).
                      "type": "A String", # The type of error.
                    },
                  },
                  "formattedValue": "A String", # The formatted value of the cell.
                      # This is the value as it's shown to the user.
                      # This field is read-only.
                  "userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
                      # Note: Dates, Times and DateTimes are represented as doubles in
                      # serial number format.
                    "numberValue": 3.14, # Represents a double value.
                        # Note: Dates, Times and DateTimes are represented as doubles in
                        # "serial number" format.
                    "boolValue": True or False, # Represents a boolean value.
                    "formulaValue": "A String", # Represents a formula.
                    "stringValue": "A String", # Represents a string value.
                        # Leading single quotes are not included. For example, if the user typed
                        # `'123` into the UI, this would be represented as a `stringValue` of
                        # `"123"`.
                    "errorValue": { # An error in a cell. # Represents an error.
                        # This field is read-only.
                      "message": "A String", # A message with more information about the error
                          # (in the spreadsheet's locale).
                      "type": "A String", # The type of error.
                    },
                  },
                  "note": "A String", # Any note on the cell.
                  "effectiveFormat": { # The format of a cell. # The effective format being used by the cell.
                      # This includes the results of applying any conditional formatting and,
                      # if the cell contains a formula, the computed number format.
                      # If the effective format is the default format, effective format will
                      # not be written.
                      # This field is read-only.
                    "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                      "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                          # the user's locale will be used if necessary for the given type.
                          # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                          # information about the supported patterns.
                      "type": "A String", # The type of the number format.
                          # When writing, this field must be set.
                    },
                    "textDirection": "A String", # The direction of the text in the cell.
                    "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                        # When updating padding, every field must be specified.
                      "top": 42, # The top padding of the cell.
                      "right": 42, # The right padding of the cell.
                      "bottom": 42, # The bottom padding of the cell.
                      "left": 42, # The left padding of the cell.
                    },
                    "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                    "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                    "borders": { # The borders of the cell. # The borders of the cell.
                      "top": { # A border along a cell. # The top border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "right": { # A border along a cell. # The right border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "bottom": { # A border along a cell. # The bottom border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "left": { # A border along a cell. # The left border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                    },
                    "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                  },
                  "userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
                      #
                      # When writing, the new format will be merged with the existing format.
                    "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                      "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                          # the user's locale will be used if necessary for the given type.
                          # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                          # information about the supported patterns.
                      "type": "A String", # The type of the number format.
                          # When writing, this field must be set.
                    },
                    "textDirection": "A String", # The direction of the text in the cell.
                    "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                        # When updating padding, every field must be specified.
                      "top": 42, # The top padding of the cell.
                      "right": 42, # The right padding of the cell.
                      "bottom": 42, # The bottom padding of the cell.
                      "left": 42, # The left padding of the cell.
                    },
                    "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                    "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                    "borders": { # The borders of the cell. # The borders of the cell.
                      "top": { # A border along a cell. # The top border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "right": { # A border along a cell. # The right border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "bottom": { # A border along a cell. # The bottom border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "left": { # A border along a cell. # The left border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                    },
                    "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                  },
                  "dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
                      #
                      # When writing, the new data validation rule will overwrite any prior rule.
                    "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                        # If true, "List" conditions will show a dropdown.
                    "strict": True or False, # True if invalid data should be rejected.
                    "inputMessage": "A String", # A message to show the user when adding data to the cell.
                    "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                        # BooleanConditions are used by conditional formatting,
                        # data validation, and the criteria in filters.
                      "type": "A String", # The type of condition.
                      "values": [ # The values of the condition. The number of supported values depends
                          # on the condition type.  Some support zero values,
                          # others one or two values,
                          # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                        { # The value of the condition.
                          "relativeDate": "A String", # A relative date (based on the current date).
                              # Valid only if the type is
                              # DATE_BEFORE,
                              # DATE_AFTER,
                              # DATE_ON_OR_BEFORE or
                              # DATE_ON_OR_AFTER.
                              #
                              # Relative dates are not supported in data validation.
                              # They are supported only in conditional formatting and
                              # conditional filters.
                          "userEnteredValue": "A String", # A value the condition is based on.
                              # The value will be parsed as if the user typed into a cell.
                              # Formulas are supported (and must begin with an `=`).
                        },
                      ],
                    },
                  },
                  "textFormatRuns": [ # Runs of rich text applied to subsections of the cell.  Runs are only valid
                      # on user entered strings, not formulas, bools, or numbers.
                      # Runs start at specific indexes in the text and continue until the next
                      # run. Properties of a run will continue unless explicitly changed
                      # in a subsequent run (and properties of the first run will continue
                      # the properties of the cell unless explicitly changed).
                      #
                      # When writing, the new runs will overwrite any prior runs.  When writing a
                      # new user_entered_value, previous runs will be erased.
                    { # A run of a text format. The format of this run continues until the start
                        # index of the next run.
                        # When updating, all fields must be set.
                      "startIndex": 42, # The character index where this run starts.
                      "format": { # The format of a run of text in a cell. # The format of this run.  Absent values inherit the cell's format.
                          # Absent values indicate that the field isn't specified.
                        "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # True if the text is bold.
                        "strikethrough": True or False, # True if the text has a strikethrough.
                        "fontFamily": "A String", # The font family.
                        "fontSize": 42, # The size of the font.
                        "italic": True or False, # True if the text is italicized.
                        "underline": True or False, # True if the text is underlined.
                      },
                    },
                  ],
                },
              ],
            },
          ],
          "sheetId": 42, # The sheet ID to append the data to.
        },
        "duplicateSheet": { # Duplicates the contents of a sheet. # Duplicates a sheet.
          "sourceSheetId": 42, # The sheet to duplicate.
          "insertSheetIndex": 42, # The zero-based index where the new sheet should be inserted.
              # The index of all sheets after this are incremented.
          "newSheetName": "A String", # The name of the new sheet.  If empty, a new name is chosen for you.
          "newSheetId": 42, # If set, the ID of the new sheet. If not set, an ID is chosen.
              # If set, the ID must not conflict with any existing sheet ID.
              # If set, it must be non-negative.
        },
        "updateSheetProperties": { # Updates properties of the sheet with the specified # Updates a sheet's properties.
            # sheetId.
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root `properties` is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "properties": { # Properties of a sheet. # The properties to update.
            "sheetType": "A String", # The type of sheet. Defaults to GRID.
                # This field cannot be changed once set.
            "index": 42, # The index of the sheet within the spreadsheet.
                # When adding or updating sheet properties, if this field
                # is excluded then the sheet will be added or moved to the end
                # of the sheet list.
            "title": "A String", # The name of the sheet.
            "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
                # (If the sheet is an object sheet, containing a chart or image, then
                # this field will be absent.)
                # When writing it is an error to set any grid properties on non-grid sheets.
              "columnCount": 42, # The number of columns in the grid.
              "rowCount": 42, # The number of rows in the grid.
              "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
              "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
              "frozenRowCount": 42, # The number of rows that are frozen in the grid.
            },
            "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
            "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
            "sheetId": 42, # The ID of the sheet. Must be non-negative.
                # This field cannot be changed once set.
          },
        },
        "addChart": { # Adds a chart to a sheet in the spreadsheet. # Adds a chart.
          "chart": { # A chart embedded in a sheet. # The chart that should be added to the spreadsheet, including the position
              # where it should be placed. The chartId
              # field is optional; if one is not set, an id will be randomly generated. (It
              # is an error to specify the ID of a chart that already exists.)
            "chartId": 42, # The ID of the chart.
            "position": { # The position of an embedded object such as a chart. # The position of the chart.
              "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                  # is chosen for you. Used only when writing.
              "sheetId": 42, # The sheet this is on. Set only if the embedded object
                  # is on its own sheet. Must be non-negative.
              "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
                "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                    # All indexes are zero-based.
                  "rowIndex": 42, # The row index of the coordinate.
                  "columnIndex": 42, # The column index of the coordinate.
                  "sheetId": 42, # The sheet this coordinate is on.
                },
                "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                    # from the anchor cell.
                "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
                "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                    # from the anchor cell.
                "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
              },
            },
            "spec": { # The specifications of a chart. # The specification of the chart.
              "hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.
              "pieChart": { # A pie chart. # A pie chart specification.
                "series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.
                  "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                    "sources": [ # The ranges of data for a series or domain.
                        # Exactly one dimension must have a length of 1,
                        # and all sources in the list must have the same dimension
                        # with length 1.
                        # The domain (if it exists) & all series must have the same number
                        # of source ranges. If using more than one source range, then the source
                        # range at a given offset must be contiguous across the domain and series.
                        #
                        # For example, these are valid configurations:
                        #
                        #     domain sources: A1:A5
                        #     series1 sources: B1:B5
                        #     series2 sources: D6:D10
                        #
                        #     domain sources: A1:A5, C10:C12
                        #     series1 sources: B1:B5, D10:D12
                        #     series2 sources: C1:C5, E10:E12
                      { # A range on a sheet.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                    ],
                  },
                },
                "domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.
                  "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                    "sources": [ # The ranges of data for a series or domain.
                        # Exactly one dimension must have a length of 1,
                        # and all sources in the list must have the same dimension
                        # with length 1.
                        # The domain (if it exists) & all series must have the same number
                        # of source ranges. If using more than one source range, then the source
                        # range at a given offset must be contiguous across the domain and series.
                        #
                        # For example, these are valid configurations:
                        #
                        #     domain sources: A1:A5
                        #     series1 sources: B1:B5
                        #     series2 sources: D6:D10
                        #
                        #     domain sources: A1:A5, C10:C12
                        #     series1 sources: B1:B5, D10:D12
                        #     series2 sources: C1:C5, E10:E12
                      { # A range on a sheet.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                    ],
                  },
                },
                "threeDimensional": True or False, # True if the pie is three dimensional.
                "legendPosition": "A String", # Where the legend of the pie chart should be drawn.
                "pieHole": 3.14, # The size of the hole in the pie chart.
              },
              "basicChart": { # The specification for a basic chart.  See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.
                  # See BasicChartType for the list of all
                  # charts this supports.
                  # of charts this supports.
                "headerCount": 42, # The number of rows or columns in the data that are "headers".
                    # If not set, Google Sheets will guess how many rows are headers based
                    # on the data.
                    #
                    # (Note that BasicChartAxis.title may override the axis title
                    #  inferred from the header values.)
                "series": [ # The data this chart is visualizing.
                  { # A single series of data in a chart.
                      # For example, if charting stock prices over time, multiple series may exist,
                      # one for the "Open Price", "High Price", "Low Price" and "Close Price".
                    "series": { # The data included in a domain or series. # The data being visualized in this chart series.
                      "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                        "sources": [ # The ranges of data for a series or domain.
                            # Exactly one dimension must have a length of 1,
                            # and all sources in the list must have the same dimension
                            # with length 1.
                            # The domain (if it exists) & all series must have the same number
                            # of source ranges. If using more than one source range, then the source
                            # range at a given offset must be contiguous across the domain and series.
                            #
                            # For example, these are valid configurations:
                            #
                            #     domain sources: A1:A5
                            #     series1 sources: B1:B5
                            #     series2 sources: D6:D10
                            #
                            #     domain sources: A1:A5, C10:C12
                            #     series1 sources: B1:B5, D10:D12
                            #     series2 sources: C1:C5, E10:E12
                          { # A range on a sheet.
                              # All indexes are zero-based.
                              # Indexes are half open, e.g the start index is inclusive
                              # and the end index is exclusive -- [start_index, end_index).
                              # Missing indexes indicate the range is unbounded on that side.
                              #
                              # For example, if `"Sheet1"` is sheet ID 0, then:
                              #
                              #   `Sheet1!A1:A1 == sheet_id: 0,
                              #                   start_row_index: 0, end_row_index: 1,
                              #                   start_column_index: 0, end_column_index: 1`
                              #
                              #   `Sheet1!A3:B4 == sheet_id: 0,
                              #                   start_row_index: 2, end_row_index: 4,
                              #                   start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A:B == sheet_id: 0,
                              #                 start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A5:B == sheet_id: 0,
                              #                  start_row_index: 4,
                              #                  start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1 == sheet_id:0`
                              #
                              # The start index must always be less than or equal to the end index.
                              # If the start index equals the end index, then the range is empty.
                              # Empty ranges are typically not meaningful and are usually rendered in the
                              # UI as `#REF!`.
                            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                            "sheetId": 42, # The sheet this range is on.
                            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                          },
                        ],
                      },
                    },
                    "targetAxis": "A String", # The minor axis that will specify the range of values for this series.
                        # For example, if charting stocks over time, the "Volume" series
                        # may want to be pinned to the right with the prices pinned to the left,
                        # because the scale of trading volume is different than the scale of
                        # prices.
                        # It is an error to specify an axis that isn't a valid minor axis
                        # for the chart's type.
                    "type": "A String", # The type of this series. Valid only if the
                        # chartType is
                        # COMBO.
                        # Different types will change the way the series is visualized.
                        # Only LINE, AREA,
                        # and COLUMN are supported.
                  },
                ],
                "legendPosition": "A String", # The position of the chart legend.
                "domains": [ # The domain of data this is charting.
                    # Only a single domain is currently supported.
                  { # The domain of a chart.
                      # For example, if charting stock prices over time, this would be the date.
                    "domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,
                        # this is the data representing the dates.
                      "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                        "sources": [ # The ranges of data for a series or domain.
                            # Exactly one dimension must have a length of 1,
                            # and all sources in the list must have the same dimension
                            # with length 1.
                            # The domain (if it exists) & all series must have the same number
                            # of source ranges. If using more than one source range, then the source
                            # range at a given offset must be contiguous across the domain and series.
                            #
                            # For example, these are valid configurations:
                            #
                            #     domain sources: A1:A5
                            #     series1 sources: B1:B5
                            #     series2 sources: D6:D10
                            #
                            #     domain sources: A1:A5, C10:C12
                            #     series1 sources: B1:B5, D10:D12
                            #     series2 sources: C1:C5, E10:E12
                          { # A range on a sheet.
                              # All indexes are zero-based.
                              # Indexes are half open, e.g the start index is inclusive
                              # and the end index is exclusive -- [start_index, end_index).
                              # Missing indexes indicate the range is unbounded on that side.
                              #
                              # For example, if `"Sheet1"` is sheet ID 0, then:
                              #
                              #   `Sheet1!A1:A1 == sheet_id: 0,
                              #                   start_row_index: 0, end_row_index: 1,
                              #                   start_column_index: 0, end_column_index: 1`
                              #
                              #   `Sheet1!A3:B4 == sheet_id: 0,
                              #                   start_row_index: 2, end_row_index: 4,
                              #                   start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A:B == sheet_id: 0,
                              #                 start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A5:B == sheet_id: 0,
                              #                  start_row_index: 4,
                              #                  start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1 == sheet_id:0`
                              #
                              # The start index must always be less than or equal to the end index.
                              # If the start index equals the end index, then the range is empty.
                              # Empty ranges are typically not meaningful and are usually rendered in the
                              # UI as `#REF!`.
                            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                            "sheetId": 42, # The sheet this range is on.
                            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                          },
                        ],
                      },
                    },
                  },
                ],
                "chartType": "A String", # The type of the chart.
                "axis": [ # The axis on the chart.
                  { # An axis of the chart.
                      # A chart may not have more than one axis per
                      # axis position.
                    "position": "A String", # The position of this axis.
                    "format": { # The format of a run of text in a cell. # The format of the title.
                        # Only valid if the axis is not associated with the domain.
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "title": "A String", # The title of this axis. If set, this overrides any title inferred
                        # from headers of the data.
                  },
                ],
              },
              "title": "A String", # The title of the chart.
            },
          },
        },
        "addConditionalFormatRule": { # Adds a new conditional format rule at the given index. # Adds a new conditional format rule.
            # All subsequent rules' indexes are incremented.
          "index": 42, # The zero-based index where the rule should be inserted.
          "rule": { # A rule describing a conditional format. # The rule to add.
            "ranges": [ # The ranges that will be formatted if the condition is true.
                # All the ranges must be on the same grid.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
              "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                  # the format will be applied.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
              "format": { # The format of a cell. # The format to apply.
                  # Conditional formatting can only apply a subset of formatting:
                  # bold, italic,
                  # strikethrough,
                  # foreground color &
                  # background color.
                "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                  "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                      # the user's locale will be used if necessary for the given type.
                      # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                      # information about the supported patterns.
                  "type": "A String", # The type of the number format.
                      # When writing, this field must be set.
                },
                "textDirection": "A String", # The direction of the text in the cell.
                "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                    # When updating padding, every field must be specified.
                  "top": 42, # The top padding of the cell.
                  "right": 42, # The right padding of the cell.
                  "bottom": 42, # The bottom padding of the cell.
                  "left": 42, # The left padding of the cell.
                },
                "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
                "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                "borders": { # The borders of the cell. # The borders of the cell.
                  "top": { # A border along a cell. # The top border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "right": { # A border along a cell. # The right border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "bottom": { # A border along a cell. # The bottom border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "left": { # A border along a cell. # The left border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                },
                "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
              },
            },
            "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                # the interpolation points listed. The format of a cell will vary
                # based on its contents as compared to the values of the interpolation
                # points.
              "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
            },
          },
        },
        "repeatCell": { # Updates all cells in the range to the values in the given Cell object. # Repeats a single cell across a range.
            # Only the fields listed in the fields field are updated; others are
            # unchanged.
            #
            # If writing a cell with a formula, the formula's ranges will automatically
            # increment for each field in the range.
            # For example, if writing a cell with formula `=A1` into range B2:C4,
            # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,
            # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.
            #
            # To keep the formula's ranges static, use the `$` indicator.
            # For example, use the formula `=$A$1` to prevent both the row and the
            # column from incrementing.
          "cell": { # Data about a specific cell. # The data to write.
            "pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself
                # is computed dynamically based on its data, grouping, filters, values,
                # etc. Only the top-left cell of the pivot table contains the pivot table
                # definition. The other cells will contain the calculated values of the
                # results of the pivot in their effective_value fields.
              "valueLayout": "A String", # Whether values should be listed horizontally (as columns)
                  # or vertically (as rows).
              "rows": [ # Each row grouping in the pivot table.
                { # A single grouping (either row or column) in a pivot table.
                  "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                  "valueMetadata": [ # Metadata about values in the grouping.
                    { # Metadata about a value in a pivot grouping.
                      "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                      "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                          # (Note that formulaValue is not valid,
                          #  because the values will be calculated.)
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                    },
                  ],
                  "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                      # If not specified, sorting is alphabetical by this group's values.
                    "buckets": [ # Determines the bucket from which values are chosen to sort.
                        #
                        # For example, in a pivot table with one row group & two column groups,
                        # the row group can list up to two values. The first value corresponds
                        # to a value within the first column group, and the second value
                        # corresponds to a value in the second column group.  If no values
                        # are listed, this would indicate that the row should be sorted according
                        # to the "Grand Total" over the column groups. If a single value is listed,
                        # this would correspond to using the "Total" of that bucket.
                      { # The kinds of value that a cell in a spreadsheet can have.
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                    ],
                    "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                        # grouping should be sorted by.
                  },
                  "sortOrder": "A String", # The order the values in this group should be sorted.
                  "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                      #
                      # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                      # means this group refers to column `C`, whereas the offset `1` would refer
                      # to column `D`.
                },
              ],
              "source": { # A range on a sheet. # The range the pivot table is reading data from.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
              "values": [ # A list of values to include in the pivot table.
                { # The definition of how a value in a pivot table should be calculated.
                  "formula": "A String", # A custom formula to calculate the value.  The formula must start
                      # with an `=` character.
                  "summarizeFunction": "A String", # A function to summarize the value.
                      # If formula is set, the only supported values are
                      # SUM and
                      # CUSTOM.
                      # If sourceColumnOffset is set, then `CUSTOM`
                      # is not supported.
                  "sourceColumnOffset": 42, # The column offset of the source range that this value reads from.
                      #
                      # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                      # means this value refers to column `C`, whereas the offset `1` would
                      # refer to column `D`.
                  "name": "A String", # A name to use for the value. This is only used if formula was set.
                      # Otherwise, the column name is used.
                },
              ],
              "criteria": { # An optional mapping of filters per source column offset.
                  #
                  # The filters will be applied before aggregating data into the pivot table.
                  # The map's key is the column offset of the source range that you want to
                  # filter, and the value is the criteria for that column.
                  #
                  # For example, if the source was `C10:E15`, a key of `0` will have the filter
                  # for column `C`, whereas the key `1` is for column `D`.
                "a_key": { # Criteria for showing/hiding rows in a pivot table.
                  "visibleValues": [ # Values that should be included.  Values not listed here are excluded.
                    "A String",
                  ],
                },
              },
              "columns": [ # Each column grouping in the pivot table.
                { # A single grouping (either row or column) in a pivot table.
                  "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                  "valueMetadata": [ # Metadata about values in the grouping.
                    { # Metadata about a value in a pivot grouping.
                      "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                      "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                          # (Note that formulaValue is not valid,
                          #  because the values will be calculated.)
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                    },
                  ],
                  "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                      # If not specified, sorting is alphabetical by this group's values.
                    "buckets": [ # Determines the bucket from which values are chosen to sort.
                        #
                        # For example, in a pivot table with one row group & two column groups,
                        # the row group can list up to two values. The first value corresponds
                        # to a value within the first column group, and the second value
                        # corresponds to a value in the second column group.  If no values
                        # are listed, this would indicate that the row should be sorted according
                        # to the "Grand Total" over the column groups. If a single value is listed,
                        # this would correspond to using the "Total" of that bucket.
                      { # The kinds of value that a cell in a spreadsheet can have.
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                    ],
                    "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                        # grouping should be sorted by.
                  },
                  "sortOrder": "A String", # The order the values in this group should be sorted.
                  "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                      #
                      # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                      # means this group refers to column `C`, whereas the offset `1` would refer
                      # to column `D`.
                },
              ],
            },
            "hyperlink": "A String", # A hyperlink this cell points to, if any.
                # This field is read-only.  (To set it, use a `=HYPERLINK` formula.)
            "effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be
                # the calculated value.  For cells with literals, this will be
                # the same as the user_entered_value.
                # This field is read-only.
              "numberValue": 3.14, # Represents a double value.
                  # Note: Dates, Times and DateTimes are represented as doubles in
                  # "serial number" format.
              "boolValue": True or False, # Represents a boolean value.
              "formulaValue": "A String", # Represents a formula.
              "stringValue": "A String", # Represents a string value.
                  # Leading single quotes are not included. For example, if the user typed
                  # `'123` into the UI, this would be represented as a `stringValue` of
                  # `"123"`.
              "errorValue": { # An error in a cell. # Represents an error.
                  # This field is read-only.
                "message": "A String", # A message with more information about the error
                    # (in the spreadsheet's locale).
                "type": "A String", # The type of error.
              },
            },
            "formattedValue": "A String", # The formatted value of the cell.
                # This is the value as it's shown to the user.
                # This field is read-only.
            "userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
                # Note: Dates, Times and DateTimes are represented as doubles in
                # serial number format.
              "numberValue": 3.14, # Represents a double value.
                  # Note: Dates, Times and DateTimes are represented as doubles in
                  # "serial number" format.
              "boolValue": True or False, # Represents a boolean value.
              "formulaValue": "A String", # Represents a formula.
              "stringValue": "A String", # Represents a string value.
                  # Leading single quotes are not included. For example, if the user typed
                  # `'123` into the UI, this would be represented as a `stringValue` of
                  # `"123"`.
              "errorValue": { # An error in a cell. # Represents an error.
                  # This field is read-only.
                "message": "A String", # A message with more information about the error
                    # (in the spreadsheet's locale).
                "type": "A String", # The type of error.
              },
            },
            "note": "A String", # Any note on the cell.
            "effectiveFormat": { # The format of a cell. # The effective format being used by the cell.
                # This includes the results of applying any conditional formatting and,
                # if the cell contains a formula, the computed number format.
                # If the effective format is the default format, effective format will
                # not be written.
                # This field is read-only.
              "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                    # the user's locale will be used if necessary for the given type.
                    # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                    # information about the supported patterns.
                "type": "A String", # The type of the number format.
                    # When writing, this field must be set.
              },
              "textDirection": "A String", # The direction of the text in the cell.
              "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                  # When updating padding, every field must be specified.
                "top": 42, # The top padding of the cell.
                "right": 42, # The right padding of the cell.
                "bottom": 42, # The bottom padding of the cell.
                "left": 42, # The left padding of the cell.
              },
              "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
              "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                  # Absent values indicate that the field isn't specified.
                "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "bold": True or False, # True if the text is bold.
                "strikethrough": True or False, # True if the text has a strikethrough.
                "fontFamily": "A String", # The font family.
                "fontSize": 42, # The size of the font.
                "italic": True or False, # True if the text is italicized.
                "underline": True or False, # True if the text is underlined.
              },
              "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
              "borders": { # The borders of the cell. # The borders of the cell.
                "top": { # A border along a cell. # The top border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "right": { # A border along a cell. # The right border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "bottom": { # A border along a cell. # The bottom border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "left": { # A border along a cell. # The left border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
              },
              "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
            },
            "userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
                #
                # When writing, the new format will be merged with the existing format.
              "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                    # the user's locale will be used if necessary for the given type.
                    # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                    # information about the supported patterns.
                "type": "A String", # The type of the number format.
                    # When writing, this field must be set.
              },
              "textDirection": "A String", # The direction of the text in the cell.
              "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                  # When updating padding, every field must be specified.
                "top": 42, # The top padding of the cell.
                "right": 42, # The right padding of the cell.
                "bottom": 42, # The bottom padding of the cell.
                "left": 42, # The left padding of the cell.
              },
              "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
              "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                  # Absent values indicate that the field isn't specified.
                "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "bold": True or False, # True if the text is bold.
                "strikethrough": True or False, # True if the text has a strikethrough.
                "fontFamily": "A String", # The font family.
                "fontSize": 42, # The size of the font.
                "italic": True or False, # True if the text is italicized.
                "underline": True or False, # True if the text is underlined.
              },
              "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
              "borders": { # The borders of the cell. # The borders of the cell.
                "top": { # A border along a cell. # The top border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "right": { # A border along a cell. # The right border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "bottom": { # A border along a cell. # The bottom border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "left": { # A border along a cell. # The left border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
              },
              "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
            },
            "dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
                #
                # When writing, the new data validation rule will overwrite any prior rule.
              "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                  # If true, "List" conditions will show a dropdown.
              "strict": True or False, # True if invalid data should be rejected.
              "inputMessage": "A String", # A message to show the user when adding data to the cell.
              "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
            },
            "textFormatRuns": [ # Runs of rich text applied to subsections of the cell.  Runs are only valid
                # on user entered strings, not formulas, bools, or numbers.
                # Runs start at specific indexes in the text and continue until the next
                # run. Properties of a run will continue unless explicitly changed
                # in a subsequent run (and properties of the first run will continue
                # the properties of the cell unless explicitly changed).
                #
                # When writing, the new runs will overwrite any prior runs.  When writing a
                # new user_entered_value, previous runs will be erased.
              { # A run of a text format. The format of this run continues until the start
                  # index of the next run.
                  # When updating, all fields must be set.
                "startIndex": 42, # The character index where this run starts.
                "format": { # The format of a run of text in a cell. # The format of this run.  Absent values inherit the cell's format.
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
              },
            ],
          },
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root `cell` is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "range": { # A range on a sheet. # The range to repeat the cell in.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
        },
        "findReplace": { # Finds and replaces data in cells over a range, sheet, or all sheets. # Finds and replaces occurrences of some text with other text.
          "includeFormulas": True or False, # True if the search should include cells with formulas.
              # False to skip cells with formulas.
          "matchEntireCell": True or False, # True if the find value should match the entire cell.
          "allSheets": True or False, # True to find/replace over all sheets.
          "matchCase": True or False, # True if the search is case sensitive.
          "sheetId": 42, # The sheet to find/replace over.
          "range": { # A range on a sheet. # The range to find/replace over.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "searchByRegex": True or False, # True if the find value is a regex.
              # The regular expression and replacement should follow Java regex rules
              # at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
              # The replacement string is allowed to refer to capturing groups.
              # For example, if one cell has the contents `"Google Sheets"` and another
              # has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of
              # `"$1 Rocks"` would change the contents of the cells to
              # `"GSheets Rocks"` and `"GDocs Rocks"` respectively.
          "find": "A String", # The value to search.
          "replacement": "A String", # The value to use as the replacement.
        },
        "setBasicFilter": { # Sets the basic filter associated with a sheet. # Sets the basic filter on a sheet.
          "filter": { # The default filter associated with a sheet. # The filter to set.
            "range": { # A range on a sheet. # The range the filter covers.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
        },
        "updateSpreadsheetProperties": { # Updates properties of a spreadsheet. # Updates the spreadsheet's properties.
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root 'properties' is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "properties": { # Properties of a spreadsheet. # The properties to update.
            "locale": "A String", # The locale of the spreadsheet in one of the following formats:
                #
                # * an ISO 639-1 language code such as `en`
                #
                # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
                #
                # * a combination of the ISO language code and country code, such as `en_US`
                #
                # Note: when updating this field, not all locales/languages are supported.
            "timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as
                # `America/New_York`. If the time zone isn't recognized, this may
                # be a custom time zone such as `GMT-07:00`.
            "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
            "defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
                # CellData.effectiveFormat will not be set if the
                # cell's format is equal to this default format.
                # This field is read-only.
              "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                    # the user's locale will be used if necessary for the given type.
                    # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                    # information about the supported patterns.
                "type": "A String", # The type of the number format.
                    # When writing, this field must be set.
              },
              "textDirection": "A String", # The direction of the text in the cell.
              "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                  # When updating padding, every field must be specified.
                "top": 42, # The top padding of the cell.
                "right": 42, # The right padding of the cell.
                "bottom": 42, # The bottom padding of the cell.
                "left": 42, # The left padding of the cell.
              },
              "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
              "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                  # Absent values indicate that the field isn't specified.
                "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "bold": True or False, # True if the text is bold.
                "strikethrough": True or False, # True if the text has a strikethrough.
                "fontFamily": "A String", # The font family.
                "fontSize": 42, # The size of the font.
                "italic": True or False, # True if the text is italicized.
                "underline": True or False, # True if the text is underlined.
              },
              "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
              "borders": { # The borders of the cell. # The borders of the cell.
                "top": { # A border along a cell. # The top border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "right": { # A border along a cell. # The right border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "bottom": { # A border along a cell. # The bottom border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
                "left": { # A border along a cell. # The left border of the cell.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "width": 42, # The width of the border, in pixels.
                      # Deprecated; the width is determined by the "style" field.
                  "style": "A String", # The style of the border.
                },
              },
              "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
            },
            "title": "A String", # The title of the spreadsheet.
          },
        },
        "updateCells": { # Updates all cells in a range with new data. # Updates many cells at once.
          "fields": "A String", # The fields of CellData that should be updated.
              # At least one field must be specified.
              # The root is the CellData; 'row.values.' should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "range": { # A range on a sheet. # The range to write data to.
              #
              # If the data in rows does not cover the entire requested range,
              # the fields matching those set in fields will be cleared.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "rows": [ # The data to write.
            { # Data about each cell in a row.
              "values": [ # The values in the row, one per column.
                { # Data about a specific cell.
                  "pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself
                      # is computed dynamically based on its data, grouping, filters, values,
                      # etc. Only the top-left cell of the pivot table contains the pivot table
                      # definition. The other cells will contain the calculated values of the
                      # results of the pivot in their effective_value fields.
                    "valueLayout": "A String", # Whether values should be listed horizontally (as columns)
                        # or vertically (as rows).
                    "rows": [ # Each row grouping in the pivot table.
                      { # A single grouping (either row or column) in a pivot table.
                        "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                        "valueMetadata": [ # Metadata about values in the grouping.
                          { # Metadata about a value in a pivot grouping.
                            "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                            "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                # (Note that formulaValue is not valid,
                                #  because the values will be calculated.)
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          },
                        ],
                        "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                            # If not specified, sorting is alphabetical by this group's values.
                          "buckets": [ # Determines the bucket from which values are chosen to sort.
                              #
                              # For example, in a pivot table with one row group & two column groups,
                              # the row group can list up to two values. The first value corresponds
                              # to a value within the first column group, and the second value
                              # corresponds to a value in the second column group.  If no values
                              # are listed, this would indicate that the row should be sorted according
                              # to the "Grand Total" over the column groups. If a single value is listed,
                              # this would correspond to using the "Total" of that bucket.
                            { # The kinds of value that a cell in a spreadsheet can have.
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          ],
                          "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                              # grouping should be sorted by.
                        },
                        "sortOrder": "A String", # The order the values in this group should be sorted.
                        "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                            #
                            # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                            # means this group refers to column `C`, whereas the offset `1` would refer
                            # to column `D`.
                      },
                    ],
                    "source": { # A range on a sheet. # The range the pivot table is reading data from.
                        # All indexes are zero-based.
                        # Indexes are half open, e.g the start index is inclusive
                        # and the end index is exclusive -- [start_index, end_index).
                        # Missing indexes indicate the range is unbounded on that side.
                        #
                        # For example, if `"Sheet1"` is sheet ID 0, then:
                        #
                        #   `Sheet1!A1:A1 == sheet_id: 0,
                        #                   start_row_index: 0, end_row_index: 1,
                        #                   start_column_index: 0, end_column_index: 1`
                        #
                        #   `Sheet1!A3:B4 == sheet_id: 0,
                        #                   start_row_index: 2, end_row_index: 4,
                        #                   start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A:B == sheet_id: 0,
                        #                 start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A5:B == sheet_id: 0,
                        #                  start_row_index: 4,
                        #                  start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1 == sheet_id:0`
                        #
                        # The start index must always be less than or equal to the end index.
                        # If the start index equals the end index, then the range is empty.
                        # Empty ranges are typically not meaningful and are usually rendered in the
                        # UI as `#REF!`.
                      "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                      "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                      "sheetId": 42, # The sheet this range is on.
                      "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                      "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                    },
                    "values": [ # A list of values to include in the pivot table.
                      { # The definition of how a value in a pivot table should be calculated.
                        "formula": "A String", # A custom formula to calculate the value.  The formula must start
                            # with an `=` character.
                        "summarizeFunction": "A String", # A function to summarize the value.
                            # If formula is set, the only supported values are
                            # SUM and
                            # CUSTOM.
                            # If sourceColumnOffset is set, then `CUSTOM`
                            # is not supported.
                        "sourceColumnOffset": 42, # The column offset of the source range that this value reads from.
                            #
                            # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                            # means this value refers to column `C`, whereas the offset `1` would
                            # refer to column `D`.
                        "name": "A String", # A name to use for the value. This is only used if formula was set.
                            # Otherwise, the column name is used.
                      },
                    ],
                    "criteria": { # An optional mapping of filters per source column offset.
                        #
                        # The filters will be applied before aggregating data into the pivot table.
                        # The map's key is the column offset of the source range that you want to
                        # filter, and the value is the criteria for that column.
                        #
                        # For example, if the source was `C10:E15`, a key of `0` will have the filter
                        # for column `C`, whereas the key `1` is for column `D`.
                      "a_key": { # Criteria for showing/hiding rows in a pivot table.
                        "visibleValues": [ # Values that should be included.  Values not listed here are excluded.
                          "A String",
                        ],
                      },
                    },
                    "columns": [ # Each column grouping in the pivot table.
                      { # A single grouping (either row or column) in a pivot table.
                        "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                        "valueMetadata": [ # Metadata about values in the grouping.
                          { # Metadata about a value in a pivot grouping.
                            "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                            "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                # (Note that formulaValue is not valid,
                                #  because the values will be calculated.)
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          },
                        ],
                        "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                            # If not specified, sorting is alphabetical by this group's values.
                          "buckets": [ # Determines the bucket from which values are chosen to sort.
                              #
                              # For example, in a pivot table with one row group & two column groups,
                              # the row group can list up to two values. The first value corresponds
                              # to a value within the first column group, and the second value
                              # corresponds to a value in the second column group.  If no values
                              # are listed, this would indicate that the row should be sorted according
                              # to the "Grand Total" over the column groups. If a single value is listed,
                              # this would correspond to using the "Total" of that bucket.
                            { # The kinds of value that a cell in a spreadsheet can have.
                              "numberValue": 3.14, # Represents a double value.
                                  # Note: Dates, Times and DateTimes are represented as doubles in
                                  # "serial number" format.
                              "boolValue": True or False, # Represents a boolean value.
                              "formulaValue": "A String", # Represents a formula.
                              "stringValue": "A String", # Represents a string value.
                                  # Leading single quotes are not included. For example, if the user typed
                                  # `'123` into the UI, this would be represented as a `stringValue` of
                                  # `"123"`.
                              "errorValue": { # An error in a cell. # Represents an error.
                                  # This field is read-only.
                                "message": "A String", # A message with more information about the error
                                    # (in the spreadsheet's locale).
                                "type": "A String", # The type of error.
                              },
                            },
                          ],
                          "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                              # grouping should be sorted by.
                        },
                        "sortOrder": "A String", # The order the values in this group should be sorted.
                        "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                            #
                            # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                            # means this group refers to column `C`, whereas the offset `1` would refer
                            # to column `D`.
                      },
                    ],
                  },
                  "hyperlink": "A String", # A hyperlink this cell points to, if any.
                      # This field is read-only.  (To set it, use a `=HYPERLINK` formula.)
                  "effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be
                      # the calculated value.  For cells with literals, this will be
                      # the same as the user_entered_value.
                      # This field is read-only.
                    "numberValue": 3.14, # Represents a double value.
                        # Note: Dates, Times and DateTimes are represented as doubles in
                        # "serial number" format.
                    "boolValue": True or False, # Represents a boolean value.
                    "formulaValue": "A String", # Represents a formula.
                    "stringValue": "A String", # Represents a string value.
                        # Leading single quotes are not included. For example, if the user typed
                        # `'123` into the UI, this would be represented as a `stringValue` of
                        # `"123"`.
                    "errorValue": { # An error in a cell. # Represents an error.
                        # This field is read-only.
                      "message": "A String", # A message with more information about the error
                          # (in the spreadsheet's locale).
                      "type": "A String", # The type of error.
                    },
                  },
                  "formattedValue": "A String", # The formatted value of the cell.
                      # This is the value as it's shown to the user.
                      # This field is read-only.
                  "userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
                      # Note: Dates, Times and DateTimes are represented as doubles in
                      # serial number format.
                    "numberValue": 3.14, # Represents a double value.
                        # Note: Dates, Times and DateTimes are represented as doubles in
                        # "serial number" format.
                    "boolValue": True or False, # Represents a boolean value.
                    "formulaValue": "A String", # Represents a formula.
                    "stringValue": "A String", # Represents a string value.
                        # Leading single quotes are not included. For example, if the user typed
                        # `'123` into the UI, this would be represented as a `stringValue` of
                        # `"123"`.
                    "errorValue": { # An error in a cell. # Represents an error.
                        # This field is read-only.
                      "message": "A String", # A message with more information about the error
                          # (in the spreadsheet's locale).
                      "type": "A String", # The type of error.
                    },
                  },
                  "note": "A String", # Any note on the cell.
                  "effectiveFormat": { # The format of a cell. # The effective format being used by the cell.
                      # This includes the results of applying any conditional formatting and,
                      # if the cell contains a formula, the computed number format.
                      # If the effective format is the default format, effective format will
                      # not be written.
                      # This field is read-only.
                    "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                      "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                          # the user's locale will be used if necessary for the given type.
                          # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                          # information about the supported patterns.
                      "type": "A String", # The type of the number format.
                          # When writing, this field must be set.
                    },
                    "textDirection": "A String", # The direction of the text in the cell.
                    "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                        # When updating padding, every field must be specified.
                      "top": 42, # The top padding of the cell.
                      "right": 42, # The right padding of the cell.
                      "bottom": 42, # The bottom padding of the cell.
                      "left": 42, # The left padding of the cell.
                    },
                    "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                    "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                    "borders": { # The borders of the cell. # The borders of the cell.
                      "top": { # A border along a cell. # The top border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "right": { # A border along a cell. # The right border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "bottom": { # A border along a cell. # The bottom border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "left": { # A border along a cell. # The left border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                    },
                    "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                  },
                  "userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
                      #
                      # When writing, the new format will be merged with the existing format.
                    "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                      "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                          # the user's locale will be used if necessary for the given type.
                          # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                          # information about the supported patterns.
                      "type": "A String", # The type of the number format.
                          # When writing, this field must be set.
                    },
                    "textDirection": "A String", # The direction of the text in the cell.
                    "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                        # When updating padding, every field must be specified.
                      "top": 42, # The top padding of the cell.
                      "right": 42, # The right padding of the cell.
                      "bottom": 42, # The bottom padding of the cell.
                      "left": 42, # The left padding of the cell.
                    },
                    "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                    "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                    "borders": { # The borders of the cell. # The borders of the cell.
                      "top": { # A border along a cell. # The top border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "right": { # A border along a cell. # The right border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "bottom": { # A border along a cell. # The bottom border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                      "left": { # A border along a cell. # The left border of the cell.
                        "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "width": 42, # The width of the border, in pixels.
                            # Deprecated; the width is determined by the "style" field.
                        "style": "A String", # The style of the border.
                      },
                    },
                    "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                  },
                  "dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
                      #
                      # When writing, the new data validation rule will overwrite any prior rule.
                    "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                        # If true, "List" conditions will show a dropdown.
                    "strict": True or False, # True if invalid data should be rejected.
                    "inputMessage": "A String", # A message to show the user when adding data to the cell.
                    "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                        # BooleanConditions are used by conditional formatting,
                        # data validation, and the criteria in filters.
                      "type": "A String", # The type of condition.
                      "values": [ # The values of the condition. The number of supported values depends
                          # on the condition type.  Some support zero values,
                          # others one or two values,
                          # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                        { # The value of the condition.
                          "relativeDate": "A String", # A relative date (based on the current date).
                              # Valid only if the type is
                              # DATE_BEFORE,
                              # DATE_AFTER,
                              # DATE_ON_OR_BEFORE or
                              # DATE_ON_OR_AFTER.
                              #
                              # Relative dates are not supported in data validation.
                              # They are supported only in conditional formatting and
                              # conditional filters.
                          "userEnteredValue": "A String", # A value the condition is based on.
                              # The value will be parsed as if the user typed into a cell.
                              # Formulas are supported (and must begin with an `=`).
                        },
                      ],
                    },
                  },
                  "textFormatRuns": [ # Runs of rich text applied to subsections of the cell.  Runs are only valid
                      # on user entered strings, not formulas, bools, or numbers.
                      # Runs start at specific indexes in the text and continue until the next
                      # run. Properties of a run will continue unless explicitly changed
                      # in a subsequent run (and properties of the first run will continue
                      # the properties of the cell unless explicitly changed).
                      #
                      # When writing, the new runs will overwrite any prior runs.  When writing a
                      # new user_entered_value, previous runs will be erased.
                    { # A run of a text format. The format of this run continues until the start
                        # index of the next run.
                        # When updating, all fields must be set.
                      "startIndex": 42, # The character index where this run starts.
                      "format": { # The format of a run of text in a cell. # The format of this run.  Absent values inherit the cell's format.
                          # Absent values indicate that the field isn't specified.
                        "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # True if the text is bold.
                        "strikethrough": True or False, # True if the text has a strikethrough.
                        "fontFamily": "A String", # The font family.
                        "fontSize": 42, # The size of the font.
                        "italic": True or False, # True if the text is italicized.
                        "underline": True or False, # True if the text is underlined.
                      },
                    },
                  ],
                },
              ],
            },
          ],
          "start": { # A coordinate in a sheet. # The coordinate to start writing data at.
              # Any number of rows and columns (including a different number of
              # columns per row) may be written.
              # All indexes are zero-based.
            "rowIndex": 42, # The row index of the coordinate.
            "columnIndex": 42, # The column index of the coordinate.
            "sheetId": 42, # The sheet this coordinate is on.
          },
        },
        "autoFill": { # Fills in more data based on existing data. # Automatically fills in more data based on existing data.
          "useAlternateSeries": True or False, # True if we should generate data with the "alternate" series.
              # This differs based on the type and amount of source data.
          "range": { # A range on a sheet. # The range to autofill. This will examine the range and detect
              # the location that has data and automatically fill that data
              # in to the rest of the range.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "sourceAndDestination": { # A combination of a source range and how to extend that source. # The source and destination areas to autofill.
              # This explicitly lists the source of the autofill and where to
              # extend that data.
            "source": { # A range on a sheet. # The location of the data to use as the source of the autofill.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "dimension": "A String", # The dimension that data should be filled into.
            "fillLength": 42, # The number of rows or columns that data should be filled into.
                # Positive numbers expand beyond the last row or last column
                # of the source.  Negative numbers expand before the first row
                # or first column of the source.
          },
        },
        "appendDimension": { # Appends rows or columns to the end of a sheet. # Appends dimensions to the end of a sheet.
          "length": 42, # The number of rows or columns to append.
          "sheetId": 42, # The sheet to append rows or columns to.
          "dimension": "A String", # Whether rows or columns should be appended.
        },
        "autoResizeDimensions": { # Automatically resizes one or more dimensions based on the contents # Automatically resizes one or more dimensions based on the contents
            # of the cells in that dimension.
            # of the cells in that dimension.
          "dimensions": { # A range along a single dimension on a sheet. # The dimensions to automatically resize.
              # Only COLUMNS are supported.
              # All indexes are zero-based.
              # Indexes are half open: the start index is inclusive
              # and the end index is exclusive.
              # Missing indexes indicate the range is unbounded on that side.
            "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
            "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
            "sheetId": 42, # The sheet this span is on.
            "dimension": "A String", # The dimension of the span.
          },
        },
        "updateDimensionProperties": { # Updates properties of dimensions within the specified range. # Updates dimensions' properties.
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root `properties` is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "range": { # A range along a single dimension on a sheet. # The rows or columns to update.
              # All indexes are zero-based.
              # Indexes are half open: the start index is inclusive
              # and the end index is exclusive.
              # Missing indexes indicate the range is unbounded on that side.
            "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
            "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
            "sheetId": 42, # The sheet this span is on.
            "dimension": "A String", # The dimension of the span.
          },
          "properties": { # Properties about a dimension. # Properties to update.
            "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
            "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
            "hiddenByFilter": True or False, # True if this dimension is being filtered.
                # This field is read-only.
          },
        },
        "unmergeCells": { # Unmerges cells in the given range. # Unmerges merged cells.
          "range": { # A range on a sheet. # The range within which all cells should be unmerged.
              # If the range spans multiple merges, all will be unmerged.
              # The range must not partially span any merge.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
        },
        "setDataValidation": { # Sets a data validation rule to every cell in the range. # Sets data validation for one or more cells.
            # To clear validation in a range, call this with no rule specified.
          "range": { # A range on a sheet. # The range the data validation rule should apply to.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "rule": { # A data validation rule. # The data validation rule to set on each cell in the range,
              # or empty to clear the data validation in the range.
            "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                # If true, "List" conditions will show a dropdown.
            "strict": True or False, # True if invalid data should be rejected.
            "inputMessage": "A String", # A message to show the user when adding data to the cell.
            "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                # BooleanConditions are used by conditional formatting,
                # data validation, and the criteria in filters.
              "type": "A String", # The type of condition.
              "values": [ # The values of the condition. The number of supported values depends
                  # on the condition type.  Some support zero values,
                  # others one or two values,
                  # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                { # The value of the condition.
                  "relativeDate": "A String", # A relative date (based on the current date).
                      # Valid only if the type is
                      # DATE_BEFORE,
                      # DATE_AFTER,
                      # DATE_ON_OR_BEFORE or
                      # DATE_ON_OR_AFTER.
                      #
                      # Relative dates are not supported in data validation.
                      # They are supported only in conditional formatting and
                      # conditional filters.
                  "userEnteredValue": "A String", # A value the condition is based on.
                      # The value will be parsed as if the user typed into a cell.
                      # Formulas are supported (and must begin with an `=`).
                },
              ],
            },
          },
        },
        "clearBasicFilter": { # Clears the basic filter, if any exists on the sheet. # Clears the basic filter on a sheet.
          "sheetId": 42, # The sheet ID on which the basic filter should be cleared.
        },
        "addNamedRange": { # Adds a named range to the spreadsheet. # Adds a named range.
          "namedRange": { # A named range. # The named range to add. The namedRangeId
              # field is optional; if one is not set, an id will be randomly generated. (It
              # is an error to specify the ID of a range that already exists.)
            "namedRangeId": "A String", # The ID of the named range.
            "range": { # A range on a sheet. # The range this represents.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "name": "A String", # The name of the named range.
          },
        },
        "updateChartSpec": { # Updates a chart's specifications. # Updates a chart's specifications.
            # (This does not move or resize a chart. To move or resize a chart, use
            #  UpdateEmbeddedObjectPositionRequest.)
          "chartId": 42, # The ID of the chart to update.
          "spec": { # The specifications of a chart. # The specification to apply to the chart.
            "hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.
            "pieChart": { # A pie chart. # A pie chart specification.
              "series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.
                "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                  "sources": [ # The ranges of data for a series or domain.
                      # Exactly one dimension must have a length of 1,
                      # and all sources in the list must have the same dimension
                      # with length 1.
                      # The domain (if it exists) & all series must have the same number
                      # of source ranges. If using more than one source range, then the source
                      # range at a given offset must be contiguous across the domain and series.
                      #
                      # For example, these are valid configurations:
                      #
                      #     domain sources: A1:A5
                      #     series1 sources: B1:B5
                      #     series2 sources: D6:D10
                      #
                      #     domain sources: A1:A5, C10:C12
                      #     series1 sources: B1:B5, D10:D12
                      #     series2 sources: C1:C5, E10:E12
                    { # A range on a sheet.
                        # All indexes are zero-based.
                        # Indexes are half open, e.g the start index is inclusive
                        # and the end index is exclusive -- [start_index, end_index).
                        # Missing indexes indicate the range is unbounded on that side.
                        #
                        # For example, if `"Sheet1"` is sheet ID 0, then:
                        #
                        #   `Sheet1!A1:A1 == sheet_id: 0,
                        #                   start_row_index: 0, end_row_index: 1,
                        #                   start_column_index: 0, end_column_index: 1`
                        #
                        #   `Sheet1!A3:B4 == sheet_id: 0,
                        #                   start_row_index: 2, end_row_index: 4,
                        #                   start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A:B == sheet_id: 0,
                        #                 start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A5:B == sheet_id: 0,
                        #                  start_row_index: 4,
                        #                  start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1 == sheet_id:0`
                        #
                        # The start index must always be less than or equal to the end index.
                        # If the start index equals the end index, then the range is empty.
                        # Empty ranges are typically not meaningful and are usually rendered in the
                        # UI as `#REF!`.
                      "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                      "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                      "sheetId": 42, # The sheet this range is on.
                      "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                      "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                    },
                  ],
                },
              },
              "domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.
                "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                  "sources": [ # The ranges of data for a series or domain.
                      # Exactly one dimension must have a length of 1,
                      # and all sources in the list must have the same dimension
                      # with length 1.
                      # The domain (if it exists) & all series must have the same number
                      # of source ranges. If using more than one source range, then the source
                      # range at a given offset must be contiguous across the domain and series.
                      #
                      # For example, these are valid configurations:
                      #
                      #     domain sources: A1:A5
                      #     series1 sources: B1:B5
                      #     series2 sources: D6:D10
                      #
                      #     domain sources: A1:A5, C10:C12
                      #     series1 sources: B1:B5, D10:D12
                      #     series2 sources: C1:C5, E10:E12
                    { # A range on a sheet.
                        # All indexes are zero-based.
                        # Indexes are half open, e.g the start index is inclusive
                        # and the end index is exclusive -- [start_index, end_index).
                        # Missing indexes indicate the range is unbounded on that side.
                        #
                        # For example, if `"Sheet1"` is sheet ID 0, then:
                        #
                        #   `Sheet1!A1:A1 == sheet_id: 0,
                        #                   start_row_index: 0, end_row_index: 1,
                        #                   start_column_index: 0, end_column_index: 1`
                        #
                        #   `Sheet1!A3:B4 == sheet_id: 0,
                        #                   start_row_index: 2, end_row_index: 4,
                        #                   start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A:B == sheet_id: 0,
                        #                 start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1!A5:B == sheet_id: 0,
                        #                  start_row_index: 4,
                        #                  start_column_index: 0, end_column_index: 2`
                        #
                        #   `Sheet1 == sheet_id:0`
                        #
                        # The start index must always be less than or equal to the end index.
                        # If the start index equals the end index, then the range is empty.
                        # Empty ranges are typically not meaningful and are usually rendered in the
                        # UI as `#REF!`.
                      "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                      "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                      "sheetId": 42, # The sheet this range is on.
                      "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                      "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                    },
                  ],
                },
              },
              "threeDimensional": True or False, # True if the pie is three dimensional.
              "legendPosition": "A String", # Where the legend of the pie chart should be drawn.
              "pieHole": 3.14, # The size of the hole in the pie chart.
            },
            "basicChart": { # The specification for a basic chart.  See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.
                # See BasicChartType for the list of all
                # charts this supports.
                # of charts this supports.
              "headerCount": 42, # The number of rows or columns in the data that are "headers".
                  # If not set, Google Sheets will guess how many rows are headers based
                  # on the data.
                  #
                  # (Note that BasicChartAxis.title may override the axis title
                  #  inferred from the header values.)
              "series": [ # The data this chart is visualizing.
                { # A single series of data in a chart.
                    # For example, if charting stock prices over time, multiple series may exist,
                    # one for the "Open Price", "High Price", "Low Price" and "Close Price".
                  "series": { # The data included in a domain or series. # The data being visualized in this chart series.
                    "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                      "sources": [ # The ranges of data for a series or domain.
                          # Exactly one dimension must have a length of 1,
                          # and all sources in the list must have the same dimension
                          # with length 1.
                          # The domain (if it exists) & all series must have the same number
                          # of source ranges. If using more than one source range, then the source
                          # range at a given offset must be contiguous across the domain and series.
                          #
                          # For example, these are valid configurations:
                          #
                          #     domain sources: A1:A5
                          #     series1 sources: B1:B5
                          #     series2 sources: D6:D10
                          #
                          #     domain sources: A1:A5, C10:C12
                          #     series1 sources: B1:B5, D10:D12
                          #     series2 sources: C1:C5, E10:E12
                        { # A range on a sheet.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                      ],
                    },
                  },
                  "targetAxis": "A String", # The minor axis that will specify the range of values for this series.
                      # For example, if charting stocks over time, the "Volume" series
                      # may want to be pinned to the right with the prices pinned to the left,
                      # because the scale of trading volume is different than the scale of
                      # prices.
                      # It is an error to specify an axis that isn't a valid minor axis
                      # for the chart's type.
                  "type": "A String", # The type of this series. Valid only if the
                      # chartType is
                      # COMBO.
                      # Different types will change the way the series is visualized.
                      # Only LINE, AREA,
                      # and COLUMN are supported.
                },
              ],
              "legendPosition": "A String", # The position of the chart legend.
              "domains": [ # The domain of data this is charting.
                  # Only a single domain is currently supported.
                { # The domain of a chart.
                    # For example, if charting stock prices over time, this would be the date.
                  "domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,
                      # this is the data representing the dates.
                    "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                      "sources": [ # The ranges of data for a series or domain.
                          # Exactly one dimension must have a length of 1,
                          # and all sources in the list must have the same dimension
                          # with length 1.
                          # The domain (if it exists) & all series must have the same number
                          # of source ranges. If using more than one source range, then the source
                          # range at a given offset must be contiguous across the domain and series.
                          #
                          # For example, these are valid configurations:
                          #
                          #     domain sources: A1:A5
                          #     series1 sources: B1:B5
                          #     series2 sources: D6:D10
                          #
                          #     domain sources: A1:A5, C10:C12
                          #     series1 sources: B1:B5, D10:D12
                          #     series2 sources: C1:C5, E10:E12
                        { # A range on a sheet.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                      ],
                    },
                  },
                },
              ],
              "chartType": "A String", # The type of the chart.
              "axis": [ # The axis on the chart.
                { # An axis of the chart.
                    # A chart may not have more than one axis per
                    # axis position.
                  "position": "A String", # The position of this axis.
                  "format": { # The format of a run of text in a cell. # The format of the title.
                      # Only valid if the axis is not associated with the domain.
                      # Absent values indicate that the field isn't specified.
                    "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # True if the text is bold.
                    "strikethrough": True or False, # True if the text has a strikethrough.
                    "fontFamily": "A String", # The font family.
                    "fontSize": 42, # The size of the font.
                    "italic": True or False, # True if the text is italicized.
                    "underline": True or False, # True if the text is underlined.
                  },
                  "title": "A String", # The title of this axis. If set, this overrides any title inferred
                      # from headers of the data.
                },
              ],
            },
            "title": "A String", # The title of the chart.
          },
        },
        "moveDimension": { # Moves one or more rows or columns. # Moves rows or columns to another location in a sheet.
          "source": { # A range along a single dimension on a sheet. # The source dimensions to move.
              # All indexes are zero-based.
              # Indexes are half open: the start index is inclusive
              # and the end index is exclusive.
              # Missing indexes indicate the range is unbounded on that side.
            "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
            "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
            "sheetId": 42, # The sheet this span is on.
            "dimension": "A String", # The dimension of the span.
          },
          "destinationIndex": 42, # The zero-based start index of where to move the source data to,
              # based on the coordinates *before* the source data is removed
              # from the grid.  Existing data will be shifted down or right
              # (depending on the dimension) to make room for the moved dimensions.
              # The source dimensions are removed from the grid, so the
              # the data may end up in a different index than specified.
              #
              # For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move
              # `"1"` and `"2"` to between `"3"` and `"4"`, the source would be
              # `ROWS [1..3)`,and the destination index would be `"4"`
              # (the zero-based index of row 5).
              # The end result would be `A1..A5` of `0, 3, 1, 2, 4`.
        },
        "textToColumns": { # Splits a column of text into multiple columns, # Converts a column of text into many columns of text.
            # based on a delimiter in each cell.
          "source": { # A range on a sheet. # The source data range.  This must span exactly one column.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "delimiter": "A String", # The delimiter to use. Used only if delimiterType is
              # CUSTOM.
          "delimiterType": "A String", # The delimiter type to use.
        },
        "deleteFilterView": { # Deletes a particular filter view. # Deletes a filter view from a sheet.
          "filterId": 42, # The ID of the filter to delete.
        },
        "mergeCells": { # Merges all cells in the range. # Merges cells together.
          "range": { # A range on a sheet. # The range of cells to merge.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "mergeType": "A String", # How the cells should be merged.
        },
        "deleteProtectedRange": { # Deletes the protected range with the given ID. # Deletes a protected range.
          "protectedRangeId": 42, # The ID of the protected range to delete.
        },
        "addFilterView": { # Adds a filter view. # Adds a filter view.
          "filter": { # A filter view. # The filter to add. The filterViewId
              # field is optional; if one is not set, an id will be randomly generated. (It
              # is an error to specify the ID of a filter that already exists.)
            "title": "A String", # The name of the filter view.
            "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "filterViewId": 42, # The ID of the filter view.
            "range": { # A range on a sheet. # The range this filter view covers.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
        },
        "deleteSheet": { # Deletes the requested sheet. # Deletes a sheet.
          "sheetId": 42, # The ID of the sheet to delete.
        },
        "updateBorders": { # Updates the borders of a range. # Updates the borders in a range of cells.
            # If a field is not set in the request, that means the border remains as-is.
            # For example, with two subsequent UpdateBordersRequest:
            #
            #  1. range: A1:A5 `{ top: RED, bottom: WHITE }`
            #  2. range: A1:A5 `{ left: BLUE }`
            #
            # That would result in A1:A5 having a borders of
            # `{ top: RED, bottom: WHITE, left: BLUE }`.
            # If you want to clear a border, explicitly set the style to
            # NONE.
          "right": { # A border along a cell. # The border to put at the right of the range.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "bottom": { # A border along a cell. # The border to put at the bottom of the range.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "top": { # A border along a cell. # The border to put at the top of the range.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "innerHorizontal": { # A border along a cell. # The horizontal border to put within the range.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "range": { # A range on a sheet. # The range whose borders should be updated.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "innerVertical": { # A border along a cell. # The vertical border to put within the range.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "left": { # A border along a cell. # The border to put at the left of the range.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
        },
        "cutPaste": { # Moves data from the source to the destination. # Cuts data from one area and pastes it to another.
          "pasteType": "A String", # What kind of data to paste.  All the source data will be cut, regardless
              # of what is pasted.
          "source": { # A range on a sheet. # The source data to cut.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "destination": { # A coordinate in a sheet. # The top-left coordinate where the data should be pasted.
              # All indexes are zero-based.
            "rowIndex": 42, # The row index of the coordinate.
            "columnIndex": 42, # The column index of the coordinate.
            "sheetId": 42, # The sheet this coordinate is on.
          },
        },
        "copyPaste": { # Copies data from the source to the destination. # Copies data from one area and pastes it to another.
          "pasteType": "A String", # What kind of data to paste.
          "source": { # A range on a sheet. # The source range to copy.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "destination": { # A range on a sheet. # The location to paste to. If the range covers a span that's
              # a multiple of the source's height or width, then the
              # data will be repeated to fill in the destination range.
              # If the range is smaller than the source range, the entire
              # source data will still be copied (beyond the end of the destination range).
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "pasteOrientation": "A String", # How that data should be oriented when pasting.
        },
        "addSheet": { # Adds a new sheet. # Adds a sheet.
            # When a sheet is added at a given index,
            # all subsequent sheets' indexes are incremented.
            # To add an object sheet, use AddChartRequest instead and specify
            # EmbeddedObjectPosition.sheetId or
            # EmbeddedObjectPosition.newSheet.
          "properties": { # Properties of a sheet. # The properties the new sheet should have.
              # All properties are optional.
              # The sheetId field is optional; if one is not
              # set, an id will be randomly generated. (It is an error to specify the ID
              # of a sheet that already exists.)
            "sheetType": "A String", # The type of sheet. Defaults to GRID.
                # This field cannot be changed once set.
            "index": 42, # The index of the sheet within the spreadsheet.
                # When adding or updating sheet properties, if this field
                # is excluded then the sheet will be added or moved to the end
                # of the sheet list.
            "title": "A String", # The name of the sheet.
            "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
                # (If the sheet is an object sheet, containing a chart or image, then
                # this field will be absent.)
                # When writing it is an error to set any grid properties on non-grid sheets.
              "columnCount": 42, # The number of columns in the grid.
              "rowCount": 42, # The number of rows in the grid.
              "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
              "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
              "frozenRowCount": 42, # The number of rows that are frozen in the grid.
            },
            "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
            "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
            "sheetId": 42, # The ID of the sheet. Must be non-negative.
                # This field cannot be changed once set.
          },
        },
        "deleteNamedRange": { # Removes the named range with the given ID from the spreadsheet. # Deletes a named range.
          "namedRangeId": "A String", # The ID of the named range to delete.
        },
        "updateNamedRange": { # Updates properties of the named range with the specified # Updates a named range.
            # namedRangeId.
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root `namedRange` is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
          "namedRange": { # A named range. # The named range to update with the new properties.
            "namedRangeId": "A String", # The ID of the named range.
            "range": { # A range on a sheet. # The range this represents.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "name": "A String", # The name of the named range.
          },
        },
        "insertDimension": { # Inserts rows or columns in a sheet at a particular index. # Inserts new rows or columns in a sheet.
          "inheritFromBefore": True or False, # Whether dimension properties should be extended from the dimensions
              # before or after the newly inserted dimensions.
              # True to inherit from the dimensions before (in which case the start
              # index must be greater than 0), and false to inherit from the dimensions
              # after.
              #
              # For example, if row index 0 has red background and row index 1
              # has a green background, then inserting 2 rows at index 1 can inherit
              # either the green or red background.  If `inheritFromBefore` is true,
              # the two new rows will be red (because the row before the insertion point
              # was red), whereas if `inheritFromBefore` is false, the two new rows will
              # be green (because the row after the insertion point was green).
          "range": { # A range along a single dimension on a sheet. # The dimensions to insert.  Both the start and end indexes must be bounded.
              # All indexes are zero-based.
              # Indexes are half open: the start index is inclusive
              # and the end index is exclusive.
              # Missing indexes indicate the range is unbounded on that side.
            "endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.
            "startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.
            "sheetId": 42, # The sheet this span is on.
            "dimension": "A String", # The dimension of the span.
          },
        },
        "updateFilterView": { # Updates properties of the filter view. # Updates the properties of a filter view.
          "filter": { # A filter view. # The new properties of the filter view.
            "title": "A String", # The name of the filter view.
            "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "filterViewId": 42, # The ID of the filter view.
            "range": { # A range on a sheet. # The range this filter view covers.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
          "fields": "A String", # The fields that should be updated.  At least one field must be specified.
              # The root `filter` is implied and should not be specified.
              # A single `"*"` can be used as short-hand for listing every field.
        },
        "deleteConditionalFormatRule": { # Deletes a conditional format rule at the given index. # Deletes an existing conditional format rule.
            # All subsequent rules' indexes are decremented.
          "index": 42, # The zero-based index of the rule to be deleted.
          "sheetId": 42, # The sheet the rule is being deleted from.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The reply for batch updating a spreadsheet.
    "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
    "replies": [ # The reply of the updates.  This maps 1:1 with the updates, although
        # replies to some requests may be empty.
      { # A single response from an update.
        "duplicateFilterView": { # The result of a filter view being duplicated. # A reply from duplicating a filter view.
          "filter": { # A filter view. # The newly created filter.
            "title": "A String", # The name of the filter view.
            "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "filterViewId": 42, # The ID of the filter view.
            "range": { # A range on a sheet. # The range this filter view covers.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
        },
        "duplicateSheet": { # The result of duplicating a sheet. # A reply from duplicating a sheet.
          "properties": { # Properties of a sheet. # The properties of the duplicate sheet.
            "sheetType": "A String", # The type of sheet. Defaults to GRID.
                # This field cannot be changed once set.
            "index": 42, # The index of the sheet within the spreadsheet.
                # When adding or updating sheet properties, if this field
                # is excluded then the sheet will be added or moved to the end
                # of the sheet list.
            "title": "A String", # The name of the sheet.
            "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
                # (If the sheet is an object sheet, containing a chart or image, then
                # this field will be absent.)
                # When writing it is an error to set any grid properties on non-grid sheets.
              "columnCount": 42, # The number of columns in the grid.
              "rowCount": 42, # The number of rows in the grid.
              "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
              "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
              "frozenRowCount": 42, # The number of rows that are frozen in the grid.
            },
            "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
            "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
            "sheetId": 42, # The ID of the sheet. Must be non-negative.
                # This field cannot be changed once set.
          },
        },
        "updateEmbeddedObjectPosition": { # The result of updating an embedded object's position. # A reply from updating an embedded object's position.
          "position": { # The position of an embedded object such as a chart. # The new position of the embedded object.
            "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                # is chosen for you. Used only when writing.
            "sheetId": 42, # The sheet this is on. Set only if the embedded object
                # is on its own sheet. Must be non-negative.
            "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
              "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                  # All indexes are zero-based.
                "rowIndex": 42, # The row index of the coordinate.
                "columnIndex": 42, # The column index of the coordinate.
                "sheetId": 42, # The sheet this coordinate is on.
              },
              "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                  # from the anchor cell.
              "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
              "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                  # from the anchor cell.
              "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
            },
          },
        },
        "addChart": { # The result of adding a chart to a spreadsheet. # A reply from adding a chart.
          "chart": { # A chart embedded in a sheet. # The newly added chart.
            "chartId": 42, # The ID of the chart.
            "position": { # The position of an embedded object such as a chart. # The position of the chart.
              "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                  # is chosen for you. Used only when writing.
              "sheetId": 42, # The sheet this is on. Set only if the embedded object
                  # is on its own sheet. Must be non-negative.
              "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
                "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                    # All indexes are zero-based.
                  "rowIndex": 42, # The row index of the coordinate.
                  "columnIndex": 42, # The column index of the coordinate.
                  "sheetId": 42, # The sheet this coordinate is on.
                },
                "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                    # from the anchor cell.
                "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
                "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                    # from the anchor cell.
                "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
              },
            },
            "spec": { # The specifications of a chart. # The specification of the chart.
              "hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.
              "pieChart": { # A pie chart. # A pie chart specification.
                "series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.
                  "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                    "sources": [ # The ranges of data for a series or domain.
                        # Exactly one dimension must have a length of 1,
                        # and all sources in the list must have the same dimension
                        # with length 1.
                        # The domain (if it exists) & all series must have the same number
                        # of source ranges. If using more than one source range, then the source
                        # range at a given offset must be contiguous across the domain and series.
                        #
                        # For example, these are valid configurations:
                        #
                        #     domain sources: A1:A5
                        #     series1 sources: B1:B5
                        #     series2 sources: D6:D10
                        #
                        #     domain sources: A1:A5, C10:C12
                        #     series1 sources: B1:B5, D10:D12
                        #     series2 sources: C1:C5, E10:E12
                      { # A range on a sheet.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                    ],
                  },
                },
                "domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.
                  "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                    "sources": [ # The ranges of data for a series or domain.
                        # Exactly one dimension must have a length of 1,
                        # and all sources in the list must have the same dimension
                        # with length 1.
                        # The domain (if it exists) & all series must have the same number
                        # of source ranges. If using more than one source range, then the source
                        # range at a given offset must be contiguous across the domain and series.
                        #
                        # For example, these are valid configurations:
                        #
                        #     domain sources: A1:A5
                        #     series1 sources: B1:B5
                        #     series2 sources: D6:D10
                        #
                        #     domain sources: A1:A5, C10:C12
                        #     series1 sources: B1:B5, D10:D12
                        #     series2 sources: C1:C5, E10:E12
                      { # A range on a sheet.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                    ],
                  },
                },
                "threeDimensional": True or False, # True if the pie is three dimensional.
                "legendPosition": "A String", # Where the legend of the pie chart should be drawn.
                "pieHole": 3.14, # The size of the hole in the pie chart.
              },
              "basicChart": { # The specification for a basic chart.  See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.
                  # See BasicChartType for the list of all
                  # charts this supports.
                  # of charts this supports.
                "headerCount": 42, # The number of rows or columns in the data that are "headers".
                    # If not set, Google Sheets will guess how many rows are headers based
                    # on the data.
                    #
                    # (Note that BasicChartAxis.title may override the axis title
                    #  inferred from the header values.)
                "series": [ # The data this chart is visualizing.
                  { # A single series of data in a chart.
                      # For example, if charting stock prices over time, multiple series may exist,
                      # one for the "Open Price", "High Price", "Low Price" and "Close Price".
                    "series": { # The data included in a domain or series. # The data being visualized in this chart series.
                      "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                        "sources": [ # The ranges of data for a series or domain.
                            # Exactly one dimension must have a length of 1,
                            # and all sources in the list must have the same dimension
                            # with length 1.
                            # The domain (if it exists) & all series must have the same number
                            # of source ranges. If using more than one source range, then the source
                            # range at a given offset must be contiguous across the domain and series.
                            #
                            # For example, these are valid configurations:
                            #
                            #     domain sources: A1:A5
                            #     series1 sources: B1:B5
                            #     series2 sources: D6:D10
                            #
                            #     domain sources: A1:A5, C10:C12
                            #     series1 sources: B1:B5, D10:D12
                            #     series2 sources: C1:C5, E10:E12
                          { # A range on a sheet.
                              # All indexes are zero-based.
                              # Indexes are half open, e.g the start index is inclusive
                              # and the end index is exclusive -- [start_index, end_index).
                              # Missing indexes indicate the range is unbounded on that side.
                              #
                              # For example, if `"Sheet1"` is sheet ID 0, then:
                              #
                              #   `Sheet1!A1:A1 == sheet_id: 0,
                              #                   start_row_index: 0, end_row_index: 1,
                              #                   start_column_index: 0, end_column_index: 1`
                              #
                              #   `Sheet1!A3:B4 == sheet_id: 0,
                              #                   start_row_index: 2, end_row_index: 4,
                              #                   start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A:B == sheet_id: 0,
                              #                 start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A5:B == sheet_id: 0,
                              #                  start_row_index: 4,
                              #                  start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1 == sheet_id:0`
                              #
                              # The start index must always be less than or equal to the end index.
                              # If the start index equals the end index, then the range is empty.
                              # Empty ranges are typically not meaningful and are usually rendered in the
                              # UI as `#REF!`.
                            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                            "sheetId": 42, # The sheet this range is on.
                            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                          },
                        ],
                      },
                    },
                    "targetAxis": "A String", # The minor axis that will specify the range of values for this series.
                        # For example, if charting stocks over time, the "Volume" series
                        # may want to be pinned to the right with the prices pinned to the left,
                        # because the scale of trading volume is different than the scale of
                        # prices.
                        # It is an error to specify an axis that isn't a valid minor axis
                        # for the chart's type.
                    "type": "A String", # The type of this series. Valid only if the
                        # chartType is
                        # COMBO.
                        # Different types will change the way the series is visualized.
                        # Only LINE, AREA,
                        # and COLUMN are supported.
                  },
                ],
                "legendPosition": "A String", # The position of the chart legend.
                "domains": [ # The domain of data this is charting.
                    # Only a single domain is currently supported.
                  { # The domain of a chart.
                      # For example, if charting stock prices over time, this would be the date.
                    "domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,
                        # this is the data representing the dates.
                      "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                        "sources": [ # The ranges of data for a series or domain.
                            # Exactly one dimension must have a length of 1,
                            # and all sources in the list must have the same dimension
                            # with length 1.
                            # The domain (if it exists) & all series must have the same number
                            # of source ranges. If using more than one source range, then the source
                            # range at a given offset must be contiguous across the domain and series.
                            #
                            # For example, these are valid configurations:
                            #
                            #     domain sources: A1:A5
                            #     series1 sources: B1:B5
                            #     series2 sources: D6:D10
                            #
                            #     domain sources: A1:A5, C10:C12
                            #     series1 sources: B1:B5, D10:D12
                            #     series2 sources: C1:C5, E10:E12
                          { # A range on a sheet.
                              # All indexes are zero-based.
                              # Indexes are half open, e.g the start index is inclusive
                              # and the end index is exclusive -- [start_index, end_index).
                              # Missing indexes indicate the range is unbounded on that side.
                              #
                              # For example, if `"Sheet1"` is sheet ID 0, then:
                              #
                              #   `Sheet1!A1:A1 == sheet_id: 0,
                              #                   start_row_index: 0, end_row_index: 1,
                              #                   start_column_index: 0, end_column_index: 1`
                              #
                              #   `Sheet1!A3:B4 == sheet_id: 0,
                              #                   start_row_index: 2, end_row_index: 4,
                              #                   start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A:B == sheet_id: 0,
                              #                 start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A5:B == sheet_id: 0,
                              #                  start_row_index: 4,
                              #                  start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1 == sheet_id:0`
                              #
                              # The start index must always be less than or equal to the end index.
                              # If the start index equals the end index, then the range is empty.
                              # Empty ranges are typically not meaningful and are usually rendered in the
                              # UI as `#REF!`.
                            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                            "sheetId": 42, # The sheet this range is on.
                            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                          },
                        ],
                      },
                    },
                  },
                ],
                "chartType": "A String", # The type of the chart.
                "axis": [ # The axis on the chart.
                  { # An axis of the chart.
                      # A chart may not have more than one axis per
                      # axis position.
                    "position": "A String", # The position of this axis.
                    "format": { # The format of a run of text in a cell. # The format of the title.
                        # Only valid if the axis is not associated with the domain.
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "title": "A String", # The title of this axis. If set, this overrides any title inferred
                        # from headers of the data.
                  },
                ],
              },
              "title": "A String", # The title of the chart.
            },
          },
        },
        "updateConditionalFormatRule": { # The result of updating a conditional format rule. # A reply from updating a conditional format rule.
          "oldIndex": 42, # The old index of the rule. Not set if a rule was replaced
              # (because it is the same as new_index).
          "newIndex": 42, # The index of the new rule.
          "oldRule": { # A rule describing a conditional format. # The old (deleted) rule. Not set if a rule was moved
              # (because it is the same as new_rule).
            "ranges": [ # The ranges that will be formatted if the condition is true.
                # All the ranges must be on the same grid.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
              "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                  # the format will be applied.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
              "format": { # The format of a cell. # The format to apply.
                  # Conditional formatting can only apply a subset of formatting:
                  # bold, italic,
                  # strikethrough,
                  # foreground color &
                  # background color.
                "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                  "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                      # the user's locale will be used if necessary for the given type.
                      # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                      # information about the supported patterns.
                  "type": "A String", # The type of the number format.
                      # When writing, this field must be set.
                },
                "textDirection": "A String", # The direction of the text in the cell.
                "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                    # When updating padding, every field must be specified.
                  "top": 42, # The top padding of the cell.
                  "right": 42, # The right padding of the cell.
                  "bottom": 42, # The bottom padding of the cell.
                  "left": 42, # The left padding of the cell.
                },
                "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
                "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                "borders": { # The borders of the cell. # The borders of the cell.
                  "top": { # A border along a cell. # The top border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "right": { # A border along a cell. # The right border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "bottom": { # A border along a cell. # The bottom border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "left": { # A border along a cell. # The left border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                },
                "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
              },
            },
            "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                # the interpolation points listed. The format of a cell will vary
                # based on its contents as compared to the values of the interpolation
                # points.
              "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
            },
          },
          "newRule": { # A rule describing a conditional format. # The new rule that replaced the old rule (if replacing),
              # or the rule that was moved (if moved)
            "ranges": [ # The ranges that will be formatted if the condition is true.
                # All the ranges must be on the same grid.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
              "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                  # the format will be applied.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
              "format": { # The format of a cell. # The format to apply.
                  # Conditional formatting can only apply a subset of formatting:
                  # bold, italic,
                  # strikethrough,
                  # foreground color &
                  # background color.
                "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                  "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                      # the user's locale will be used if necessary for the given type.
                      # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                      # information about the supported patterns.
                  "type": "A String", # The type of the number format.
                      # When writing, this field must be set.
                },
                "textDirection": "A String", # The direction of the text in the cell.
                "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                    # When updating padding, every field must be specified.
                  "top": 42, # The top padding of the cell.
                  "right": 42, # The right padding of the cell.
                  "bottom": 42, # The bottom padding of the cell.
                  "left": 42, # The left padding of the cell.
                },
                "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
                "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                "borders": { # The borders of the cell. # The borders of the cell.
                  "top": { # A border along a cell. # The top border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "right": { # A border along a cell. # The right border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "bottom": { # A border along a cell. # The bottom border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "left": { # A border along a cell. # The left border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                },
                "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
              },
            },
            "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                # the interpolation points listed. The format of a cell will vary
                # based on its contents as compared to the values of the interpolation
                # points.
              "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
            },
          },
        },
        "addSheet": { # The result of adding a sheet. # A reply from adding a sheet.
          "properties": { # Properties of a sheet. # The properties of the newly added sheet.
            "sheetType": "A String", # The type of sheet. Defaults to GRID.
                # This field cannot be changed once set.
            "index": 42, # The index of the sheet within the spreadsheet.
                # When adding or updating sheet properties, if this field
                # is excluded then the sheet will be added or moved to the end
                # of the sheet list.
            "title": "A String", # The name of the sheet.
            "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
                # (If the sheet is an object sheet, containing a chart or image, then
                # this field will be absent.)
                # When writing it is an error to set any grid properties on non-grid sheets.
              "columnCount": 42, # The number of columns in the grid.
              "rowCount": 42, # The number of rows in the grid.
              "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
              "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
              "frozenRowCount": 42, # The number of rows that are frozen in the grid.
            },
            "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
            "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
            "sheetId": 42, # The ID of the sheet. Must be non-negative.
                # This field cannot be changed once set.
          },
        },
        "findReplace": { # The result of the find/replace. # A reply from doing a find/replace.
          "occurrencesChanged": 42, # The number of occurrences (possibly multiple within a cell) changed.
              # For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would
              # be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.
          "sheetsChanged": 42, # The number of sheets changed.
          "rowsChanged": 42, # The number of rows changed.
          "valuesChanged": 42, # The number of non-formula cells changed.
          "formulasChanged": 42, # The number of formula cells changed.
        },
        "addNamedRange": { # The result of adding a named range. # A reply from adding a named range.
          "namedRange": { # A named range. # The named range to add.
            "namedRangeId": "A String", # The ID of the named range.
            "range": { # A range on a sheet. # The range this represents.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "name": "A String", # The name of the named range.
          },
        },
        "addProtectedRange": { # The result of adding a new protected range. # A reply from adding a protected range.
          "protectedRange": { # A protected range. # The newly added protected range.
            "unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.
                # Unprotected ranges are only supported on protected sheets.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the
                # protected area.
                # This field is read-only.
            "description": "A String", # The description of this protected range.
            "namedRangeId": "A String", # The named range this protected range is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.
                # This field is only visible to users with edit access to the protected
                # range and the document.
                # Editors are not supported with warning_only protection.
              "domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected
                  # range.  Domain protection is only supported on documents within a domain.
              "users": [ # The email addresses of users with edit access to the protected range.
                "A String",
              ],
              "groups": [ # The email addresses of groups with edit access to the protected range.
                "A String",
              ],
            },
            "protectedRangeId": 42, # The ID of the protected range.
                # This field is read-only.
            "warningOnly": True or False, # True if this protected range will show a warning when editing.
                # Warning-based protection means that every user can edit data in the
                # protected range, except editing will prompt a warning asking the user
                # to confirm the edit.
                #
                # When writing: if this field is true, then editors is ignored.
                # Additionally, if this field is changed from true to false and the
                # `editors` field is not set (nor included in the field mask), then
                # the editors will be set to all the editors in the document.
            "range": { # A range on a sheet. # The range that is being protected.
                # The range may be fully unbounded, in which case this is considered
                # a protected sheet.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
          },
        },
        "deleteConditionalFormatRule": { # The result of deleting a conditional format rule. # A reply from deleting a conditional format rule.
          "rule": { # A rule describing a conditional format. # The rule that was deleted.
            "ranges": [ # The ranges that will be formatted if the condition is true.
                # All the ranges must be on the same grid.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
              "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                  # the format will be applied.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
              "format": { # The format of a cell. # The format to apply.
                  # Conditional formatting can only apply a subset of formatting:
                  # bold, italic,
                  # strikethrough,
                  # foreground color &
                  # background color.
                "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                  "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                      # the user's locale will be used if necessary for the given type.
                      # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                      # information about the supported patterns.
                  "type": "A String", # The type of the number format.
                      # When writing, this field must be set.
                },
                "textDirection": "A String", # The direction of the text in the cell.
                "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                    # When updating padding, every field must be specified.
                  "top": 42, # The top padding of the cell.
                  "right": 42, # The right padding of the cell.
                  "bottom": 42, # The bottom padding of the cell.
                  "left": 42, # The left padding of the cell.
                },
                "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
                "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                "borders": { # The borders of the cell. # The borders of the cell.
                  "top": { # A border along a cell. # The top border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "right": { # A border along a cell. # The right border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "bottom": { # A border along a cell. # The bottom border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "left": { # A border along a cell. # The left border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                },
                "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
              },
            },
            "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                # the interpolation points listed. The format of a cell will vary
                # based on its contents as compared to the values of the interpolation
                # points.
              "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
            },
          },
        },
        "addFilterView": { # The result of adding a filter view. # A reply from adding a filter view.
          "filter": { # A filter view. # The newly added filter view.
            "title": "A String", # The name of the filter view.
            "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "filterViewId": 42, # The ID of the filter view.
            "range": { # A range on a sheet. # The range this filter view covers.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
        },
      },
    ],
  }
create(body, x__xgafv=None) 
Creates a spreadsheet, returning the newly created spreadsheet.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Resource that represents a spreadsheet.
    "spreadsheetId": "A String", # The ID of the spreadsheet.
        # This field is read-only.
    "namedRanges": [ # The named ranges defined in a spreadsheet.
      { # A named range.
        "namedRangeId": "A String", # The ID of the named range.
        "range": { # A range on a sheet. # The range this represents.
            # All indexes are zero-based.
            # Indexes are half open, e.g the start index is inclusive
            # and the end index is exclusive -- [start_index, end_index).
            # Missing indexes indicate the range is unbounded on that side.
            #
            # For example, if `"Sheet1"` is sheet ID 0, then:
            #
            #   `Sheet1!A1:A1 == sheet_id: 0,
            #                   start_row_index: 0, end_row_index: 1,
            #                   start_column_index: 0, end_column_index: 1`
            #
            #   `Sheet1!A3:B4 == sheet_id: 0,
            #                   start_row_index: 2, end_row_index: 4,
            #                   start_column_index: 0, end_column_index: 2`
            #
            #   `Sheet1!A:B == sheet_id: 0,
            #                 start_column_index: 0, end_column_index: 2`
            #
            #   `Sheet1!A5:B == sheet_id: 0,
            #                  start_row_index: 4,
            #                  start_column_index: 0, end_column_index: 2`
            #
            #   `Sheet1 == sheet_id:0`
            #
            # The start index must always be less than or equal to the end index.
            # If the start index equals the end index, then the range is empty.
            # Empty ranges are typically not meaningful and are usually rendered in the
            # UI as `#REF!`.
          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
          "sheetId": 42, # The sheet this range is on.
          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
        },
        "name": "A String", # The name of the named range.
      },
    ],
    "properties": { # Properties of a spreadsheet. # Overall properties of a spreadsheet.
      "locale": "A String", # The locale of the spreadsheet in one of the following formats:
          #
          # * an ISO 639-1 language code such as `en`
          #
          # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
          #
          # * a combination of the ISO language code and country code, such as `en_US`
          #
          # Note: when updating this field, not all locales/languages are supported.
      "timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as
          # `America/New_York`. If the time zone isn't recognized, this may
          # be a custom time zone such as `GMT-07:00`.
      "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
      "defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
          # CellData.effectiveFormat will not be set if the
          # cell's format is equal to this default format.
          # This field is read-only.
        "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
          "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
              # the user's locale will be used if necessary for the given type.
              # See the [Date and Number Formats guide](/sheets/guides/formats) for more
              # information about the supported patterns.
          "type": "A String", # The type of the number format.
              # When writing, this field must be set.
        },
        "textDirection": "A String", # The direction of the text in the cell.
        "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
            # When updating padding, every field must be specified.
          "top": 42, # The top padding of the cell.
          "right": 42, # The right padding of the cell.
          "bottom": 42, # The bottom padding of the cell.
          "left": 42, # The left padding of the cell.
        },
        "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
        "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
            # for simplicity of conversion to/from color representations in various
            # languages over compactness; for example, the fields of this representation
            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
            # method in iOS; and, with just a little work, it can be easily formatted into
            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
            #
            # Example (Java):
            #
            #      import com.google.type.Color;
            #
            #      // ...
            #      public static java.awt.Color fromProto(Color protocolor) {
            #        float alpha = protocolor.hasAlpha()
            #            ? protocolor.getAlpha().getValue()
            #            : 1.0;
            #
            #        return new java.awt.Color(
            #            protocolor.getRed(),
            #            protocolor.getGreen(),
            #            protocolor.getBlue(),
            #            alpha);
            #      }
            #
            #      public static Color toProto(java.awt.Color color) {
            #        float red = (float) color.getRed();
            #        float green = (float) color.getGreen();
            #        float blue = (float) color.getBlue();
            #        float denominator = 255.0;
            #        Color.Builder resultBuilder =
            #            Color
            #                .newBuilder()
            #                .setRed(red / denominator)
            #                .setGreen(green / denominator)
            #                .setBlue(blue / denominator);
            #        int alpha = color.getAlpha();
            #        if (alpha != 255) {
            #          result.setAlpha(
            #              FloatValue
            #                  .newBuilder()
            #                  .setValue(((float) alpha) / denominator)
            #                  .build());
            #        }
            #        return resultBuilder.build();
            #      }
            #      // ...
            #
            # Example (iOS / Obj-C):
            #
            #      // ...
            #      static UIColor* fromProto(Color* protocolor) {
            #         float red = [protocolor red];
            #         float green = [protocolor green];
            #         float blue = [protocolor blue];
            #         FloatValue* alpha_wrapper = [protocolor alpha];
            #         float alpha = 1.0;
            #         if (alpha_wrapper != nil) {
            #           alpha = [alpha_wrapper value];
            #         }
            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
            #      }
            #
            #      static Color* toProto(UIColor* color) {
            #          CGFloat red, green, blue, alpha;
            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
            #            return nil;
            #          }
            #          Color* result = [Color alloc] init];
            #          [result setRed:red];
            #          [result setGreen:green];
            #          [result setBlue:blue];
            #          if (alpha <= 0.9999) {
            #            [result setAlpha:floatWrapperWithValue(alpha)];
            #          }
            #          [result autorelease];
            #          return result;
            #     }
            #     // ...
            #
            #  Example (JavaScript):
            #
            #     // ...
            #
            #     var protoToCssColor = function(rgb_color) {
            #        var redFrac = rgb_color.red || 0.0;
            #        var greenFrac = rgb_color.green || 0.0;
            #        var blueFrac = rgb_color.blue || 0.0;
            #        var red = Math.floor(redFrac * 255);
            #        var green = Math.floor(greenFrac * 255);
            #        var blue = Math.floor(blueFrac * 255);
            #
            #        if (!('alpha' in rgb_color)) {
            #           return rgbToCssColor_(red, green, blue);
            #        }
            #
            #        var alphaFrac = rgb_color.alpha.value || 0.0;
            #        var rgbParams = [red, green, blue].join(',');
            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
            #     };
            #
            #     var rgbToCssColor_ = function(red, green, blue) {
            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
            #       var hexString = rgbNumber.toString(16);
            #       var missingZeros = 6 - hexString.length;
            #       var resultBuilder = ['#'];
            #       for (var i = 0; i < missingZeros; i++) {
            #          resultBuilder.push('0');
            #       }
            #       resultBuilder.push(hexString);
            #       return resultBuilder.join('');
            #     };
            #
            #     // ...
          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
              # the final pixel color is defined by the equation:
              #
              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
              #
              # This means that a value of 1.0 corresponds to a solid color, whereas
              # a value of 0.0 corresponds to a completely transparent color. This
              # uses a wrapper message rather than a simple float scalar so that it is
              # possible to distinguish between a default value and the value being unset.
              # If omitted, this color object is to be rendered as a solid color
              # (as if the alpha value had been explicitly given with a value of 1.0).
          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
        },
        "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
        "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
            # Absent values indicate that the field isn't specified.
          "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
              # for simplicity of conversion to/from color representations in various
              # languages over compactness; for example, the fields of this representation
              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
              # method in iOS; and, with just a little work, it can be easily formatted into
              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
              #
              # Example (Java):
              #
              #      import com.google.type.Color;
              #
              #      // ...
              #      public static java.awt.Color fromProto(Color protocolor) {
              #        float alpha = protocolor.hasAlpha()
              #            ? protocolor.getAlpha().getValue()
              #            : 1.0;
              #
              #        return new java.awt.Color(
              #            protocolor.getRed(),
              #            protocolor.getGreen(),
              #            protocolor.getBlue(),
              #            alpha);
              #      }
              #
              #      public static Color toProto(java.awt.Color color) {
              #        float red = (float) color.getRed();
              #        float green = (float) color.getGreen();
              #        float blue = (float) color.getBlue();
              #        float denominator = 255.0;
              #        Color.Builder resultBuilder =
              #            Color
              #                .newBuilder()
              #                .setRed(red / denominator)
              #                .setGreen(green / denominator)
              #                .setBlue(blue / denominator);
              #        int alpha = color.getAlpha();
              #        if (alpha != 255) {
              #          result.setAlpha(
              #              FloatValue
              #                  .newBuilder()
              #                  .setValue(((float) alpha) / denominator)
              #                  .build());
              #        }
              #        return resultBuilder.build();
              #      }
              #      // ...
              #
              # Example (iOS / Obj-C):
              #
              #      // ...
              #      static UIColor* fromProto(Color* protocolor) {
              #         float red = [protocolor red];
              #         float green = [protocolor green];
              #         float blue = [protocolor blue];
              #         FloatValue* alpha_wrapper = [protocolor alpha];
              #         float alpha = 1.0;
              #         if (alpha_wrapper != nil) {
              #           alpha = [alpha_wrapper value];
              #         }
              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
              #      }
              #
              #      static Color* toProto(UIColor* color) {
              #          CGFloat red, green, blue, alpha;
              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
              #            return nil;
              #          }
              #          Color* result = [Color alloc] init];
              #          [result setRed:red];
              #          [result setGreen:green];
              #          [result setBlue:blue];
              #          if (alpha <= 0.9999) {
              #            [result setAlpha:floatWrapperWithValue(alpha)];
              #          }
              #          [result autorelease];
              #          return result;
              #     }
              #     // ...
              #
              #  Example (JavaScript):
              #
              #     // ...
              #
              #     var protoToCssColor = function(rgb_color) {
              #        var redFrac = rgb_color.red || 0.0;
              #        var greenFrac = rgb_color.green || 0.0;
              #        var blueFrac = rgb_color.blue || 0.0;
              #        var red = Math.floor(redFrac * 255);
              #        var green = Math.floor(greenFrac * 255);
              #        var blue = Math.floor(blueFrac * 255);
              #
              #        if (!('alpha' in rgb_color)) {
              #           return rgbToCssColor_(red, green, blue);
              #        }
              #
              #        var alphaFrac = rgb_color.alpha.value || 0.0;
              #        var rgbParams = [red, green, blue].join(',');
              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
              #     };
              #
              #     var rgbToCssColor_ = function(red, green, blue) {
              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
              #       var hexString = rgbNumber.toString(16);
              #       var missingZeros = 6 - hexString.length;
              #       var resultBuilder = ['#'];
              #       for (var i = 0; i < missingZeros; i++) {
              #          resultBuilder.push('0');
              #       }
              #       resultBuilder.push(hexString);
              #       return resultBuilder.join('');
              #     };
              #
              #     // ...
            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                # the final pixel color is defined by the equation:
                #
                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                #
                # This means that a value of 1.0 corresponds to a solid color, whereas
                # a value of 0.0 corresponds to a completely transparent color. This
                # uses a wrapper message rather than a simple float scalar so that it is
                # possible to distinguish between a default value and the value being unset.
                # If omitted, this color object is to be rendered as a solid color
                # (as if the alpha value had been explicitly given with a value of 1.0).
            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
          },
          "bold": True or False, # True if the text is bold.
          "strikethrough": True or False, # True if the text has a strikethrough.
          "fontFamily": "A String", # The font family.
          "fontSize": 42, # The size of the font.
          "italic": True or False, # True if the text is italicized.
          "underline": True or False, # True if the text is underlined.
        },
        "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
        "borders": { # The borders of the cell. # The borders of the cell.
          "top": { # A border along a cell. # The top border of the cell.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "right": { # A border along a cell. # The right border of the cell.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "bottom": { # A border along a cell. # The bottom border of the cell.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
          "left": { # A border along a cell. # The left border of the cell.
            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "width": 42, # The width of the border, in pixels.
                # Deprecated; the width is determined by the "style" field.
            "style": "A String", # The style of the border.
          },
        },
        "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
      },
      "title": "A String", # The title of the spreadsheet.
    },
    "sheets": [ # The sheets that are part of a spreadsheet.
      { # A sheet in a spreadsheet.
        "conditionalFormats": [ # The conditional format rules in this sheet.
          { # A rule describing a conditional format.
            "ranges": [ # The ranges that will be formatted if the condition is true.
                # All the ranges must be on the same grid.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
              "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                  # the format will be applied.
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
              "format": { # The format of a cell. # The format to apply.
                  # Conditional formatting can only apply a subset of formatting:
                  # bold, italic,
                  # strikethrough,
                  # foreground color &
                  # background color.
                "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                  "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                      # the user's locale will be used if necessary for the given type.
                      # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                      # information about the supported patterns.
                  "type": "A String", # The type of the number format.
                      # When writing, this field must be set.
                },
                "textDirection": "A String", # The direction of the text in the cell.
                "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                    # When updating padding, every field must be specified.
                  "top": 42, # The top padding of the cell.
                  "right": 42, # The right padding of the cell.
                  "bottom": 42, # The bottom padding of the cell.
                  "left": 42, # The left padding of the cell.
                },
                "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                    # Absent values indicate that the field isn't specified.
                  "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # True if the text is bold.
                  "strikethrough": True or False, # True if the text has a strikethrough.
                  "fontFamily": "A String", # The font family.
                  "fontSize": 42, # The size of the font.
                  "italic": True or False, # True if the text is italicized.
                  "underline": True or False, # True if the text is underlined.
                },
                "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                "borders": { # The borders of the cell. # The borders of the cell.
                  "top": { # A border along a cell. # The top border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "right": { # A border along a cell. # The right border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "bottom": { # A border along a cell. # The bottom border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                  "left": { # A border along a cell. # The left border of the cell.
                    "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "width": 42, # The width of the border, in pixels.
                        # Deprecated; the width is determined by the "style" field.
                    "style": "A String", # The style of the border.
                  },
                },
                "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
              },
            },
            "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                # the interpolation points listed. The format of a cell will vary
                # based on its contents as compared to the values of the interpolation
                # points.
              "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
              "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                  # These pin the gradient color scale according to the color,
                  # type and value chosen.
                "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "type": "A String", # How the value should be interpreted.
                "value": "A String", # The value this interpolation point uses.  May be a formula.
                    # Unused if type is MIN or
                    # MAX.
              },
            },
          },
        ],
        "merges": [ # The ranges that are merged together.
          { # A range on a sheet.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
        ],
        "basicFilter": { # The default filter associated with a sheet. # The filter on this sheet, if any.
          "range": { # A range on a sheet. # The range the filter covers.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "sortSpecs": [ # The sort order per column. Later specifications are used when values
              # are equal in the earlier specifications.
            { # A sort order associated with a specific column or row.
              "sortOrder": "A String", # The order data should be sorted.
              "dimensionIndex": 42, # The dimension the sort should be applied to.
            },
          ],
          "criteria": { # The criteria for showing/hiding values per column.
              # The map's key is the column index, and the value is the criteria for
              # that column.
            "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
              "hiddenValues": [ # Values that should be hidden.
                "A String",
              ],
              "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                  # (This does not override hiddenValues -- if a value is listed there,
                  #  it will still be hidden.)
                  # BooleanConditions are used by conditional formatting,
                  # data validation, and the criteria in filters.
                "type": "A String", # The type of condition.
                "values": [ # The values of the condition. The number of supported values depends
                    # on the condition type.  Some support zero values,
                    # others one or two values,
                    # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                  { # The value of the condition.
                    "relativeDate": "A String", # A relative date (based on the current date).
                        # Valid only if the type is
                        # DATE_BEFORE,
                        # DATE_AFTER,
                        # DATE_ON_OR_BEFORE or
                        # DATE_ON_OR_AFTER.
                        #
                        # Relative dates are not supported in data validation.
                        # They are supported only in conditional formatting and
                        # conditional filters.
                    "userEnteredValue": "A String", # A value the condition is based on.
                        # The value will be parsed as if the user typed into a cell.
                        # Formulas are supported (and must begin with an `=`).
                  },
                ],
              },
            },
          },
        },
        "charts": [ # The specifications of every chart on this sheet.
          { # A chart embedded in a sheet.
            "chartId": 42, # The ID of the chart.
            "position": { # The position of an embedded object such as a chart. # The position of the chart.
              "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                  # is chosen for you. Used only when writing.
              "sheetId": 42, # The sheet this is on. Set only if the embedded object
                  # is on its own sheet. Must be non-negative.
              "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
                "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                    # All indexes are zero-based.
                  "rowIndex": 42, # The row index of the coordinate.
                  "columnIndex": 42, # The column index of the coordinate.
                  "sheetId": 42, # The sheet this coordinate is on.
                },
                "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                    # from the anchor cell.
                "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
                "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                    # from the anchor cell.
                "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
              },
            },
            "spec": { # The specifications of a chart. # The specification of the chart.
              "hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.
              "pieChart": { # A pie chart. # A pie chart specification.
                "series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.
                  "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                    "sources": [ # The ranges of data for a series or domain.
                        # Exactly one dimension must have a length of 1,
                        # and all sources in the list must have the same dimension
                        # with length 1.
                        # The domain (if it exists) & all series must have the same number
                        # of source ranges. If using more than one source range, then the source
                        # range at a given offset must be contiguous across the domain and series.
                        #
                        # For example, these are valid configurations:
                        #
                        #     domain sources: A1:A5
                        #     series1 sources: B1:B5
                        #     series2 sources: D6:D10
                        #
                        #     domain sources: A1:A5, C10:C12
                        #     series1 sources: B1:B5, D10:D12
                        #     series2 sources: C1:C5, E10:E12
                      { # A range on a sheet.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                    ],
                  },
                },
                "domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.
                  "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                    "sources": [ # The ranges of data for a series or domain.
                        # Exactly one dimension must have a length of 1,
                        # and all sources in the list must have the same dimension
                        # with length 1.
                        # The domain (if it exists) & all series must have the same number
                        # of source ranges. If using more than one source range, then the source
                        # range at a given offset must be contiguous across the domain and series.
                        #
                        # For example, these are valid configurations:
                        #
                        #     domain sources: A1:A5
                        #     series1 sources: B1:B5
                        #     series2 sources: D6:D10
                        #
                        #     domain sources: A1:A5, C10:C12
                        #     series1 sources: B1:B5, D10:D12
                        #     series2 sources: C1:C5, E10:E12
                      { # A range on a sheet.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                    ],
                  },
                },
                "threeDimensional": True or False, # True if the pie is three dimensional.
                "legendPosition": "A String", # Where the legend of the pie chart should be drawn.
                "pieHole": 3.14, # The size of the hole in the pie chart.
              },
              "basicChart": { # The specification for a basic chart.  See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.
                  # See BasicChartType for the list of all
                  # charts this supports.
                  # of charts this supports.
                "headerCount": 42, # The number of rows or columns in the data that are "headers".
                    # If not set, Google Sheets will guess how many rows are headers based
                    # on the data.
                    #
                    # (Note that BasicChartAxis.title may override the axis title
                    #  inferred from the header values.)
                "series": [ # The data this chart is visualizing.
                  { # A single series of data in a chart.
                      # For example, if charting stock prices over time, multiple series may exist,
                      # one for the "Open Price", "High Price", "Low Price" and "Close Price".
                    "series": { # The data included in a domain or series. # The data being visualized in this chart series.
                      "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                        "sources": [ # The ranges of data for a series or domain.
                            # Exactly one dimension must have a length of 1,
                            # and all sources in the list must have the same dimension
                            # with length 1.
                            # The domain (if it exists) & all series must have the same number
                            # of source ranges. If using more than one source range, then the source
                            # range at a given offset must be contiguous across the domain and series.
                            #
                            # For example, these are valid configurations:
                            #
                            #     domain sources: A1:A5
                            #     series1 sources: B1:B5
                            #     series2 sources: D6:D10
                            #
                            #     domain sources: A1:A5, C10:C12
                            #     series1 sources: B1:B5, D10:D12
                            #     series2 sources: C1:C5, E10:E12
                          { # A range on a sheet.
                              # All indexes are zero-based.
                              # Indexes are half open, e.g the start index is inclusive
                              # and the end index is exclusive -- [start_index, end_index).
                              # Missing indexes indicate the range is unbounded on that side.
                              #
                              # For example, if `"Sheet1"` is sheet ID 0, then:
                              #
                              #   `Sheet1!A1:A1 == sheet_id: 0,
                              #                   start_row_index: 0, end_row_index: 1,
                              #                   start_column_index: 0, end_column_index: 1`
                              #
                              #   `Sheet1!A3:B4 == sheet_id: 0,
                              #                   start_row_index: 2, end_row_index: 4,
                              #                   start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A:B == sheet_id: 0,
                              #                 start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A5:B == sheet_id: 0,
                              #                  start_row_index: 4,
                              #                  start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1 == sheet_id:0`
                              #
                              # The start index must always be less than or equal to the end index.
                              # If the start index equals the end index, then the range is empty.
                              # Empty ranges are typically not meaningful and are usually rendered in the
                              # UI as `#REF!`.
                            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                            "sheetId": 42, # The sheet this range is on.
                            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                          },
                        ],
                      },
                    },
                    "targetAxis": "A String", # The minor axis that will specify the range of values for this series.
                        # For example, if charting stocks over time, the "Volume" series
                        # may want to be pinned to the right with the prices pinned to the left,
                        # because the scale of trading volume is different than the scale of
                        # prices.
                        # It is an error to specify an axis that isn't a valid minor axis
                        # for the chart's type.
                    "type": "A String", # The type of this series. Valid only if the
                        # chartType is
                        # COMBO.
                        # Different types will change the way the series is visualized.
                        # Only LINE, AREA,
                        # and COLUMN are supported.
                  },
                ],
                "legendPosition": "A String", # The position of the chart legend.
                "domains": [ # The domain of data this is charting.
                    # Only a single domain is currently supported.
                  { # The domain of a chart.
                      # For example, if charting stock prices over time, this would be the date.
                    "domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,
                        # this is the data representing the dates.
                      "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                        "sources": [ # The ranges of data for a series or domain.
                            # Exactly one dimension must have a length of 1,
                            # and all sources in the list must have the same dimension
                            # with length 1.
                            # The domain (if it exists) & all series must have the same number
                            # of source ranges. If using more than one source range, then the source
                            # range at a given offset must be contiguous across the domain and series.
                            #
                            # For example, these are valid configurations:
                            #
                            #     domain sources: A1:A5
                            #     series1 sources: B1:B5
                            #     series2 sources: D6:D10
                            #
                            #     domain sources: A1:A5, C10:C12
                            #     series1 sources: B1:B5, D10:D12
                            #     series2 sources: C1:C5, E10:E12
                          { # A range on a sheet.
                              # All indexes are zero-based.
                              # Indexes are half open, e.g the start index is inclusive
                              # and the end index is exclusive -- [start_index, end_index).
                              # Missing indexes indicate the range is unbounded on that side.
                              #
                              # For example, if `"Sheet1"` is sheet ID 0, then:
                              #
                              #   `Sheet1!A1:A1 == sheet_id: 0,
                              #                   start_row_index: 0, end_row_index: 1,
                              #                   start_column_index: 0, end_column_index: 1`
                              #
                              #   `Sheet1!A3:B4 == sheet_id: 0,
                              #                   start_row_index: 2, end_row_index: 4,
                              #                   start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A:B == sheet_id: 0,
                              #                 start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1!A5:B == sheet_id: 0,
                              #                  start_row_index: 4,
                              #                  start_column_index: 0, end_column_index: 2`
                              #
                              #   `Sheet1 == sheet_id:0`
                              #
                              # The start index must always be less than or equal to the end index.
                              # If the start index equals the end index, then the range is empty.
                              # Empty ranges are typically not meaningful and are usually rendered in the
                              # UI as `#REF!`.
                            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                            "sheetId": 42, # The sheet this range is on.
                            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                          },
                        ],
                      },
                    },
                  },
                ],
                "chartType": "A String", # The type of the chart.
                "axis": [ # The axis on the chart.
                  { # An axis of the chart.
                      # A chart may not have more than one axis per
                      # axis position.
                    "position": "A String", # The position of this axis.
                    "format": { # The format of a run of text in a cell. # The format of the title.
                        # Only valid if the axis is not associated with the domain.
                        # Absent values indicate that the field isn't specified.
                      "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "bold": True or False, # True if the text is bold.
                      "strikethrough": True or False, # True if the text has a strikethrough.
                      "fontFamily": "A String", # The font family.
                      "fontSize": 42, # The size of the font.
                      "italic": True or False, # True if the text is italicized.
                      "underline": True or False, # True if the text is underlined.
                    },
                    "title": "A String", # The title of this axis. If set, this overrides any title inferred
                        # from headers of the data.
                  },
                ],
              },
              "title": "A String", # The title of the chart.
            },
          },
        ],
        "filterViews": [ # The filter views in this sheet.
          { # A filter view.
            "title": "A String", # The name of the filter view.
            "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "filterViewId": 42, # The ID of the filter view.
            "range": { # A range on a sheet. # The range this filter view covers.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
        ],
        "protectedRanges": [ # The protected ranges in this sheet.
          { # A protected range.
            "unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.
                # Unprotected ranges are only supported on protected sheets.
              { # A range on a sheet.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            ],
            "requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the
                # protected area.
                # This field is read-only.
            "description": "A String", # The description of this protected range.
            "namedRangeId": "A String", # The named range this protected range is backed by, if any.
                #
                # When writing, only one of range or named_range_id
                # may be set.
            "editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.
                # This field is only visible to users with edit access to the protected
                # range and the document.
                # Editors are not supported with warning_only protection.
              "domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected
                  # range.  Domain protection is only supported on documents within a domain.
              "users": [ # The email addresses of users with edit access to the protected range.
                "A String",
              ],
              "groups": [ # The email addresses of groups with edit access to the protected range.
                "A String",
              ],
            },
            "protectedRangeId": 42, # The ID of the protected range.
                # This field is read-only.
            "warningOnly": True or False, # True if this protected range will show a warning when editing.
                # Warning-based protection means that every user can edit data in the
                # protected range, except editing will prompt a warning asking the user
                # to confirm the edit.
                #
                # When writing: if this field is true, then editors is ignored.
                # Additionally, if this field is changed from true to false and the
                # `editors` field is not set (nor included in the field mask), then
                # the editors will be set to all the editors in the document.
            "range": { # A range on a sheet. # The range that is being protected.
                # The range may be fully unbounded, in which case this is considered
                # a protected sheet.
                #
                # When writing, only one of range or named_range_id
                # may be set.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
          },
        ],
        "data": [ # Data in the grid, if this is a grid sheet.
            # The number of GridData objects returned is dependent on the number of
            # ranges requested on this sheet. For example, if this is representing
            # `Sheet1`, and the spreadsheet was requested with ranges
            # `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a
            # startRow/startColumn of `0`,
            # while the second one will have `startRow 14` (zero-based row 15),
            # and `startColumn 3` (zero-based column D).
          { # Data in the grid, as well as metadata about the dimensions.
            "startRow": 42, # The first row this GridData refers to, zero-based.
            "rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
                # in start_row.
              { # Properties about a dimension.
                "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
                "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
                "hiddenByFilter": True or False, # True if this dimension is being filtered.
                    # This field is read-only.
              },
            ],
            "startColumn": 42, # The first column this GridData refers to, zero-based.
            "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
                # in start_column.
              { # Properties about a dimension.
                "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
                "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
                "hiddenByFilter": True or False, # True if this dimension is being filtered.
                    # This field is read-only.
              },
            ],
            "rowData": [ # The data in the grid, one entry per row,
                # starting with the row in startRow.
                # The values in RowData will correspond to columns starting
                # at start_column.
              { # Data about each cell in a row.
                "values": [ # The values in the row, one per column.
                  { # Data about a specific cell.
                    "pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself
                        # is computed dynamically based on its data, grouping, filters, values,
                        # etc. Only the top-left cell of the pivot table contains the pivot table
                        # definition. The other cells will contain the calculated values of the
                        # results of the pivot in their effective_value fields.
                      "valueLayout": "A String", # Whether values should be listed horizontally (as columns)
                          # or vertically (as rows).
                      "rows": [ # Each row grouping in the pivot table.
                        { # A single grouping (either row or column) in a pivot table.
                          "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                          "valueMetadata": [ # Metadata about values in the grouping.
                            { # Metadata about a value in a pivot grouping.
                              "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                              "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                  # (Note that formulaValue is not valid,
                                  #  because the values will be calculated.)
                                "numberValue": 3.14, # Represents a double value.
                                    # Note: Dates, Times and DateTimes are represented as doubles in
                                    # "serial number" format.
                                "boolValue": True or False, # Represents a boolean value.
                                "formulaValue": "A String", # Represents a formula.
                                "stringValue": "A String", # Represents a string value.
                                    # Leading single quotes are not included. For example, if the user typed
                                    # `'123` into the UI, this would be represented as a `stringValue` of
                                    # `"123"`.
                                "errorValue": { # An error in a cell. # Represents an error.
                                    # This field is read-only.
                                  "message": "A String", # A message with more information about the error
                                      # (in the spreadsheet's locale).
                                  "type": "A String", # The type of error.
                                },
                              },
                            },
                          ],
                          "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                              # If not specified, sorting is alphabetical by this group's values.
                            "buckets": [ # Determines the bucket from which values are chosen to sort.
                                #
                                # For example, in a pivot table with one row group & two column groups,
                                # the row group can list up to two values. The first value corresponds
                                # to a value within the first column group, and the second value
                                # corresponds to a value in the second column group.  If no values
                                # are listed, this would indicate that the row should be sorted according
                                # to the "Grand Total" over the column groups. If a single value is listed,
                                # this would correspond to using the "Total" of that bucket.
                              { # The kinds of value that a cell in a spreadsheet can have.
                                "numberValue": 3.14, # Represents a double value.
                                    # Note: Dates, Times and DateTimes are represented as doubles in
                                    # "serial number" format.
                                "boolValue": True or False, # Represents a boolean value.
                                "formulaValue": "A String", # Represents a formula.
                                "stringValue": "A String", # Represents a string value.
                                    # Leading single quotes are not included. For example, if the user typed
                                    # `'123` into the UI, this would be represented as a `stringValue` of
                                    # `"123"`.
                                "errorValue": { # An error in a cell. # Represents an error.
                                    # This field is read-only.
                                  "message": "A String", # A message with more information about the error
                                      # (in the spreadsheet's locale).
                                  "type": "A String", # The type of error.
                                },
                              },
                            ],
                            "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                                # grouping should be sorted by.
                          },
                          "sortOrder": "A String", # The order the values in this group should be sorted.
                          "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                              #
                              # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                              # means this group refers to column `C`, whereas the offset `1` would refer
                              # to column `D`.
                        },
                      ],
                      "source": { # A range on a sheet. # The range the pivot table is reading data from.
                          # All indexes are zero-based.
                          # Indexes are half open, e.g the start index is inclusive
                          # and the end index is exclusive -- [start_index, end_index).
                          # Missing indexes indicate the range is unbounded on that side.
                          #
                          # For example, if `"Sheet1"` is sheet ID 0, then:
                          #
                          #   `Sheet1!A1:A1 == sheet_id: 0,
                          #                   start_row_index: 0, end_row_index: 1,
                          #                   start_column_index: 0, end_column_index: 1`
                          #
                          #   `Sheet1!A3:B4 == sheet_id: 0,
                          #                   start_row_index: 2, end_row_index: 4,
                          #                   start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A:B == sheet_id: 0,
                          #                 start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1!A5:B == sheet_id: 0,
                          #                  start_row_index: 4,
                          #                  start_column_index: 0, end_column_index: 2`
                          #
                          #   `Sheet1 == sheet_id:0`
                          #
                          # The start index must always be less than or equal to the end index.
                          # If the start index equals the end index, then the range is empty.
                          # Empty ranges are typically not meaningful and are usually rendered in the
                          # UI as `#REF!`.
                        "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                        "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                        "sheetId": 42, # The sheet this range is on.
                        "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                        "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                      },
                      "values": [ # A list of values to include in the pivot table.
                        { # The definition of how a value in a pivot table should be calculated.
                          "formula": "A String", # A custom formula to calculate the value.  The formula must start
                              # with an `=` character.
                          "summarizeFunction": "A String", # A function to summarize the value.
                              # If formula is set, the only supported values are
                              # SUM and
                              # CUSTOM.
                              # If sourceColumnOffset is set, then `CUSTOM`
                              # is not supported.
                          "sourceColumnOffset": 42, # The column offset of the source range that this value reads from.
                              #
                              # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                              # means this value refers to column `C`, whereas the offset `1` would
                              # refer to column `D`.
                          "name": "A String", # A name to use for the value. This is only used if formula was set.
                              # Otherwise, the column name is used.
                        },
                      ],
                      "criteria": { # An optional mapping of filters per source column offset.
                          #
                          # The filters will be applied before aggregating data into the pivot table.
                          # The map's key is the column offset of the source range that you want to
                          # filter, and the value is the criteria for that column.
                          #
                          # For example, if the source was `C10:E15`, a key of `0` will have the filter
                          # for column `C`, whereas the key `1` is for column `D`.
                        "a_key": { # Criteria for showing/hiding rows in a pivot table.
                          "visibleValues": [ # Values that should be included.  Values not listed here are excluded.
                            "A String",
                          ],
                        },
                      },
                      "columns": [ # Each column grouping in the pivot table.
                        { # A single grouping (either row or column) in a pivot table.
                          "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                          "valueMetadata": [ # Metadata about values in the grouping.
                            { # Metadata about a value in a pivot grouping.
                              "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                              "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                  # (Note that formulaValue is not valid,
                                  #  because the values will be calculated.)
                                "numberValue": 3.14, # Represents a double value.
                                    # Note: Dates, Times and DateTimes are represented as doubles in
                                    # "serial number" format.
                                "boolValue": True or False, # Represents a boolean value.
                                "formulaValue": "A String", # Represents a formula.
                                "stringValue": "A String", # Represents a string value.
                                    # Leading single quotes are not included. For example, if the user typed
                                    # `'123` into the UI, this would be represented as a `stringValue` of
                                    # `"123"`.
                                "errorValue": { # An error in a cell. # Represents an error.
                                    # This field is read-only.
                                  "message": "A String", # A message with more information about the error
                                      # (in the spreadsheet's locale).
                                  "type": "A String", # The type of error.
                                },
                              },
                            },
                          ],
                          "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                              # If not specified, sorting is alphabetical by this group's values.
                            "buckets": [ # Determines the bucket from which values are chosen to sort.
                                #
                                # For example, in a pivot table with one row group & two column groups,
                                # the row group can list up to two values. The first value corresponds
                                # to a value within the first column group, and the second value
                                # corresponds to a value in the second column group.  If no values
                                # are listed, this would indicate that the row should be sorted according
                                # to the "Grand Total" over the column groups. If a single value is listed,
                                # this would correspond to using the "Total" of that bucket.
                              { # The kinds of value that a cell in a spreadsheet can have.
                                "numberValue": 3.14, # Represents a double value.
                                    # Note: Dates, Times and DateTimes are represented as doubles in
                                    # "serial number" format.
                                "boolValue": True or False, # Represents a boolean value.
                                "formulaValue": "A String", # Represents a formula.
                                "stringValue": "A String", # Represents a string value.
                                    # Leading single quotes are not included. For example, if the user typed
                                    # `'123` into the UI, this would be represented as a `stringValue` of
                                    # `"123"`.
                                "errorValue": { # An error in a cell. # Represents an error.
                                    # This field is read-only.
                                  "message": "A String", # A message with more information about the error
                                      # (in the spreadsheet's locale).
                                  "type": "A String", # The type of error.
                                },
                              },
                            ],
                            "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                                # grouping should be sorted by.
                          },
                          "sortOrder": "A String", # The order the values in this group should be sorted.
                          "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                              #
                              # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                              # means this group refers to column `C`, whereas the offset `1` would refer
                              # to column `D`.
                        },
                      ],
                    },
                    "hyperlink": "A String", # A hyperlink this cell points to, if any.
                        # This field is read-only.  (To set it, use a `=HYPERLINK` formula.)
                    "effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be
                        # the calculated value.  For cells with literals, this will be
                        # the same as the user_entered_value.
                        # This field is read-only.
                      "numberValue": 3.14, # Represents a double value.
                          # Note: Dates, Times and DateTimes are represented as doubles in
                          # "serial number" format.
                      "boolValue": True or False, # Represents a boolean value.
                      "formulaValue": "A String", # Represents a formula.
                      "stringValue": "A String", # Represents a string value.
                          # Leading single quotes are not included. For example, if the user typed
                          # `'123` into the UI, this would be represented as a `stringValue` of
                          # `"123"`.
                      "errorValue": { # An error in a cell. # Represents an error.
                          # This field is read-only.
                        "message": "A String", # A message with more information about the error
                            # (in the spreadsheet's locale).
                        "type": "A String", # The type of error.
                      },
                    },
                    "formattedValue": "A String", # The formatted value of the cell.
                        # This is the value as it's shown to the user.
                        # This field is read-only.
                    "userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
                        # Note: Dates, Times and DateTimes are represented as doubles in
                        # serial number format.
                      "numberValue": 3.14, # Represents a double value.
                          # Note: Dates, Times and DateTimes are represented as doubles in
                          # "serial number" format.
                      "boolValue": True or False, # Represents a boolean value.
                      "formulaValue": "A String", # Represents a formula.
                      "stringValue": "A String", # Represents a string value.
                          # Leading single quotes are not included. For example, if the user typed
                          # `'123` into the UI, this would be represented as a `stringValue` of
                          # `"123"`.
                      "errorValue": { # An error in a cell. # Represents an error.
                          # This field is read-only.
                        "message": "A String", # A message with more information about the error
                            # (in the spreadsheet's locale).
                        "type": "A String", # The type of error.
                      },
                    },
                    "note": "A String", # Any note on the cell.
                    "effectiveFormat": { # The format of a cell. # The effective format being used by the cell.
                        # This includes the results of applying any conditional formatting and,
                        # if the cell contains a formula, the computed number format.
                        # If the effective format is the default format, effective format will
                        # not be written.
                        # This field is read-only.
                      "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                        "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                            # the user's locale will be used if necessary for the given type.
                            # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                            # information about the supported patterns.
                        "type": "A String", # The type of the number format.
                            # When writing, this field must be set.
                      },
                      "textDirection": "A String", # The direction of the text in the cell.
                      "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                          # When updating padding, every field must be specified.
                        "top": 42, # The top padding of the cell.
                        "right": 42, # The right padding of the cell.
                        "bottom": 42, # The bottom padding of the cell.
                        "left": 42, # The left padding of the cell.
                      },
                      "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                      "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                      "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                          # Absent values indicate that the field isn't specified.
                        "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # True if the text is bold.
                        "strikethrough": True or False, # True if the text has a strikethrough.
                        "fontFamily": "A String", # The font family.
                        "fontSize": 42, # The size of the font.
                        "italic": True or False, # True if the text is italicized.
                        "underline": True or False, # True if the text is underlined.
                      },
                      "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                      "borders": { # The borders of the cell. # The borders of the cell.
                        "top": { # A border along a cell. # The top border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                        "right": { # A border along a cell. # The right border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                        "bottom": { # A border along a cell. # The bottom border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                        "left": { # A border along a cell. # The left border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                      },
                      "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                    },
                    "userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
                        #
                        # When writing, the new format will be merged with the existing format.
                      "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                        "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                            # the user's locale will be used if necessary for the given type.
                            # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                            # information about the supported patterns.
                        "type": "A String", # The type of the number format.
                            # When writing, this field must be set.
                      },
                      "textDirection": "A String", # The direction of the text in the cell.
                      "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                          # When updating padding, every field must be specified.
                        "top": 42, # The top padding of the cell.
                        "right": 42, # The right padding of the cell.
                        "bottom": 42, # The bottom padding of the cell.
                        "left": 42, # The left padding of the cell.
                      },
                      "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                      "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                      "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                          # Absent values indicate that the field isn't specified.
                        "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # True if the text is bold.
                        "strikethrough": True or False, # True if the text has a strikethrough.
                        "fontFamily": "A String", # The font family.
                        "fontSize": 42, # The size of the font.
                        "italic": True or False, # True if the text is italicized.
                        "underline": True or False, # True if the text is underlined.
                      },
                      "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                      "borders": { # The borders of the cell. # The borders of the cell.
                        "top": { # A border along a cell. # The top border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                        "right": { # A border along a cell. # The right border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                        "bottom": { # A border along a cell. # The bottom border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                        "left": { # A border along a cell. # The left border of the cell.
                          "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "width": 42, # The width of the border, in pixels.
                              # Deprecated; the width is determined by the "style" field.
                          "style": "A String", # The style of the border.
                        },
                      },
                      "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                    },
                    "dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
                        #
                        # When writing, the new data validation rule will overwrite any prior rule.
                      "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                          # If true, "List" conditions will show a dropdown.
                      "strict": True or False, # True if invalid data should be rejected.
                      "inputMessage": "A String", # A message to show the user when adding data to the cell.
                      "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                          # BooleanConditions are used by conditional formatting,
                          # data validation, and the criteria in filters.
                        "type": "A String", # The type of condition.
                        "values": [ # The values of the condition. The number of supported values depends
                            # on the condition type.  Some support zero values,
                            # others one or two values,
                            # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                          { # The value of the condition.
                            "relativeDate": "A String", # A relative date (based on the current date).
                                # Valid only if the type is
                                # DATE_BEFORE,
                                # DATE_AFTER,
                                # DATE_ON_OR_BEFORE or
                                # DATE_ON_OR_AFTER.
                                #
                                # Relative dates are not supported in data validation.
                                # They are supported only in conditional formatting and
                                # conditional filters.
                            "userEnteredValue": "A String", # A value the condition is based on.
                                # The value will be parsed as if the user typed into a cell.
                                # Formulas are supported (and must begin with an `=`).
                          },
                        ],
                      },
                    },
                    "textFormatRuns": [ # Runs of rich text applied to subsections of the cell.  Runs are only valid
                        # on user entered strings, not formulas, bools, or numbers.
                        # Runs start at specific indexes in the text and continue until the next
                        # run. Properties of a run will continue unless explicitly changed
                        # in a subsequent run (and properties of the first run will continue
                        # the properties of the cell unless explicitly changed).
                        #
                        # When writing, the new runs will overwrite any prior runs.  When writing a
                        # new user_entered_value, previous runs will be erased.
                      { # A run of a text format. The format of this run continues until the start
                          # index of the next run.
                          # When updating, all fields must be set.
                        "startIndex": 42, # The character index where this run starts.
                        "format": { # The format of a run of text in a cell. # The format of this run.  Absent values inherit the cell's format.
                            # Absent values indicate that the field isn't specified.
                          "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "bold": True or False, # True if the text is bold.
                          "strikethrough": True or False, # True if the text has a strikethrough.
                          "fontFamily": "A String", # The font family.
                          "fontSize": 42, # The size of the font.
                          "italic": True or False, # True if the text is italicized.
                          "underline": True or False, # True if the text is underlined.
                        },
                      },
                    ],
                  },
                ],
              },
            ],
          },
        ],
        "properties": { # Properties of a sheet. # The properties of the sheet.
          "sheetType": "A String", # The type of sheet. Defaults to GRID.
              # This field cannot be changed once set.
          "index": 42, # The index of the sheet within the spreadsheet.
              # When adding or updating sheet properties, if this field
              # is excluded then the sheet will be added or moved to the end
              # of the sheet list.
          "title": "A String", # The name of the sheet.
          "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
              # (If the sheet is an object sheet, containing a chart or image, then
              # this field will be absent.)
              # When writing it is an error to set any grid properties on non-grid sheets.
            "columnCount": 42, # The number of columns in the grid.
            "rowCount": 42, # The number of rows in the grid.
            "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
            "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
            "frozenRowCount": 42, # The number of rows that are frozen in the grid.
          },
          "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
          "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
              # for simplicity of conversion to/from color representations in various
              # languages over compactness; for example, the fields of this representation
              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
              # method in iOS; and, with just a little work, it can be easily formatted into
              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
              #
              # Example (Java):
              #
              #      import com.google.type.Color;
              #
              #      // ...
              #      public static java.awt.Color fromProto(Color protocolor) {
              #        float alpha = protocolor.hasAlpha()
              #            ? protocolor.getAlpha().getValue()
              #            : 1.0;
              #
              #        return new java.awt.Color(
              #            protocolor.getRed(),
              #            protocolor.getGreen(),
              #            protocolor.getBlue(),
              #            alpha);
              #      }
              #
              #      public static Color toProto(java.awt.Color color) {
              #        float red = (float) color.getRed();
              #        float green = (float) color.getGreen();
              #        float blue = (float) color.getBlue();
              #        float denominator = 255.0;
              #        Color.Builder resultBuilder =
              #            Color
              #                .newBuilder()
              #                .setRed(red / denominator)
              #                .setGreen(green / denominator)
              #                .setBlue(blue / denominator);
              #        int alpha = color.getAlpha();
              #        if (alpha != 255) {
              #          result.setAlpha(
              #              FloatValue
              #                  .newBuilder()
              #                  .setValue(((float) alpha) / denominator)
              #                  .build());
              #        }
              #        return resultBuilder.build();
              #      }
              #      // ...
              #
              # Example (iOS / Obj-C):
              #
              #      // ...
              #      static UIColor* fromProto(Color* protocolor) {
              #         float red = [protocolor red];
              #         float green = [protocolor green];
              #         float blue = [protocolor blue];
              #         FloatValue* alpha_wrapper = [protocolor alpha];
              #         float alpha = 1.0;
              #         if (alpha_wrapper != nil) {
              #           alpha = [alpha_wrapper value];
              #         }
              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
              #      }
              #
              #      static Color* toProto(UIColor* color) {
              #          CGFloat red, green, blue, alpha;
              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
              #            return nil;
              #          }
              #          Color* result = [Color alloc] init];
              #          [result setRed:red];
              #          [result setGreen:green];
              #          [result setBlue:blue];
              #          if (alpha <= 0.9999) {
              #            [result setAlpha:floatWrapperWithValue(alpha)];
              #          }
              #          [result autorelease];
              #          return result;
              #     }
              #     // ...
              #
              #  Example (JavaScript):
              #
              #     // ...
              #
              #     var protoToCssColor = function(rgb_color) {
              #        var redFrac = rgb_color.red || 0.0;
              #        var greenFrac = rgb_color.green || 0.0;
              #        var blueFrac = rgb_color.blue || 0.0;
              #        var red = Math.floor(redFrac * 255);
              #        var green = Math.floor(greenFrac * 255);
              #        var blue = Math.floor(blueFrac * 255);
              #
              #        if (!('alpha' in rgb_color)) {
              #           return rgbToCssColor_(red, green, blue);
              #        }
              #
              #        var alphaFrac = rgb_color.alpha.value || 0.0;
              #        var rgbParams = [red, green, blue].join(',');
              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
              #     };
              #
              #     var rgbToCssColor_ = function(red, green, blue) {
              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
              #       var hexString = rgbNumber.toString(16);
              #       var missingZeros = 6 - hexString.length;
              #       var resultBuilder = ['#'];
              #       for (var i = 0; i < missingZeros; i++) {
              #          resultBuilder.push('0');
              #       }
              #       resultBuilder.push(hexString);
              #       return resultBuilder.join('');
              #     };
              #
              #     // ...
            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                # the final pixel color is defined by the equation:
                #
                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                #
                # This means that a value of 1.0 corresponds to a solid color, whereas
                # a value of 0.0 corresponds to a completely transparent color. This
                # uses a wrapper message rather than a simple float scalar so that it is
                # possible to distinguish between a default value and the value being unset.
                # If omitted, this color object is to be rendered as a solid color
                # (as if the alpha value had been explicitly given with a value of 1.0).
            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
          },
          "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
          "sheetId": 42, # The ID of the sheet. Must be non-negative.
              # This field cannot be changed once set.
        },
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Resource that represents a spreadsheet.
      "spreadsheetId": "A String", # The ID of the spreadsheet.
          # This field is read-only.
      "namedRanges": [ # The named ranges defined in a spreadsheet.
        { # A named range.
          "namedRangeId": "A String", # The ID of the named range.
          "range": { # A range on a sheet. # The range this represents.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "name": "A String", # The name of the named range.
        },
      ],
      "properties": { # Properties of a spreadsheet. # Overall properties of a spreadsheet.
        "locale": "A String", # The locale of the spreadsheet in one of the following formats:
            #
            # * an ISO 639-1 language code such as `en`
            #
            # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
            #
            # * a combination of the ISO language code and country code, such as `en_US`
            #
            # Note: when updating this field, not all locales/languages are supported.
        "timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as
            # `America/New_York`. If the time zone isn't recognized, this may
            # be a custom time zone such as `GMT-07:00`.
        "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
        "defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
            # CellData.effectiveFormat will not be set if the
            # cell's format is equal to this default format.
            # This field is read-only.
          "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
            "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                # the user's locale will be used if necessary for the given type.
                # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                # information about the supported patterns.
            "type": "A String", # The type of the number format.
                # When writing, this field must be set.
          },
          "textDirection": "A String", # The direction of the text in the cell.
          "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
              # When updating padding, every field must be specified.
            "top": 42, # The top padding of the cell.
            "right": 42, # The right padding of the cell.
            "bottom": 42, # The bottom padding of the cell.
            "left": 42, # The left padding of the cell.
          },
          "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
          "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
              # for simplicity of conversion to/from color representations in various
              # languages over compactness; for example, the fields of this representation
              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
              # method in iOS; and, with just a little work, it can be easily formatted into
              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
              #
              # Example (Java):
              #
              #      import com.google.type.Color;
              #
              #      // ...
              #      public static java.awt.Color fromProto(Color protocolor) {
              #        float alpha = protocolor.hasAlpha()
              #            ? protocolor.getAlpha().getValue()
              #            : 1.0;
              #
              #        return new java.awt.Color(
              #            protocolor.getRed(),
              #            protocolor.getGreen(),
              #            protocolor.getBlue(),
              #            alpha);
              #      }
              #
              #      public static Color toProto(java.awt.Color color) {
              #        float red = (float) color.getRed();
              #        float green = (float) color.getGreen();
              #        float blue = (float) color.getBlue();
              #        float denominator = 255.0;
              #        Color.Builder resultBuilder =
              #            Color
              #                .newBuilder()
              #                .setRed(red / denominator)
              #                .setGreen(green / denominator)
              #                .setBlue(blue / denominator);
              #        int alpha = color.getAlpha();
              #        if (alpha != 255) {
              #          result.setAlpha(
              #              FloatValue
              #                  .newBuilder()
              #                  .setValue(((float) alpha) / denominator)
              #                  .build());
              #        }
              #        return resultBuilder.build();
              #      }
              #      // ...
              #
              # Example (iOS / Obj-C):
              #
              #      // ...
              #      static UIColor* fromProto(Color* protocolor) {
              #         float red = [protocolor red];
              #         float green = [protocolor green];
              #         float blue = [protocolor blue];
              #         FloatValue* alpha_wrapper = [protocolor alpha];
              #         float alpha = 1.0;
              #         if (alpha_wrapper != nil) {
              #           alpha = [alpha_wrapper value];
              #         }
              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
              #      }
              #
              #      static Color* toProto(UIColor* color) {
              #          CGFloat red, green, blue, alpha;
              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
              #            return nil;
              #          }
              #          Color* result = [Color alloc] init];
              #          [result setRed:red];
              #          [result setGreen:green];
              #          [result setBlue:blue];
              #          if (alpha <= 0.9999) {
              #            [result setAlpha:floatWrapperWithValue(alpha)];
              #          }
              #          [result autorelease];
              #          return result;
              #     }
              #     // ...
              #
              #  Example (JavaScript):
              #
              #     // ...
              #
              #     var protoToCssColor = function(rgb_color) {
              #        var redFrac = rgb_color.red || 0.0;
              #        var greenFrac = rgb_color.green || 0.0;
              #        var blueFrac = rgb_color.blue || 0.0;
              #        var red = Math.floor(redFrac * 255);
              #        var green = Math.floor(greenFrac * 255);
              #        var blue = Math.floor(blueFrac * 255);
              #
              #        if (!('alpha' in rgb_color)) {
              #           return rgbToCssColor_(red, green, blue);
              #        }
              #
              #        var alphaFrac = rgb_color.alpha.value || 0.0;
              #        var rgbParams = [red, green, blue].join(',');
              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
              #     };
              #
              #     var rgbToCssColor_ = function(red, green, blue) {
              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
              #       var hexString = rgbNumber.toString(16);
              #       var missingZeros = 6 - hexString.length;
              #       var resultBuilder = ['#'];
              #       for (var i = 0; i < missingZeros; i++) {
              #          resultBuilder.push('0');
              #       }
              #       resultBuilder.push(hexString);
              #       return resultBuilder.join('');
              #     };
              #
              #     // ...
            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                # the final pixel color is defined by the equation:
                #
                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                #
                # This means that a value of 1.0 corresponds to a solid color, whereas
                # a value of 0.0 corresponds to a completely transparent color. This
                # uses a wrapper message rather than a simple float scalar so that it is
                # possible to distinguish between a default value and the value being unset.
                # If omitted, this color object is to be rendered as a solid color
                # (as if the alpha value had been explicitly given with a value of 1.0).
            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
          },
          "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
          "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
              # Absent values indicate that the field isn't specified.
            "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "bold": True or False, # True if the text is bold.
            "strikethrough": True or False, # True if the text has a strikethrough.
            "fontFamily": "A String", # The font family.
            "fontSize": 42, # The size of the font.
            "italic": True or False, # True if the text is italicized.
            "underline": True or False, # True if the text is underlined.
          },
          "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
          "borders": { # The borders of the cell. # The borders of the cell.
            "top": { # A border along a cell. # The top border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
            "right": { # A border along a cell. # The right border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
            "bottom": { # A border along a cell. # The bottom border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
            "left": { # A border along a cell. # The left border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
          },
          "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
        },
        "title": "A String", # The title of the spreadsheet.
      },
      "sheets": [ # The sheets that are part of a spreadsheet.
        { # A sheet in a spreadsheet.
          "conditionalFormats": [ # The conditional format rules in this sheet.
            { # A rule describing a conditional format.
              "ranges": [ # The ranges that will be formatted if the condition is true.
                  # All the ranges must be on the same grid.
                { # A range on a sheet.
                    # All indexes are zero-based.
                    # Indexes are half open, e.g the start index is inclusive
                    # and the end index is exclusive -- [start_index, end_index).
                    # Missing indexes indicate the range is unbounded on that side.
                    #
                    # For example, if `"Sheet1"` is sheet ID 0, then:
                    #
                    #   `Sheet1!A1:A1 == sheet_id: 0,
                    #                   start_row_index: 0, end_row_index: 1,
                    #                   start_column_index: 0, end_column_index: 1`
                    #
                    #   `Sheet1!A3:B4 == sheet_id: 0,
                    #                   start_row_index: 2, end_row_index: 4,
                    #                   start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A:B == sheet_id: 0,
                    #                 start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A5:B == sheet_id: 0,
                    #                  start_row_index: 4,
                    #                  start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1 == sheet_id:0`
                    #
                    # The start index must always be less than or equal to the end index.
                    # If the start index equals the end index, then the range is empty.
                    # Empty ranges are typically not meaningful and are usually rendered in the
                    # UI as `#REF!`.
                  "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                  "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                  "sheetId": 42, # The sheet this range is on.
                  "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                  "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                },
              ],
              "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
                "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                    # the format will be applied.
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
                "format": { # The format of a cell. # The format to apply.
                    # Conditional formatting can only apply a subset of formatting:
                    # bold, italic,
                    # strikethrough,
                    # foreground color &
                    # background color.
                  "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                    "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                        # the user's locale will be used if necessary for the given type.
                        # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                        # information about the supported patterns.
                    "type": "A String", # The type of the number format.
                        # When writing, this field must be set.
                  },
                  "textDirection": "A String", # The direction of the text in the cell.
                  "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                      # When updating padding, every field must be specified.
                    "top": 42, # The top padding of the cell.
                    "right": 42, # The right padding of the cell.
                    "bottom": 42, # The bottom padding of the cell.
                    "left": 42, # The left padding of the cell.
                  },
                  "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                  "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                      # Absent values indicate that the field isn't specified.
                    "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # True if the text is bold.
                    "strikethrough": True or False, # True if the text has a strikethrough.
                    "fontFamily": "A String", # The font family.
                    "fontSize": 42, # The size of the font.
                    "italic": True or False, # True if the text is italicized.
                    "underline": True or False, # True if the text is underlined.
                  },
                  "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                  "borders": { # The borders of the cell. # The borders of the cell.
                    "top": { # A border along a cell. # The top border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                    "right": { # A border along a cell. # The right border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                    "bottom": { # A border along a cell. # The bottom border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                    "left": { # A border along a cell. # The left border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                  },
                  "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                },
              },
              "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                  # the interpolation points listed. The format of a cell will vary
                  # based on its contents as compared to the values of the interpolation
                  # points.
                "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                    # These pin the gradient color scale according to the color,
                    # type and value chosen.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "type": "A String", # How the value should be interpreted.
                  "value": "A String", # The value this interpolation point uses.  May be a formula.
                      # Unused if type is MIN or
                      # MAX.
                },
                "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                    # These pin the gradient color scale according to the color,
                    # type and value chosen.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "type": "A String", # How the value should be interpreted.
                  "value": "A String", # The value this interpolation point uses.  May be a formula.
                      # Unused if type is MIN or
                      # MAX.
                },
                "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                    # These pin the gradient color scale according to the color,
                    # type and value chosen.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "type": "A String", # How the value should be interpreted.
                  "value": "A String", # The value this interpolation point uses.  May be a formula.
                      # Unused if type is MIN or
                      # MAX.
                },
              },
            },
          ],
          "merges": [ # The ranges that are merged together.
            { # A range on a sheet.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
          ],
          "basicFilter": { # The default filter associated with a sheet. # The filter on this sheet, if any.
            "range": { # A range on a sheet. # The range the filter covers.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
          "charts": [ # The specifications of every chart on this sheet.
            { # A chart embedded in a sheet.
              "chartId": 42, # The ID of the chart.
              "position": { # The position of an embedded object such as a chart. # The position of the chart.
                "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                    # is chosen for you. Used only when writing.
                "sheetId": 42, # The sheet this is on. Set only if the embedded object
                    # is on its own sheet. Must be non-negative.
                "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
                  "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                      # All indexes are zero-based.
                    "rowIndex": 42, # The row index of the coordinate.
                    "columnIndex": 42, # The column index of the coordinate.
                    "sheetId": 42, # The sheet this coordinate is on.
                  },
                  "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                      # from the anchor cell.
                  "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
                  "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                      # from the anchor cell.
                  "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
                },
              },
              "spec": { # The specifications of a chart. # The specification of the chart.
                "hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.
                "pieChart": { # A pie chart. # A pie chart specification.
                  "series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.
                    "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                      "sources": [ # The ranges of data for a series or domain.
                          # Exactly one dimension must have a length of 1,
                          # and all sources in the list must have the same dimension
                          # with length 1.
                          # The domain (if it exists) & all series must have the same number
                          # of source ranges. If using more than one source range, then the source
                          # range at a given offset must be contiguous across the domain and series.
                          #
                          # For example, these are valid configurations:
                          #
                          #     domain sources: A1:A5
                          #     series1 sources: B1:B5
                          #     series2 sources: D6:D10
                          #
                          #     domain sources: A1:A5, C10:C12
                          #     series1 sources: B1:B5, D10:D12
                          #     series2 sources: C1:C5, E10:E12
                        { # A range on a sheet.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                      ],
                    },
                  },
                  "domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.
                    "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                      "sources": [ # The ranges of data for a series or domain.
                          # Exactly one dimension must have a length of 1,
                          # and all sources in the list must have the same dimension
                          # with length 1.
                          # The domain (if it exists) & all series must have the same number
                          # of source ranges. If using more than one source range, then the source
                          # range at a given offset must be contiguous across the domain and series.
                          #
                          # For example, these are valid configurations:
                          #
                          #     domain sources: A1:A5
                          #     series1 sources: B1:B5
                          #     series2 sources: D6:D10
                          #
                          #     domain sources: A1:A5, C10:C12
                          #     series1 sources: B1:B5, D10:D12
                          #     series2 sources: C1:C5, E10:E12
                        { # A range on a sheet.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                      ],
                    },
                  },
                  "threeDimensional": True or False, # True if the pie is three dimensional.
                  "legendPosition": "A String", # Where the legend of the pie chart should be drawn.
                  "pieHole": 3.14, # The size of the hole in the pie chart.
                },
                "basicChart": { # The specification for a basic chart.  See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.
                    # See BasicChartType for the list of all
                    # charts this supports.
                    # of charts this supports.
                  "headerCount": 42, # The number of rows or columns in the data that are "headers".
                      # If not set, Google Sheets will guess how many rows are headers based
                      # on the data.
                      #
                      # (Note that BasicChartAxis.title may override the axis title
                      #  inferred from the header values.)
                  "series": [ # The data this chart is visualizing.
                    { # A single series of data in a chart.
                        # For example, if charting stock prices over time, multiple series may exist,
                        # one for the "Open Price", "High Price", "Low Price" and "Close Price".
                      "series": { # The data included in a domain or series. # The data being visualized in this chart series.
                        "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                          "sources": [ # The ranges of data for a series or domain.
                              # Exactly one dimension must have a length of 1,
                              # and all sources in the list must have the same dimension
                              # with length 1.
                              # The domain (if it exists) & all series must have the same number
                              # of source ranges. If using more than one source range, then the source
                              # range at a given offset must be contiguous across the domain and series.
                              #
                              # For example, these are valid configurations:
                              #
                              #     domain sources: A1:A5
                              #     series1 sources: B1:B5
                              #     series2 sources: D6:D10
                              #
                              #     domain sources: A1:A5, C10:C12
                              #     series1 sources: B1:B5, D10:D12
                              #     series2 sources: C1:C5, E10:E12
                            { # A range on a sheet.
                                # All indexes are zero-based.
                                # Indexes are half open, e.g the start index is inclusive
                                # and the end index is exclusive -- [start_index, end_index).
                                # Missing indexes indicate the range is unbounded on that side.
                                #
                                # For example, if `"Sheet1"` is sheet ID 0, then:
                                #
                                #   `Sheet1!A1:A1 == sheet_id: 0,
                                #                   start_row_index: 0, end_row_index: 1,
                                #                   start_column_index: 0, end_column_index: 1`
                                #
                                #   `Sheet1!A3:B4 == sheet_id: 0,
                                #                   start_row_index: 2, end_row_index: 4,
                                #                   start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A:B == sheet_id: 0,
                                #                 start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A5:B == sheet_id: 0,
                                #                  start_row_index: 4,
                                #                  start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1 == sheet_id:0`
                                #
                                # The start index must always be less than or equal to the end index.
                                # If the start index equals the end index, then the range is empty.
                                # Empty ranges are typically not meaningful and are usually rendered in the
                                # UI as `#REF!`.
                              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                              "sheetId": 42, # The sheet this range is on.
                              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                            },
                          ],
                        },
                      },
                      "targetAxis": "A String", # The minor axis that will specify the range of values for this series.
                          # For example, if charting stocks over time, the "Volume" series
                          # may want to be pinned to the right with the prices pinned to the left,
                          # because the scale of trading volume is different than the scale of
                          # prices.
                          # It is an error to specify an axis that isn't a valid minor axis
                          # for the chart's type.
                      "type": "A String", # The type of this series. Valid only if the
                          # chartType is
                          # COMBO.
                          # Different types will change the way the series is visualized.
                          # Only LINE, AREA,
                          # and COLUMN are supported.
                    },
                  ],
                  "legendPosition": "A String", # The position of the chart legend.
                  "domains": [ # The domain of data this is charting.
                      # Only a single domain is currently supported.
                    { # The domain of a chart.
                        # For example, if charting stock prices over time, this would be the date.
                      "domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,
                          # this is the data representing the dates.
                        "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                          "sources": [ # The ranges of data for a series or domain.
                              # Exactly one dimension must have a length of 1,
                              # and all sources in the list must have the same dimension
                              # with length 1.
                              # The domain (if it exists) & all series must have the same number
                              # of source ranges. If using more than one source range, then the source
                              # range at a given offset must be contiguous across the domain and series.
                              #
                              # For example, these are valid configurations:
                              #
                              #     domain sources: A1:A5
                              #     series1 sources: B1:B5
                              #     series2 sources: D6:D10
                              #
                              #     domain sources: A1:A5, C10:C12
                              #     series1 sources: B1:B5, D10:D12
                              #     series2 sources: C1:C5, E10:E12
                            { # A range on a sheet.
                                # All indexes are zero-based.
                                # Indexes are half open, e.g the start index is inclusive
                                # and the end index is exclusive -- [start_index, end_index).
                                # Missing indexes indicate the range is unbounded on that side.
                                #
                                # For example, if `"Sheet1"` is sheet ID 0, then:
                                #
                                #   `Sheet1!A1:A1 == sheet_id: 0,
                                #                   start_row_index: 0, end_row_index: 1,
                                #                   start_column_index: 0, end_column_index: 1`
                                #
                                #   `Sheet1!A3:B4 == sheet_id: 0,
                                #                   start_row_index: 2, end_row_index: 4,
                                #                   start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A:B == sheet_id: 0,
                                #                 start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A5:B == sheet_id: 0,
                                #                  start_row_index: 4,
                                #                  start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1 == sheet_id:0`
                                #
                                # The start index must always be less than or equal to the end index.
                                # If the start index equals the end index, then the range is empty.
                                # Empty ranges are typically not meaningful and are usually rendered in the
                                # UI as `#REF!`.
                              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                              "sheetId": 42, # The sheet this range is on.
                              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                            },
                          ],
                        },
                      },
                    },
                  ],
                  "chartType": "A String", # The type of the chart.
                  "axis": [ # The axis on the chart.
                    { # An axis of the chart.
                        # A chart may not have more than one axis per
                        # axis position.
                      "position": "A String", # The position of this axis.
                      "format": { # The format of a run of text in a cell. # The format of the title.
                          # Only valid if the axis is not associated with the domain.
                          # Absent values indicate that the field isn't specified.
                        "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # True if the text is bold.
                        "strikethrough": True or False, # True if the text has a strikethrough.
                        "fontFamily": "A String", # The font family.
                        "fontSize": 42, # The size of the font.
                        "italic": True or False, # True if the text is italicized.
                        "underline": True or False, # True if the text is underlined.
                      },
                      "title": "A String", # The title of this axis. If set, this overrides any title inferred
                          # from headers of the data.
                    },
                  ],
                },
                "title": "A String", # The title of the chart.
              },
            },
          ],
          "filterViews": [ # The filter views in this sheet.
            { # A filter view.
              "title": "A String", # The name of the filter view.
              "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
              "filterViewId": 42, # The ID of the filter view.
              "range": { # A range on a sheet. # The range this filter view covers.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
              "sortSpecs": [ # The sort order per column. Later specifications are used when values
                  # are equal in the earlier specifications.
                { # A sort order associated with a specific column or row.
                  "sortOrder": "A String", # The order data should be sorted.
                  "dimensionIndex": 42, # The dimension the sort should be applied to.
                },
              ],
              "criteria": { # The criteria for showing/hiding values per column.
                  # The map's key is the column index, and the value is the criteria for
                  # that column.
                "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                  "hiddenValues": [ # Values that should be hidden.
                    "A String",
                  ],
                  "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                      # (This does not override hiddenValues -- if a value is listed there,
                      #  it will still be hidden.)
                      # BooleanConditions are used by conditional formatting,
                      # data validation, and the criteria in filters.
                    "type": "A String", # The type of condition.
                    "values": [ # The values of the condition. The number of supported values depends
                        # on the condition type.  Some support zero values,
                        # others one or two values,
                        # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                      { # The value of the condition.
                        "relativeDate": "A String", # A relative date (based on the current date).
                            # Valid only if the type is
                            # DATE_BEFORE,
                            # DATE_AFTER,
                            # DATE_ON_OR_BEFORE or
                            # DATE_ON_OR_AFTER.
                            #
                            # Relative dates are not supported in data validation.
                            # They are supported only in conditional formatting and
                            # conditional filters.
                        "userEnteredValue": "A String", # A value the condition is based on.
                            # The value will be parsed as if the user typed into a cell.
                            # Formulas are supported (and must begin with an `=`).
                      },
                    ],
                  },
                },
              },
            },
          ],
          "protectedRanges": [ # The protected ranges in this sheet.
            { # A protected range.
              "unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.
                  # Unprotected ranges are only supported on protected sheets.
                { # A range on a sheet.
                    # All indexes are zero-based.
                    # Indexes are half open, e.g the start index is inclusive
                    # and the end index is exclusive -- [start_index, end_index).
                    # Missing indexes indicate the range is unbounded on that side.
                    #
                    # For example, if `"Sheet1"` is sheet ID 0, then:
                    #
                    #   `Sheet1!A1:A1 == sheet_id: 0,
                    #                   start_row_index: 0, end_row_index: 1,
                    #                   start_column_index: 0, end_column_index: 1`
                    #
                    #   `Sheet1!A3:B4 == sheet_id: 0,
                    #                   start_row_index: 2, end_row_index: 4,
                    #                   start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A:B == sheet_id: 0,
                    #                 start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A5:B == sheet_id: 0,
                    #                  start_row_index: 4,
                    #                  start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1 == sheet_id:0`
                    #
                    # The start index must always be less than or equal to the end index.
                    # If the start index equals the end index, then the range is empty.
                    # Empty ranges are typically not meaningful and are usually rendered in the
                    # UI as `#REF!`.
                  "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                  "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                  "sheetId": 42, # The sheet this range is on.
                  "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                  "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                },
              ],
              "requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the
                  # protected area.
                  # This field is read-only.
              "description": "A String", # The description of this protected range.
              "namedRangeId": "A String", # The named range this protected range is backed by, if any.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
              "editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.
                  # This field is only visible to users with edit access to the protected
                  # range and the document.
                  # Editors are not supported with warning_only protection.
                "domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected
                    # range.  Domain protection is only supported on documents within a domain.
                "users": [ # The email addresses of users with edit access to the protected range.
                  "A String",
                ],
                "groups": [ # The email addresses of groups with edit access to the protected range.
                  "A String",
                ],
              },
              "protectedRangeId": 42, # The ID of the protected range.
                  # This field is read-only.
              "warningOnly": True or False, # True if this protected range will show a warning when editing.
                  # Warning-based protection means that every user can edit data in the
                  # protected range, except editing will prompt a warning asking the user
                  # to confirm the edit.
                  #
                  # When writing: if this field is true, then editors is ignored.
                  # Additionally, if this field is changed from true to false and the
                  # `editors` field is not set (nor included in the field mask), then
                  # the editors will be set to all the editors in the document.
              "range": { # A range on a sheet. # The range that is being protected.
                  # The range may be fully unbounded, in which case this is considered
                  # a protected sheet.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            },
          ],
          "data": [ # Data in the grid, if this is a grid sheet.
              # The number of GridData objects returned is dependent on the number of
              # ranges requested on this sheet. For example, if this is representing
              # `Sheet1`, and the spreadsheet was requested with ranges
              # `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a
              # startRow/startColumn of `0`,
              # while the second one will have `startRow 14` (zero-based row 15),
              # and `startColumn 3` (zero-based column D).
            { # Data in the grid, as well as metadata about the dimensions.
              "startRow": 42, # The first row this GridData refers to, zero-based.
              "rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
                  # in start_row.
                { # Properties about a dimension.
                  "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
                  "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
                  "hiddenByFilter": True or False, # True if this dimension is being filtered.
                      # This field is read-only.
                },
              ],
              "startColumn": 42, # The first column this GridData refers to, zero-based.
              "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
                  # in start_column.
                { # Properties about a dimension.
                  "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
                  "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
                  "hiddenByFilter": True or False, # True if this dimension is being filtered.
                      # This field is read-only.
                },
              ],
              "rowData": [ # The data in the grid, one entry per row,
                  # starting with the row in startRow.
                  # The values in RowData will correspond to columns starting
                  # at start_column.
                { # Data about each cell in a row.
                  "values": [ # The values in the row, one per column.
                    { # Data about a specific cell.
                      "pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself
                          # is computed dynamically based on its data, grouping, filters, values,
                          # etc. Only the top-left cell of the pivot table contains the pivot table
                          # definition. The other cells will contain the calculated values of the
                          # results of the pivot in their effective_value fields.
                        "valueLayout": "A String", # Whether values should be listed horizontally (as columns)
                            # or vertically (as rows).
                        "rows": [ # Each row grouping in the pivot table.
                          { # A single grouping (either row or column) in a pivot table.
                            "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                            "valueMetadata": [ # Metadata about values in the grouping.
                              { # Metadata about a value in a pivot grouping.
                                "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                                "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                    # (Note that formulaValue is not valid,
                                    #  because the values will be calculated.)
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              },
                            ],
                            "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                                # If not specified, sorting is alphabetical by this group's values.
                              "buckets": [ # Determines the bucket from which values are chosen to sort.
                                  #
                                  # For example, in a pivot table with one row group & two column groups,
                                  # the row group can list up to two values. The first value corresponds
                                  # to a value within the first column group, and the second value
                                  # corresponds to a value in the second column group.  If no values
                                  # are listed, this would indicate that the row should be sorted according
                                  # to the "Grand Total" over the column groups. If a single value is listed,
                                  # this would correspond to using the "Total" of that bucket.
                                { # The kinds of value that a cell in a spreadsheet can have.
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              ],
                              "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                                  # grouping should be sorted by.
                            },
                            "sortOrder": "A String", # The order the values in this group should be sorted.
                            "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                                #
                                # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                                # means this group refers to column `C`, whereas the offset `1` would refer
                                # to column `D`.
                          },
                        ],
                        "source": { # A range on a sheet. # The range the pivot table is reading data from.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                        "values": [ # A list of values to include in the pivot table.
                          { # The definition of how a value in a pivot table should be calculated.
                            "formula": "A String", # A custom formula to calculate the value.  The formula must start
                                # with an `=` character.
                            "summarizeFunction": "A String", # A function to summarize the value.
                                # If formula is set, the only supported values are
                                # SUM and
                                # CUSTOM.
                                # If sourceColumnOffset is set, then `CUSTOM`
                                # is not supported.
                            "sourceColumnOffset": 42, # The column offset of the source range that this value reads from.
                                #
                                # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                                # means this value refers to column `C`, whereas the offset `1` would
                                # refer to column `D`.
                            "name": "A String", # A name to use for the value. This is only used if formula was set.
                                # Otherwise, the column name is used.
                          },
                        ],
                        "criteria": { # An optional mapping of filters per source column offset.
                            #
                            # The filters will be applied before aggregating data into the pivot table.
                            # The map's key is the column offset of the source range that you want to
                            # filter, and the value is the criteria for that column.
                            #
                            # For example, if the source was `C10:E15`, a key of `0` will have the filter
                            # for column `C`, whereas the key `1` is for column `D`.
                          "a_key": { # Criteria for showing/hiding rows in a pivot table.
                            "visibleValues": [ # Values that should be included.  Values not listed here are excluded.
                              "A String",
                            ],
                          },
                        },
                        "columns": [ # Each column grouping in the pivot table.
                          { # A single grouping (either row or column) in a pivot table.
                            "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                            "valueMetadata": [ # Metadata about values in the grouping.
                              { # Metadata about a value in a pivot grouping.
                                "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                                "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                    # (Note that formulaValue is not valid,
                                    #  because the values will be calculated.)
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              },
                            ],
                            "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                                # If not specified, sorting is alphabetical by this group's values.
                              "buckets": [ # Determines the bucket from which values are chosen to sort.
                                  #
                                  # For example, in a pivot table with one row group & two column groups,
                                  # the row group can list up to two values. The first value corresponds
                                  # to a value within the first column group, and the second value
                                  # corresponds to a value in the second column group.  If no values
                                  # are listed, this would indicate that the row should be sorted according
                                  # to the "Grand Total" over the column groups. If a single value is listed,
                                  # this would correspond to using the "Total" of that bucket.
                                { # The kinds of value that a cell in a spreadsheet can have.
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              ],
                              "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                                  # grouping should be sorted by.
                            },
                            "sortOrder": "A String", # The order the values in this group should be sorted.
                            "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                                #
                                # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                                # means this group refers to column `C`, whereas the offset `1` would refer
                                # to column `D`.
                          },
                        ],
                      },
                      "hyperlink": "A String", # A hyperlink this cell points to, if any.
                          # This field is read-only.  (To set it, use a `=HYPERLINK` formula.)
                      "effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be
                          # the calculated value.  For cells with literals, this will be
                          # the same as the user_entered_value.
                          # This field is read-only.
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                      "formattedValue": "A String", # The formatted value of the cell.
                          # This is the value as it's shown to the user.
                          # This field is read-only.
                      "userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
                          # Note: Dates, Times and DateTimes are represented as doubles in
                          # serial number format.
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                      "note": "A String", # Any note on the cell.
                      "effectiveFormat": { # The format of a cell. # The effective format being used by the cell.
                          # This includes the results of applying any conditional formatting and,
                          # if the cell contains a formula, the computed number format.
                          # If the effective format is the default format, effective format will
                          # not be written.
                          # This field is read-only.
                        "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                          "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                              # the user's locale will be used if necessary for the given type.
                              # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                              # information about the supported patterns.
                          "type": "A String", # The type of the number format.
                              # When writing, this field must be set.
                        },
                        "textDirection": "A String", # The direction of the text in the cell.
                        "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                            # When updating padding, every field must be specified.
                          "top": 42, # The top padding of the cell.
                          "right": 42, # The right padding of the cell.
                          "bottom": 42, # The bottom padding of the cell.
                          "left": 42, # The left padding of the cell.
                        },
                        "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                        "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                        "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                            # Absent values indicate that the field isn't specified.
                          "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "bold": True or False, # True if the text is bold.
                          "strikethrough": True or False, # True if the text has a strikethrough.
                          "fontFamily": "A String", # The font family.
                          "fontSize": 42, # The size of the font.
                          "italic": True or False, # True if the text is italicized.
                          "underline": True or False, # True if the text is underlined.
                        },
                        "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                        "borders": { # The borders of the cell. # The borders of the cell.
                          "top": { # A border along a cell. # The top border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "right": { # A border along a cell. # The right border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "bottom": { # A border along a cell. # The bottom border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "left": { # A border along a cell. # The left border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                        },
                        "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                      },
                      "userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
                          #
                          # When writing, the new format will be merged with the existing format.
                        "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                          "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                              # the user's locale will be used if necessary for the given type.
                              # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                              # information about the supported patterns.
                          "type": "A String", # The type of the number format.
                              # When writing, this field must be set.
                        },
                        "textDirection": "A String", # The direction of the text in the cell.
                        "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                            # When updating padding, every field must be specified.
                          "top": 42, # The top padding of the cell.
                          "right": 42, # The right padding of the cell.
                          "bottom": 42, # The bottom padding of the cell.
                          "left": 42, # The left padding of the cell.
                        },
                        "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                        "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                        "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                            # Absent values indicate that the field isn't specified.
                          "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "bold": True or False, # True if the text is bold.
                          "strikethrough": True or False, # True if the text has a strikethrough.
                          "fontFamily": "A String", # The font family.
                          "fontSize": 42, # The size of the font.
                          "italic": True or False, # True if the text is italicized.
                          "underline": True or False, # True if the text is underlined.
                        },
                        "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                        "borders": { # The borders of the cell. # The borders of the cell.
                          "top": { # A border along a cell. # The top border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "right": { # A border along a cell. # The right border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "bottom": { # A border along a cell. # The bottom border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "left": { # A border along a cell. # The left border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                        },
                        "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                      },
                      "dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
                          #
                          # When writing, the new data validation rule will overwrite any prior rule.
                        "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                            # If true, "List" conditions will show a dropdown.
                        "strict": True or False, # True if invalid data should be rejected.
                        "inputMessage": "A String", # A message to show the user when adding data to the cell.
                        "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                            # BooleanConditions are used by conditional formatting,
                            # data validation, and the criteria in filters.
                          "type": "A String", # The type of condition.
                          "values": [ # The values of the condition. The number of supported values depends
                              # on the condition type.  Some support zero values,
                              # others one or two values,
                              # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                            { # The value of the condition.
                              "relativeDate": "A String", # A relative date (based on the current date).
                                  # Valid only if the type is
                                  # DATE_BEFORE,
                                  # DATE_AFTER,
                                  # DATE_ON_OR_BEFORE or
                                  # DATE_ON_OR_AFTER.
                                  #
                                  # Relative dates are not supported in data validation.
                                  # They are supported only in conditional formatting and
                                  # conditional filters.
                              "userEnteredValue": "A String", # A value the condition is based on.
                                  # The value will be parsed as if the user typed into a cell.
                                  # Formulas are supported (and must begin with an `=`).
                            },
                          ],
                        },
                      },
                      "textFormatRuns": [ # Runs of rich text applied to subsections of the cell.  Runs are only valid
                          # on user entered strings, not formulas, bools, or numbers.
                          # Runs start at specific indexes in the text and continue until the next
                          # run. Properties of a run will continue unless explicitly changed
                          # in a subsequent run (and properties of the first run will continue
                          # the properties of the cell unless explicitly changed).
                          #
                          # When writing, the new runs will overwrite any prior runs.  When writing a
                          # new user_entered_value, previous runs will be erased.
                        { # A run of a text format. The format of this run continues until the start
                            # index of the next run.
                            # When updating, all fields must be set.
                          "startIndex": 42, # The character index where this run starts.
                          "format": { # The format of a run of text in a cell. # The format of this run.  Absent values inherit the cell's format.
                              # Absent values indicate that the field isn't specified.
                            "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "bold": True or False, # True if the text is bold.
                            "strikethrough": True or False, # True if the text has a strikethrough.
                            "fontFamily": "A String", # The font family.
                            "fontSize": 42, # The size of the font.
                            "italic": True or False, # True if the text is italicized.
                            "underline": True or False, # True if the text is underlined.
                          },
                        },
                      ],
                    },
                  ],
                },
              ],
            },
          ],
          "properties": { # Properties of a sheet. # The properties of the sheet.
            "sheetType": "A String", # The type of sheet. Defaults to GRID.
                # This field cannot be changed once set.
            "index": 42, # The index of the sheet within the spreadsheet.
                # When adding or updating sheet properties, if this field
                # is excluded then the sheet will be added or moved to the end
                # of the sheet list.
            "title": "A String", # The name of the sheet.
            "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
                # (If the sheet is an object sheet, containing a chart or image, then
                # this field will be absent.)
                # When writing it is an error to set any grid properties on non-grid sheets.
              "columnCount": 42, # The number of columns in the grid.
              "rowCount": 42, # The number of rows in the grid.
              "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
              "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
              "frozenRowCount": 42, # The number of rows that are frozen in the grid.
            },
            "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
            "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
            "sheetId": 42, # The ID of the sheet. Must be non-negative.
                # This field cannot be changed once set.
          },
        },
      ],
    }
get(spreadsheetId, ranges=None, x__xgafv=None, includeGridData=None) 
Returns the spreadsheet at the given ID.
The caller must specify the spreadsheet ID.

By default, data within grids will not be returned.
You can include grid data one of two ways:

* Specify a field mask listing your desired fields using the `fields` URL
parameter in HTTP

* Set the includeGridData
URL parameter to true.  If a field mask is set, the `includeGridData`
parameter is ignored

For large spreadsheets, it is recommended to retrieve only the specific
fields of the spreadsheet that you want.

To retrieve only subsets of the spreadsheet, use the
ranges URL parameter.
Multiple ranges can be specified.  Limiting the range will
return only the portions of the spreadsheet that intersect the requested
ranges. Ranges are specified using A1 notation.

Args:
  spreadsheetId: string, The spreadsheet to request. (required)
  ranges: string, The ranges to retrieve from the spreadsheet. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  includeGridData: boolean, True if grid data should be returned.
This parameter is ignored if a field mask was set in the request.

Returns:
  An object of the form:

    { # Resource that represents a spreadsheet.
      "spreadsheetId": "A String", # The ID of the spreadsheet.
          # This field is read-only.
      "namedRanges": [ # The named ranges defined in a spreadsheet.
        { # A named range.
          "namedRangeId": "A String", # The ID of the named range.
          "range": { # A range on a sheet. # The range this represents.
              # All indexes are zero-based.
              # Indexes are half open, e.g the start index is inclusive
              # and the end index is exclusive -- [start_index, end_index).
              # Missing indexes indicate the range is unbounded on that side.
              #
              # For example, if `"Sheet1"` is sheet ID 0, then:
              #
              #   `Sheet1!A1:A1 == sheet_id: 0,
              #                   start_row_index: 0, end_row_index: 1,
              #                   start_column_index: 0, end_column_index: 1`
              #
              #   `Sheet1!A3:B4 == sheet_id: 0,
              #                   start_row_index: 2, end_row_index: 4,
              #                   start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A:B == sheet_id: 0,
              #                 start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1!A5:B == sheet_id: 0,
              #                  start_row_index: 4,
              #                  start_column_index: 0, end_column_index: 2`
              #
              #   `Sheet1 == sheet_id:0`
              #
              # The start index must always be less than or equal to the end index.
              # If the start index equals the end index, then the range is empty.
              # Empty ranges are typically not meaningful and are usually rendered in the
              # UI as `#REF!`.
            "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
            "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
            "sheetId": 42, # The sheet this range is on.
            "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
            "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
          },
          "name": "A String", # The name of the named range.
        },
      ],
      "properties": { # Properties of a spreadsheet. # Overall properties of a spreadsheet.
        "locale": "A String", # The locale of the spreadsheet in one of the following formats:
            #
            # * an ISO 639-1 language code such as `en`
            #
            # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
            #
            # * a combination of the ISO language code and country code, such as `en_US`
            #
            # Note: when updating this field, not all locales/languages are supported.
        "timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as
            # `America/New_York`. If the time zone isn't recognized, this may
            # be a custom time zone such as `GMT-07:00`.
        "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
        "defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
            # CellData.effectiveFormat will not be set if the
            # cell's format is equal to this default format.
            # This field is read-only.
          "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
            "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                # the user's locale will be used if necessary for the given type.
                # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                # information about the supported patterns.
            "type": "A String", # The type of the number format.
                # When writing, this field must be set.
          },
          "textDirection": "A String", # The direction of the text in the cell.
          "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
              # When updating padding, every field must be specified.
            "top": 42, # The top padding of the cell.
            "right": 42, # The right padding of the cell.
            "bottom": 42, # The bottom padding of the cell.
            "left": 42, # The left padding of the cell.
          },
          "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
          "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
              # for simplicity of conversion to/from color representations in various
              # languages over compactness; for example, the fields of this representation
              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
              # method in iOS; and, with just a little work, it can be easily formatted into
              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
              #
              # Example (Java):
              #
              #      import com.google.type.Color;
              #
              #      // ...
              #      public static java.awt.Color fromProto(Color protocolor) {
              #        float alpha = protocolor.hasAlpha()
              #            ? protocolor.getAlpha().getValue()
              #            : 1.0;
              #
              #        return new java.awt.Color(
              #            protocolor.getRed(),
              #            protocolor.getGreen(),
              #            protocolor.getBlue(),
              #            alpha);
              #      }
              #
              #      public static Color toProto(java.awt.Color color) {
              #        float red = (float) color.getRed();
              #        float green = (float) color.getGreen();
              #        float blue = (float) color.getBlue();
              #        float denominator = 255.0;
              #        Color.Builder resultBuilder =
              #            Color
              #                .newBuilder()
              #                .setRed(red / denominator)
              #                .setGreen(green / denominator)
              #                .setBlue(blue / denominator);
              #        int alpha = color.getAlpha();
              #        if (alpha != 255) {
              #          result.setAlpha(
              #              FloatValue
              #                  .newBuilder()
              #                  .setValue(((float) alpha) / denominator)
              #                  .build());
              #        }
              #        return resultBuilder.build();
              #      }
              #      // ...
              #
              # Example (iOS / Obj-C):
              #
              #      // ...
              #      static UIColor* fromProto(Color* protocolor) {
              #         float red = [protocolor red];
              #         float green = [protocolor green];
              #         float blue = [protocolor blue];
              #         FloatValue* alpha_wrapper = [protocolor alpha];
              #         float alpha = 1.0;
              #         if (alpha_wrapper != nil) {
              #           alpha = [alpha_wrapper value];
              #         }
              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
              #      }
              #
              #      static Color* toProto(UIColor* color) {
              #          CGFloat red, green, blue, alpha;
              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
              #            return nil;
              #          }
              #          Color* result = [Color alloc] init];
              #          [result setRed:red];
              #          [result setGreen:green];
              #          [result setBlue:blue];
              #          if (alpha <= 0.9999) {
              #            [result setAlpha:floatWrapperWithValue(alpha)];
              #          }
              #          [result autorelease];
              #          return result;
              #     }
              #     // ...
              #
              #  Example (JavaScript):
              #
              #     // ...
              #
              #     var protoToCssColor = function(rgb_color) {
              #        var redFrac = rgb_color.red || 0.0;
              #        var greenFrac = rgb_color.green || 0.0;
              #        var blueFrac = rgb_color.blue || 0.0;
              #        var red = Math.floor(redFrac * 255);
              #        var green = Math.floor(greenFrac * 255);
              #        var blue = Math.floor(blueFrac * 255);
              #
              #        if (!('alpha' in rgb_color)) {
              #           return rgbToCssColor_(red, green, blue);
              #        }
              #
              #        var alphaFrac = rgb_color.alpha.value || 0.0;
              #        var rgbParams = [red, green, blue].join(',');
              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
              #     };
              #
              #     var rgbToCssColor_ = function(red, green, blue) {
              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
              #       var hexString = rgbNumber.toString(16);
              #       var missingZeros = 6 - hexString.length;
              #       var resultBuilder = ['#'];
              #       for (var i = 0; i < missingZeros; i++) {
              #          resultBuilder.push('0');
              #       }
              #       resultBuilder.push(hexString);
              #       return resultBuilder.join('');
              #     };
              #
              #     // ...
            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                # the final pixel color is defined by the equation:
                #
                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                #
                # This means that a value of 1.0 corresponds to a solid color, whereas
                # a value of 0.0 corresponds to a completely transparent color. This
                # uses a wrapper message rather than a simple float scalar so that it is
                # possible to distinguish between a default value and the value being unset.
                # If omitted, this color object is to be rendered as a solid color
                # (as if the alpha value had been explicitly given with a value of 1.0).
            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
          },
          "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
          "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
              # Absent values indicate that the field isn't specified.
            "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "bold": True or False, # True if the text is bold.
            "strikethrough": True or False, # True if the text has a strikethrough.
            "fontFamily": "A String", # The font family.
            "fontSize": 42, # The size of the font.
            "italic": True or False, # True if the text is italicized.
            "underline": True or False, # True if the text is underlined.
          },
          "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
          "borders": { # The borders of the cell. # The borders of the cell.
            "top": { # A border along a cell. # The top border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
            "right": { # A border along a cell. # The right border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
            "bottom": { # A border along a cell. # The bottom border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
            "left": { # A border along a cell. # The left border of the cell.
              "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                  # for simplicity of conversion to/from color representations in various
                  # languages over compactness; for example, the fields of this representation
                  # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                  # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                  # method in iOS; and, with just a little work, it can be easily formatted into
                  # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                  #
                  # Example (Java):
                  #
                  #      import com.google.type.Color;
                  #
                  #      // ...
                  #      public static java.awt.Color fromProto(Color protocolor) {
                  #        float alpha = protocolor.hasAlpha()
                  #            ? protocolor.getAlpha().getValue()
                  #            : 1.0;
                  #
                  #        return new java.awt.Color(
                  #            protocolor.getRed(),
                  #            protocolor.getGreen(),
                  #            protocolor.getBlue(),
                  #            alpha);
                  #      }
                  #
                  #      public static Color toProto(java.awt.Color color) {
                  #        float red = (float) color.getRed();
                  #        float green = (float) color.getGreen();
                  #        float blue = (float) color.getBlue();
                  #        float denominator = 255.0;
                  #        Color.Builder resultBuilder =
                  #            Color
                  #                .newBuilder()
                  #                .setRed(red / denominator)
                  #                .setGreen(green / denominator)
                  #                .setBlue(blue / denominator);
                  #        int alpha = color.getAlpha();
                  #        if (alpha != 255) {
                  #          result.setAlpha(
                  #              FloatValue
                  #                  .newBuilder()
                  #                  .setValue(((float) alpha) / denominator)
                  #                  .build());
                  #        }
                  #        return resultBuilder.build();
                  #      }
                  #      // ...
                  #
                  # Example (iOS / Obj-C):
                  #
                  #      // ...
                  #      static UIColor* fromProto(Color* protocolor) {
                  #         float red = [protocolor red];
                  #         float green = [protocolor green];
                  #         float blue = [protocolor blue];
                  #         FloatValue* alpha_wrapper = [protocolor alpha];
                  #         float alpha = 1.0;
                  #         if (alpha_wrapper != nil) {
                  #           alpha = [alpha_wrapper value];
                  #         }
                  #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                  #      }
                  #
                  #      static Color* toProto(UIColor* color) {
                  #          CGFloat red, green, blue, alpha;
                  #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                  #            return nil;
                  #          }
                  #          Color* result = [Color alloc] init];
                  #          [result setRed:red];
                  #          [result setGreen:green];
                  #          [result setBlue:blue];
                  #          if (alpha <= 0.9999) {
                  #            [result setAlpha:floatWrapperWithValue(alpha)];
                  #          }
                  #          [result autorelease];
                  #          return result;
                  #     }
                  #     // ...
                  #
                  #  Example (JavaScript):
                  #
                  #     // ...
                  #
                  #     var protoToCssColor = function(rgb_color) {
                  #        var redFrac = rgb_color.red || 0.0;
                  #        var greenFrac = rgb_color.green || 0.0;
                  #        var blueFrac = rgb_color.blue || 0.0;
                  #        var red = Math.floor(redFrac * 255);
                  #        var green = Math.floor(greenFrac * 255);
                  #        var blue = Math.floor(blueFrac * 255);
                  #
                  #        if (!('alpha' in rgb_color)) {
                  #           return rgbToCssColor_(red, green, blue);
                  #        }
                  #
                  #        var alphaFrac = rgb_color.alpha.value || 0.0;
                  #        var rgbParams = [red, green, blue].join(',');
                  #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                  #     };
                  #
                  #     var rgbToCssColor_ = function(red, green, blue) {
                  #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                  #       var hexString = rgbNumber.toString(16);
                  #       var missingZeros = 6 - hexString.length;
                  #       var resultBuilder = ['#'];
                  #       for (var i = 0; i < missingZeros; i++) {
                  #          resultBuilder.push('0');
                  #       }
                  #       resultBuilder.push(hexString);
                  #       return resultBuilder.join('');
                  #     };
                  #
                  #     // ...
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                    # the final pixel color is defined by the equation:
                    #
                    #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                    #
                    # This means that a value of 1.0 corresponds to a solid color, whereas
                    # a value of 0.0 corresponds to a completely transparent color. This
                    # uses a wrapper message rather than a simple float scalar so that it is
                    # possible to distinguish between a default value and the value being unset.
                    # If omitted, this color object is to be rendered as a solid color
                    # (as if the alpha value had been explicitly given with a value of 1.0).
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "width": 42, # The width of the border, in pixels.
                  # Deprecated; the width is determined by the "style" field.
              "style": "A String", # The style of the border.
            },
          },
          "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
        },
        "title": "A String", # The title of the spreadsheet.
      },
      "sheets": [ # The sheets that are part of a spreadsheet.
        { # A sheet in a spreadsheet.
          "conditionalFormats": [ # The conditional format rules in this sheet.
            { # A rule describing a conditional format.
              "ranges": [ # The ranges that will be formatted if the condition is true.
                  # All the ranges must be on the same grid.
                { # A range on a sheet.
                    # All indexes are zero-based.
                    # Indexes are half open, e.g the start index is inclusive
                    # and the end index is exclusive -- [start_index, end_index).
                    # Missing indexes indicate the range is unbounded on that side.
                    #
                    # For example, if `"Sheet1"` is sheet ID 0, then:
                    #
                    #   `Sheet1!A1:A1 == sheet_id: 0,
                    #                   start_row_index: 0, end_row_index: 1,
                    #                   start_column_index: 0, end_column_index: 1`
                    #
                    #   `Sheet1!A3:B4 == sheet_id: 0,
                    #                   start_row_index: 2, end_row_index: 4,
                    #                   start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A:B == sheet_id: 0,
                    #                 start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A5:B == sheet_id: 0,
                    #                  start_row_index: 4,
                    #                  start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1 == sheet_id:0`
                    #
                    # The start index must always be less than or equal to the end index.
                    # If the start index equals the end index, then the range is empty.
                    # Empty ranges are typically not meaningful and are usually rendered in the
                    # UI as `#REF!`.
                  "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                  "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                  "sheetId": 42, # The sheet this range is on.
                  "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                  "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                },
              ],
              "booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.
                "condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,
                    # the format will be applied.
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
                "format": { # The format of a cell. # The format to apply.
                    # Conditional formatting can only apply a subset of formatting:
                    # bold, italic,
                    # strikethrough,
                    # foreground color &
                    # background color.
                  "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                    "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                        # the user's locale will be used if necessary for the given type.
                        # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                        # information about the supported patterns.
                    "type": "A String", # The type of the number format.
                        # When writing, this field must be set.
                  },
                  "textDirection": "A String", # The direction of the text in the cell.
                  "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                      # When updating padding, every field must be specified.
                    "top": 42, # The top padding of the cell.
                    "right": 42, # The right padding of the cell.
                    "bottom": 42, # The bottom padding of the cell.
                    "left": 42, # The left padding of the cell.
                  },
                  "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                  "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                      # Absent values indicate that the field isn't specified.
                    "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                        # for simplicity of conversion to/from color representations in various
                        # languages over compactness; for example, the fields of this representation
                        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                        # method in iOS; and, with just a little work, it can be easily formatted into
                        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                        #
                        # Example (Java):
                        #
                        #      import com.google.type.Color;
                        #
                        #      // ...
                        #      public static java.awt.Color fromProto(Color protocolor) {
                        #        float alpha = protocolor.hasAlpha()
                        #            ? protocolor.getAlpha().getValue()
                        #            : 1.0;
                        #
                        #        return new java.awt.Color(
                        #            protocolor.getRed(),
                        #            protocolor.getGreen(),
                        #            protocolor.getBlue(),
                        #            alpha);
                        #      }
                        #
                        #      public static Color toProto(java.awt.Color color) {
                        #        float red = (float) color.getRed();
                        #        float green = (float) color.getGreen();
                        #        float blue = (float) color.getBlue();
                        #        float denominator = 255.0;
                        #        Color.Builder resultBuilder =
                        #            Color
                        #                .newBuilder()
                        #                .setRed(red / denominator)
                        #                .setGreen(green / denominator)
                        #                .setBlue(blue / denominator);
                        #        int alpha = color.getAlpha();
                        #        if (alpha != 255) {
                        #          result.setAlpha(
                        #              FloatValue
                        #                  .newBuilder()
                        #                  .setValue(((float) alpha) / denominator)
                        #                  .build());
                        #        }
                        #        return resultBuilder.build();
                        #      }
                        #      // ...
                        #
                        # Example (iOS / Obj-C):
                        #
                        #      // ...
                        #      static UIColor* fromProto(Color* protocolor) {
                        #         float red = [protocolor red];
                        #         float green = [protocolor green];
                        #         float blue = [protocolor blue];
                        #         FloatValue* alpha_wrapper = [protocolor alpha];
                        #         float alpha = 1.0;
                        #         if (alpha_wrapper != nil) {
                        #           alpha = [alpha_wrapper value];
                        #         }
                        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                        #      }
                        #
                        #      static Color* toProto(UIColor* color) {
                        #          CGFloat red, green, blue, alpha;
                        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                        #            return nil;
                        #          }
                        #          Color* result = [Color alloc] init];
                        #          [result setRed:red];
                        #          [result setGreen:green];
                        #          [result setBlue:blue];
                        #          if (alpha <= 0.9999) {
                        #            [result setAlpha:floatWrapperWithValue(alpha)];
                        #          }
                        #          [result autorelease];
                        #          return result;
                        #     }
                        #     // ...
                        #
                        #  Example (JavaScript):
                        #
                        #     // ...
                        #
                        #     var protoToCssColor = function(rgb_color) {
                        #        var redFrac = rgb_color.red || 0.0;
                        #        var greenFrac = rgb_color.green || 0.0;
                        #        var blueFrac = rgb_color.blue || 0.0;
                        #        var red = Math.floor(redFrac * 255);
                        #        var green = Math.floor(greenFrac * 255);
                        #        var blue = Math.floor(blueFrac * 255);
                        #
                        #        if (!('alpha' in rgb_color)) {
                        #           return rgbToCssColor_(red, green, blue);
                        #        }
                        #
                        #        var alphaFrac = rgb_color.alpha.value || 0.0;
                        #        var rgbParams = [red, green, blue].join(',');
                        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                        #     };
                        #
                        #     var rgbToCssColor_ = function(red, green, blue) {
                        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                        #       var hexString = rgbNumber.toString(16);
                        #       var missingZeros = 6 - hexString.length;
                        #       var resultBuilder = ['#'];
                        #       for (var i = 0; i < missingZeros; i++) {
                        #          resultBuilder.push('0');
                        #       }
                        #       resultBuilder.push(hexString);
                        #       return resultBuilder.join('');
                        #     };
                        #
                        #     // ...
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                          # the final pixel color is defined by the equation:
                          #
                          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                          #
                          # This means that a value of 1.0 corresponds to a solid color, whereas
                          # a value of 0.0 corresponds to a completely transparent color. This
                          # uses a wrapper message rather than a simple float scalar so that it is
                          # possible to distinguish between a default value and the value being unset.
                          # If omitted, this color object is to be rendered as a solid color
                          # (as if the alpha value had been explicitly given with a value of 1.0).
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # True if the text is bold.
                    "strikethrough": True or False, # True if the text has a strikethrough.
                    "fontFamily": "A String", # The font family.
                    "fontSize": 42, # The size of the font.
                    "italic": True or False, # True if the text is italicized.
                    "underline": True or False, # True if the text is underlined.
                  },
                  "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                  "borders": { # The borders of the cell. # The borders of the cell.
                    "top": { # A border along a cell. # The top border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                    "right": { # A border along a cell. # The right border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                    "bottom": { # A border along a cell. # The bottom border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                    "left": { # A border along a cell. # The left border of the cell.
                      "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                          # for simplicity of conversion to/from color representations in various
                          # languages over compactness; for example, the fields of this representation
                          # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                          # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                          # method in iOS; and, with just a little work, it can be easily formatted into
                          # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                          #
                          # Example (Java):
                          #
                          #      import com.google.type.Color;
                          #
                          #      // ...
                          #      public static java.awt.Color fromProto(Color protocolor) {
                          #        float alpha = protocolor.hasAlpha()
                          #            ? protocolor.getAlpha().getValue()
                          #            : 1.0;
                          #
                          #        return new java.awt.Color(
                          #            protocolor.getRed(),
                          #            protocolor.getGreen(),
                          #            protocolor.getBlue(),
                          #            alpha);
                          #      }
                          #
                          #      public static Color toProto(java.awt.Color color) {
                          #        float red = (float) color.getRed();
                          #        float green = (float) color.getGreen();
                          #        float blue = (float) color.getBlue();
                          #        float denominator = 255.0;
                          #        Color.Builder resultBuilder =
                          #            Color
                          #                .newBuilder()
                          #                .setRed(red / denominator)
                          #                .setGreen(green / denominator)
                          #                .setBlue(blue / denominator);
                          #        int alpha = color.getAlpha();
                          #        if (alpha != 255) {
                          #          result.setAlpha(
                          #              FloatValue
                          #                  .newBuilder()
                          #                  .setValue(((float) alpha) / denominator)
                          #                  .build());
                          #        }
                          #        return resultBuilder.build();
                          #      }
                          #      // ...
                          #
                          # Example (iOS / Obj-C):
                          #
                          #      // ...
                          #      static UIColor* fromProto(Color* protocolor) {
                          #         float red = [protocolor red];
                          #         float green = [protocolor green];
                          #         float blue = [protocolor blue];
                          #         FloatValue* alpha_wrapper = [protocolor alpha];
                          #         float alpha = 1.0;
                          #         if (alpha_wrapper != nil) {
                          #           alpha = [alpha_wrapper value];
                          #         }
                          #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                          #      }
                          #
                          #      static Color* toProto(UIColor* color) {
                          #          CGFloat red, green, blue, alpha;
                          #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                          #            return nil;
                          #          }
                          #          Color* result = [Color alloc] init];
                          #          [result setRed:red];
                          #          [result setGreen:green];
                          #          [result setBlue:blue];
                          #          if (alpha <= 0.9999) {
                          #            [result setAlpha:floatWrapperWithValue(alpha)];
                          #          }
                          #          [result autorelease];
                          #          return result;
                          #     }
                          #     // ...
                          #
                          #  Example (JavaScript):
                          #
                          #     // ...
                          #
                          #     var protoToCssColor = function(rgb_color) {
                          #        var redFrac = rgb_color.red || 0.0;
                          #        var greenFrac = rgb_color.green || 0.0;
                          #        var blueFrac = rgb_color.blue || 0.0;
                          #        var red = Math.floor(redFrac * 255);
                          #        var green = Math.floor(greenFrac * 255);
                          #        var blue = Math.floor(blueFrac * 255);
                          #
                          #        if (!('alpha' in rgb_color)) {
                          #           return rgbToCssColor_(red, green, blue);
                          #        }
                          #
                          #        var alphaFrac = rgb_color.alpha.value || 0.0;
                          #        var rgbParams = [red, green, blue].join(',');
                          #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                          #     };
                          #
                          #     var rgbToCssColor_ = function(red, green, blue) {
                          #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                          #       var hexString = rgbNumber.toString(16);
                          #       var missingZeros = 6 - hexString.length;
                          #       var resultBuilder = ['#'];
                          #       for (var i = 0; i < missingZeros; i++) {
                          #          resultBuilder.push('0');
                          #       }
                          #       resultBuilder.push(hexString);
                          #       return resultBuilder.join('');
                          #     };
                          #
                          #     // ...
                        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                            # the final pixel color is defined by the equation:
                            #
                            #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                            #
                            # This means that a value of 1.0 corresponds to a solid color, whereas
                            # a value of 0.0 corresponds to a completely transparent color. This
                            # uses a wrapper message rather than a simple float scalar so that it is
                            # possible to distinguish between a default value and the value being unset.
                            # If omitted, this color object is to be rendered as a solid color
                            # (as if the alpha value had been explicitly given with a value of 1.0).
                        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                      },
                      "width": 42, # The width of the border, in pixels.
                          # Deprecated; the width is determined by the "style" field.
                      "style": "A String", # The style of the border.
                    },
                  },
                  "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                },
              },
              "gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
                  # the interpolation points listed. The format of a cell will vary
                  # based on its contents as compared to the values of the interpolation
                  # points.
                "maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.
                    # These pin the gradient color scale according to the color,
                    # type and value chosen.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "type": "A String", # How the value should be interpreted.
                  "value": "A String", # The value this interpolation point uses.  May be a formula.
                      # Unused if type is MIN or
                      # MAX.
                },
                "midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.
                    # These pin the gradient color scale according to the color,
                    # type and value chosen.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "type": "A String", # How the value should be interpreted.
                  "value": "A String", # The value this interpolation point uses.  May be a formula.
                      # Unused if type is MIN or
                      # MAX.
                },
                "minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.
                    # These pin the gradient color scale according to the color,
                    # type and value chosen.
                  "color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.
                      # for simplicity of conversion to/from color representations in various
                      # languages over compactness; for example, the fields of this representation
                      # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                      # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                      # method in iOS; and, with just a little work, it can be easily formatted into
                      # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                      #
                      # Example (Java):
                      #
                      #      import com.google.type.Color;
                      #
                      #      // ...
                      #      public static java.awt.Color fromProto(Color protocolor) {
                      #        float alpha = protocolor.hasAlpha()
                      #            ? protocolor.getAlpha().getValue()
                      #            : 1.0;
                      #
                      #        return new java.awt.Color(
                      #            protocolor.getRed(),
                      #            protocolor.getGreen(),
                      #            protocolor.getBlue(),
                      #            alpha);
                      #      }
                      #
                      #      public static Color toProto(java.awt.Color color) {
                      #        float red = (float) color.getRed();
                      #        float green = (float) color.getGreen();
                      #        float blue = (float) color.getBlue();
                      #        float denominator = 255.0;
                      #        Color.Builder resultBuilder =
                      #            Color
                      #                .newBuilder()
                      #                .setRed(red / denominator)
                      #                .setGreen(green / denominator)
                      #                .setBlue(blue / denominator);
                      #        int alpha = color.getAlpha();
                      #        if (alpha != 255) {
                      #          result.setAlpha(
                      #              FloatValue
                      #                  .newBuilder()
                      #                  .setValue(((float) alpha) / denominator)
                      #                  .build());
                      #        }
                      #        return resultBuilder.build();
                      #      }
                      #      // ...
                      #
                      # Example (iOS / Obj-C):
                      #
                      #      // ...
                      #      static UIColor* fromProto(Color* protocolor) {
                      #         float red = [protocolor red];
                      #         float green = [protocolor green];
                      #         float blue = [protocolor blue];
                      #         FloatValue* alpha_wrapper = [protocolor alpha];
                      #         float alpha = 1.0;
                      #         if (alpha_wrapper != nil) {
                      #           alpha = [alpha_wrapper value];
                      #         }
                      #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                      #      }
                      #
                      #      static Color* toProto(UIColor* color) {
                      #          CGFloat red, green, blue, alpha;
                      #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                      #            return nil;
                      #          }
                      #          Color* result = [Color alloc] init];
                      #          [result setRed:red];
                      #          [result setGreen:green];
                      #          [result setBlue:blue];
                      #          if (alpha <= 0.9999) {
                      #            [result setAlpha:floatWrapperWithValue(alpha)];
                      #          }
                      #          [result autorelease];
                      #          return result;
                      #     }
                      #     // ...
                      #
                      #  Example (JavaScript):
                      #
                      #     // ...
                      #
                      #     var protoToCssColor = function(rgb_color) {
                      #        var redFrac = rgb_color.red || 0.0;
                      #        var greenFrac = rgb_color.green || 0.0;
                      #        var blueFrac = rgb_color.blue || 0.0;
                      #        var red = Math.floor(redFrac * 255);
                      #        var green = Math.floor(greenFrac * 255);
                      #        var blue = Math.floor(blueFrac * 255);
                      #
                      #        if (!('alpha' in rgb_color)) {
                      #           return rgbToCssColor_(red, green, blue);
                      #        }
                      #
                      #        var alphaFrac = rgb_color.alpha.value || 0.0;
                      #        var rgbParams = [red, green, blue].join(',');
                      #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                      #     };
                      #
                      #     var rgbToCssColor_ = function(red, green, blue) {
                      #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                      #       var hexString = rgbNumber.toString(16);
                      #       var missingZeros = 6 - hexString.length;
                      #       var resultBuilder = ['#'];
                      #       for (var i = 0; i < missingZeros; i++) {
                      #          resultBuilder.push('0');
                      #       }
                      #       resultBuilder.push(hexString);
                      #       return resultBuilder.join('');
                      #     };
                      #
                      #     // ...
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                        # the final pixel color is defined by the equation:
                        #
                        #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                        #
                        # This means that a value of 1.0 corresponds to a solid color, whereas
                        # a value of 0.0 corresponds to a completely transparent color. This
                        # uses a wrapper message rather than a simple float scalar so that it is
                        # possible to distinguish between a default value and the value being unset.
                        # If omitted, this color object is to be rendered as a solid color
                        # (as if the alpha value had been explicitly given with a value of 1.0).
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "type": "A String", # How the value should be interpreted.
                  "value": "A String", # The value this interpolation point uses.  May be a formula.
                      # Unused if type is MIN or
                      # MAX.
                },
              },
            },
          ],
          "merges": [ # The ranges that are merged together.
            { # A range on a sheet.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
          ],
          "basicFilter": { # The default filter associated with a sheet. # The filter on this sheet, if any.
            "range": { # A range on a sheet. # The range the filter covers.
                # All indexes are zero-based.
                # Indexes are half open, e.g the start index is inclusive
                # and the end index is exclusive -- [start_index, end_index).
                # Missing indexes indicate the range is unbounded on that side.
                #
                # For example, if `"Sheet1"` is sheet ID 0, then:
                #
                #   `Sheet1!A1:A1 == sheet_id: 0,
                #                   start_row_index: 0, end_row_index: 1,
                #                   start_column_index: 0, end_column_index: 1`
                #
                #   `Sheet1!A3:B4 == sheet_id: 0,
                #                   start_row_index: 2, end_row_index: 4,
                #                   start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A:B == sheet_id: 0,
                #                 start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1!A5:B == sheet_id: 0,
                #                  start_row_index: 4,
                #                  start_column_index: 0, end_column_index: 2`
                #
                #   `Sheet1 == sheet_id:0`
                #
                # The start index must always be less than or equal to the end index.
                # If the start index equals the end index, then the range is empty.
                # Empty ranges are typically not meaningful and are usually rendered in the
                # UI as `#REF!`.
              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
              "sheetId": 42, # The sheet this range is on.
              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
            },
            "sortSpecs": [ # The sort order per column. Later specifications are used when values
                # are equal in the earlier specifications.
              { # A sort order associated with a specific column or row.
                "sortOrder": "A String", # The order data should be sorted.
                "dimensionIndex": 42, # The dimension the sort should be applied to.
              },
            ],
            "criteria": { # The criteria for showing/hiding values per column.
                # The map's key is the column index, and the value is the criteria for
                # that column.
              "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                "hiddenValues": [ # Values that should be hidden.
                  "A String",
                ],
                "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                    # (This does not override hiddenValues -- if a value is listed there,
                    #  it will still be hidden.)
                    # BooleanConditions are used by conditional formatting,
                    # data validation, and the criteria in filters.
                  "type": "A String", # The type of condition.
                  "values": [ # The values of the condition. The number of supported values depends
                      # on the condition type.  Some support zero values,
                      # others one or two values,
                      # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                    { # The value of the condition.
                      "relativeDate": "A String", # A relative date (based on the current date).
                          # Valid only if the type is
                          # DATE_BEFORE,
                          # DATE_AFTER,
                          # DATE_ON_OR_BEFORE or
                          # DATE_ON_OR_AFTER.
                          #
                          # Relative dates are not supported in data validation.
                          # They are supported only in conditional formatting and
                          # conditional filters.
                      "userEnteredValue": "A String", # A value the condition is based on.
                          # The value will be parsed as if the user typed into a cell.
                          # Formulas are supported (and must begin with an `=`).
                    },
                  ],
                },
              },
            },
          },
          "charts": [ # The specifications of every chart on this sheet.
            { # A chart embedded in a sheet.
              "chartId": 42, # The ID of the chart.
              "position": { # The position of an embedded object such as a chart. # The position of the chart.
                "newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID
                    # is chosen for you. Used only when writing.
                "sheetId": 42, # The sheet this is on. Set only if the embedded object
                    # is on its own sheet. Must be non-negative.
                "overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.
                  "anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.
                      # All indexes are zero-based.
                    "rowIndex": 42, # The row index of the coordinate.
                    "columnIndex": 42, # The column index of the coordinate.
                    "sheetId": 42, # The sheet this coordinate is on.
                  },
                  "offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
                      # from the anchor cell.
                  "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
                  "offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
                      # from the anchor cell.
                  "heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
                },
              },
              "spec": { # The specifications of a chart. # The specification of the chart.
                "hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.
                "pieChart": { # A pie chart. # A pie chart specification.
                  "series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.
                    "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                      "sources": [ # The ranges of data for a series or domain.
                          # Exactly one dimension must have a length of 1,
                          # and all sources in the list must have the same dimension
                          # with length 1.
                          # The domain (if it exists) & all series must have the same number
                          # of source ranges. If using more than one source range, then the source
                          # range at a given offset must be contiguous across the domain and series.
                          #
                          # For example, these are valid configurations:
                          #
                          #     domain sources: A1:A5
                          #     series1 sources: B1:B5
                          #     series2 sources: D6:D10
                          #
                          #     domain sources: A1:A5, C10:C12
                          #     series1 sources: B1:B5, D10:D12
                          #     series2 sources: C1:C5, E10:E12
                        { # A range on a sheet.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                      ],
                    },
                  },
                  "domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.
                    "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                      "sources": [ # The ranges of data for a series or domain.
                          # Exactly one dimension must have a length of 1,
                          # and all sources in the list must have the same dimension
                          # with length 1.
                          # The domain (if it exists) & all series must have the same number
                          # of source ranges. If using more than one source range, then the source
                          # range at a given offset must be contiguous across the domain and series.
                          #
                          # For example, these are valid configurations:
                          #
                          #     domain sources: A1:A5
                          #     series1 sources: B1:B5
                          #     series2 sources: D6:D10
                          #
                          #     domain sources: A1:A5, C10:C12
                          #     series1 sources: B1:B5, D10:D12
                          #     series2 sources: C1:C5, E10:E12
                        { # A range on a sheet.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                      ],
                    },
                  },
                  "threeDimensional": True or False, # True if the pie is three dimensional.
                  "legendPosition": "A String", # Where the legend of the pie chart should be drawn.
                  "pieHole": 3.14, # The size of the hole in the pie chart.
                },
                "basicChart": { # The specification for a basic chart.  See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.
                    # See BasicChartType for the list of all
                    # charts this supports.
                    # of charts this supports.
                  "headerCount": 42, # The number of rows or columns in the data that are "headers".
                      # If not set, Google Sheets will guess how many rows are headers based
                      # on the data.
                      #
                      # (Note that BasicChartAxis.title may override the axis title
                      #  inferred from the header values.)
                  "series": [ # The data this chart is visualizing.
                    { # A single series of data in a chart.
                        # For example, if charting stock prices over time, multiple series may exist,
                        # one for the "Open Price", "High Price", "Low Price" and "Close Price".
                      "series": { # The data included in a domain or series. # The data being visualized in this chart series.
                        "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                          "sources": [ # The ranges of data for a series or domain.
                              # Exactly one dimension must have a length of 1,
                              # and all sources in the list must have the same dimension
                              # with length 1.
                              # The domain (if it exists) & all series must have the same number
                              # of source ranges. If using more than one source range, then the source
                              # range at a given offset must be contiguous across the domain and series.
                              #
                              # For example, these are valid configurations:
                              #
                              #     domain sources: A1:A5
                              #     series1 sources: B1:B5
                              #     series2 sources: D6:D10
                              #
                              #     domain sources: A1:A5, C10:C12
                              #     series1 sources: B1:B5, D10:D12
                              #     series2 sources: C1:C5, E10:E12
                            { # A range on a sheet.
                                # All indexes are zero-based.
                                # Indexes are half open, e.g the start index is inclusive
                                # and the end index is exclusive -- [start_index, end_index).
                                # Missing indexes indicate the range is unbounded on that side.
                                #
                                # For example, if `"Sheet1"` is sheet ID 0, then:
                                #
                                #   `Sheet1!A1:A1 == sheet_id: 0,
                                #                   start_row_index: 0, end_row_index: 1,
                                #                   start_column_index: 0, end_column_index: 1`
                                #
                                #   `Sheet1!A3:B4 == sheet_id: 0,
                                #                   start_row_index: 2, end_row_index: 4,
                                #                   start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A:B == sheet_id: 0,
                                #                 start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A5:B == sheet_id: 0,
                                #                  start_row_index: 4,
                                #                  start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1 == sheet_id:0`
                                #
                                # The start index must always be less than or equal to the end index.
                                # If the start index equals the end index, then the range is empty.
                                # Empty ranges are typically not meaningful and are usually rendered in the
                                # UI as `#REF!`.
                              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                              "sheetId": 42, # The sheet this range is on.
                              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                            },
                          ],
                        },
                      },
                      "targetAxis": "A String", # The minor axis that will specify the range of values for this series.
                          # For example, if charting stocks over time, the "Volume" series
                          # may want to be pinned to the right with the prices pinned to the left,
                          # because the scale of trading volume is different than the scale of
                          # prices.
                          # It is an error to specify an axis that isn't a valid minor axis
                          # for the chart's type.
                      "type": "A String", # The type of this series. Valid only if the
                          # chartType is
                          # COMBO.
                          # Different types will change the way the series is visualized.
                          # Only LINE, AREA,
                          # and COLUMN are supported.
                    },
                  ],
                  "legendPosition": "A String", # The position of the chart legend.
                  "domains": [ # The domain of data this is charting.
                      # Only a single domain is currently supported.
                    { # The domain of a chart.
                        # For example, if charting stock prices over time, this would be the date.
                      "domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,
                          # this is the data representing the dates.
                        "sourceRange": { # Source ranges for a chart. # The source ranges of the data.
                          "sources": [ # The ranges of data for a series or domain.
                              # Exactly one dimension must have a length of 1,
                              # and all sources in the list must have the same dimension
                              # with length 1.
                              # The domain (if it exists) & all series must have the same number
                              # of source ranges. If using more than one source range, then the source
                              # range at a given offset must be contiguous across the domain and series.
                              #
                              # For example, these are valid configurations:
                              #
                              #     domain sources: A1:A5
                              #     series1 sources: B1:B5
                              #     series2 sources: D6:D10
                              #
                              #     domain sources: A1:A5, C10:C12
                              #     series1 sources: B1:B5, D10:D12
                              #     series2 sources: C1:C5, E10:E12
                            { # A range on a sheet.
                                # All indexes are zero-based.
                                # Indexes are half open, e.g the start index is inclusive
                                # and the end index is exclusive -- [start_index, end_index).
                                # Missing indexes indicate the range is unbounded on that side.
                                #
                                # For example, if `"Sheet1"` is sheet ID 0, then:
                                #
                                #   `Sheet1!A1:A1 == sheet_id: 0,
                                #                   start_row_index: 0, end_row_index: 1,
                                #                   start_column_index: 0, end_column_index: 1`
                                #
                                #   `Sheet1!A3:B4 == sheet_id: 0,
                                #                   start_row_index: 2, end_row_index: 4,
                                #                   start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A:B == sheet_id: 0,
                                #                 start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1!A5:B == sheet_id: 0,
                                #                  start_row_index: 4,
                                #                  start_column_index: 0, end_column_index: 2`
                                #
                                #   `Sheet1 == sheet_id:0`
                                #
                                # The start index must always be less than or equal to the end index.
                                # If the start index equals the end index, then the range is empty.
                                # Empty ranges are typically not meaningful and are usually rendered in the
                                # UI as `#REF!`.
                              "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                              "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                              "sheetId": 42, # The sheet this range is on.
                              "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                              "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                            },
                          ],
                        },
                      },
                    },
                  ],
                  "chartType": "A String", # The type of the chart.
                  "axis": [ # The axis on the chart.
                    { # An axis of the chart.
                        # A chart may not have more than one axis per
                        # axis position.
                      "position": "A String", # The position of this axis.
                      "format": { # The format of a run of text in a cell. # The format of the title.
                          # Only valid if the axis is not associated with the domain.
                          # Absent values indicate that the field isn't specified.
                        "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # True if the text is bold.
                        "strikethrough": True or False, # True if the text has a strikethrough.
                        "fontFamily": "A String", # The font family.
                        "fontSize": 42, # The size of the font.
                        "italic": True or False, # True if the text is italicized.
                        "underline": True or False, # True if the text is underlined.
                      },
                      "title": "A String", # The title of this axis. If set, this overrides any title inferred
                          # from headers of the data.
                    },
                  ],
                },
                "title": "A String", # The title of the chart.
              },
            },
          ],
          "filterViews": [ # The filter views in this sheet.
            { # A filter view.
              "title": "A String", # The name of the filter view.
              "namedRangeId": "A String", # The named range this filter view is backed by, if any.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
              "filterViewId": 42, # The ID of the filter view.
              "range": { # A range on a sheet. # The range this filter view covers.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
              "sortSpecs": [ # The sort order per column. Later specifications are used when values
                  # are equal in the earlier specifications.
                { # A sort order associated with a specific column or row.
                  "sortOrder": "A String", # The order data should be sorted.
                  "dimensionIndex": 42, # The dimension the sort should be applied to.
                },
              ],
              "criteria": { # The criteria for showing/hiding values per column.
                  # The map's key is the column index, and the value is the criteria for
                  # that column.
                "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
                  "hiddenValues": [ # Values that should be hidden.
                    "A String",
                  ],
                  "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
                      # (This does not override hiddenValues -- if a value is listed there,
                      #  it will still be hidden.)
                      # BooleanConditions are used by conditional formatting,
                      # data validation, and the criteria in filters.
                    "type": "A String", # The type of condition.
                    "values": [ # The values of the condition. The number of supported values depends
                        # on the condition type.  Some support zero values,
                        # others one or two values,
                        # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                      { # The value of the condition.
                        "relativeDate": "A String", # A relative date (based on the current date).
                            # Valid only if the type is
                            # DATE_BEFORE,
                            # DATE_AFTER,
                            # DATE_ON_OR_BEFORE or
                            # DATE_ON_OR_AFTER.
                            #
                            # Relative dates are not supported in data validation.
                            # They are supported only in conditional formatting and
                            # conditional filters.
                        "userEnteredValue": "A String", # A value the condition is based on.
                            # The value will be parsed as if the user typed into a cell.
                            # Formulas are supported (and must begin with an `=`).
                      },
                    ],
                  },
                },
              },
            },
          ],
          "protectedRanges": [ # The protected ranges in this sheet.
            { # A protected range.
              "unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.
                  # Unprotected ranges are only supported on protected sheets.
                { # A range on a sheet.
                    # All indexes are zero-based.
                    # Indexes are half open, e.g the start index is inclusive
                    # and the end index is exclusive -- [start_index, end_index).
                    # Missing indexes indicate the range is unbounded on that side.
                    #
                    # For example, if `"Sheet1"` is sheet ID 0, then:
                    #
                    #   `Sheet1!A1:A1 == sheet_id: 0,
                    #                   start_row_index: 0, end_row_index: 1,
                    #                   start_column_index: 0, end_column_index: 1`
                    #
                    #   `Sheet1!A3:B4 == sheet_id: 0,
                    #                   start_row_index: 2, end_row_index: 4,
                    #                   start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A:B == sheet_id: 0,
                    #                 start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1!A5:B == sheet_id: 0,
                    #                  start_row_index: 4,
                    #                  start_column_index: 0, end_column_index: 2`
                    #
                    #   `Sheet1 == sheet_id:0`
                    #
                    # The start index must always be less than or equal to the end index.
                    # If the start index equals the end index, then the range is empty.
                    # Empty ranges are typically not meaningful and are usually rendered in the
                    # UI as `#REF!`.
                  "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                  "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                  "sheetId": 42, # The sheet this range is on.
                  "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                  "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                },
              ],
              "requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the
                  # protected area.
                  # This field is read-only.
              "description": "A String", # The description of this protected range.
              "namedRangeId": "A String", # The named range this protected range is backed by, if any.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
              "editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.
                  # This field is only visible to users with edit access to the protected
                  # range and the document.
                  # Editors are not supported with warning_only protection.
                "domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected
                    # range.  Domain protection is only supported on documents within a domain.
                "users": [ # The email addresses of users with edit access to the protected range.
                  "A String",
                ],
                "groups": [ # The email addresses of groups with edit access to the protected range.
                  "A String",
                ],
              },
              "protectedRangeId": 42, # The ID of the protected range.
                  # This field is read-only.
              "warningOnly": True or False, # True if this protected range will show a warning when editing.
                  # Warning-based protection means that every user can edit data in the
                  # protected range, except editing will prompt a warning asking the user
                  # to confirm the edit.
                  #
                  # When writing: if this field is true, then editors is ignored.
                  # Additionally, if this field is changed from true to false and the
                  # `editors` field is not set (nor included in the field mask), then
                  # the editors will be set to all the editors in the document.
              "range": { # A range on a sheet. # The range that is being protected.
                  # The range may be fully unbounded, in which case this is considered
                  # a protected sheet.
                  #
                  # When writing, only one of range or named_range_id
                  # may be set.
                  # All indexes are zero-based.
                  # Indexes are half open, e.g the start index is inclusive
                  # and the end index is exclusive -- [start_index, end_index).
                  # Missing indexes indicate the range is unbounded on that side.
                  #
                  # For example, if `"Sheet1"` is sheet ID 0, then:
                  #
                  #   `Sheet1!A1:A1 == sheet_id: 0,
                  #                   start_row_index: 0, end_row_index: 1,
                  #                   start_column_index: 0, end_column_index: 1`
                  #
                  #   `Sheet1!A3:B4 == sheet_id: 0,
                  #                   start_row_index: 2, end_row_index: 4,
                  #                   start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A:B == sheet_id: 0,
                  #                 start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1!A5:B == sheet_id: 0,
                  #                  start_row_index: 4,
                  #                  start_column_index: 0, end_column_index: 2`
                  #
                  #   `Sheet1 == sheet_id:0`
                  #
                  # The start index must always be less than or equal to the end index.
                  # If the start index equals the end index, then the range is empty.
                  # Empty ranges are typically not meaningful and are usually rendered in the
                  # UI as `#REF!`.
                "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                "sheetId": 42, # The sheet this range is on.
                "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
              },
            },
          ],
          "data": [ # Data in the grid, if this is a grid sheet.
              # The number of GridData objects returned is dependent on the number of
              # ranges requested on this sheet. For example, if this is representing
              # `Sheet1`, and the spreadsheet was requested with ranges
              # `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a
              # startRow/startColumn of `0`,
              # while the second one will have `startRow 14` (zero-based row 15),
              # and `startColumn 3` (zero-based column D).
            { # Data in the grid, as well as metadata about the dimensions.
              "startRow": 42, # The first row this GridData refers to, zero-based.
              "rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
                  # in start_row.
                { # Properties about a dimension.
                  "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
                  "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
                  "hiddenByFilter": True or False, # True if this dimension is being filtered.
                      # This field is read-only.
                },
              ],
              "startColumn": 42, # The first column this GridData refers to, zero-based.
              "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
                  # in start_column.
                { # Properties about a dimension.
                  "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
                  "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
                  "hiddenByFilter": True or False, # True if this dimension is being filtered.
                      # This field is read-only.
                },
              ],
              "rowData": [ # The data in the grid, one entry per row,
                  # starting with the row in startRow.
                  # The values in RowData will correspond to columns starting
                  # at start_column.
                { # Data about each cell in a row.
                  "values": [ # The values in the row, one per column.
                    { # Data about a specific cell.
                      "pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself
                          # is computed dynamically based on its data, grouping, filters, values,
                          # etc. Only the top-left cell of the pivot table contains the pivot table
                          # definition. The other cells will contain the calculated values of the
                          # results of the pivot in their effective_value fields.
                        "valueLayout": "A String", # Whether values should be listed horizontally (as columns)
                            # or vertically (as rows).
                        "rows": [ # Each row grouping in the pivot table.
                          { # A single grouping (either row or column) in a pivot table.
                            "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                            "valueMetadata": [ # Metadata about values in the grouping.
                              { # Metadata about a value in a pivot grouping.
                                "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                                "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                    # (Note that formulaValue is not valid,
                                    #  because the values will be calculated.)
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              },
                            ],
                            "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                                # If not specified, sorting is alphabetical by this group's values.
                              "buckets": [ # Determines the bucket from which values are chosen to sort.
                                  #
                                  # For example, in a pivot table with one row group & two column groups,
                                  # the row group can list up to two values. The first value corresponds
                                  # to a value within the first column group, and the second value
                                  # corresponds to a value in the second column group.  If no values
                                  # are listed, this would indicate that the row should be sorted according
                                  # to the "Grand Total" over the column groups. If a single value is listed,
                                  # this would correspond to using the "Total" of that bucket.
                                { # The kinds of value that a cell in a spreadsheet can have.
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              ],
                              "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                                  # grouping should be sorted by.
                            },
                            "sortOrder": "A String", # The order the values in this group should be sorted.
                            "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                                #
                                # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                                # means this group refers to column `C`, whereas the offset `1` would refer
                                # to column `D`.
                          },
                        ],
                        "source": { # A range on a sheet. # The range the pivot table is reading data from.
                            # All indexes are zero-based.
                            # Indexes are half open, e.g the start index is inclusive
                            # and the end index is exclusive -- [start_index, end_index).
                            # Missing indexes indicate the range is unbounded on that side.
                            #
                            # For example, if `"Sheet1"` is sheet ID 0, then:
                            #
                            #   `Sheet1!A1:A1 == sheet_id: 0,
                            #                   start_row_index: 0, end_row_index: 1,
                            #                   start_column_index: 0, end_column_index: 1`
                            #
                            #   `Sheet1!A3:B4 == sheet_id: 0,
                            #                   start_row_index: 2, end_row_index: 4,
                            #                   start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A:B == sheet_id: 0,
                            #                 start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1!A5:B == sheet_id: 0,
                            #                  start_row_index: 4,
                            #                  start_column_index: 0, end_column_index: 2`
                            #
                            #   `Sheet1 == sheet_id:0`
                            #
                            # The start index must always be less than or equal to the end index.
                            # If the start index equals the end index, then the range is empty.
                            # Empty ranges are typically not meaningful and are usually rendered in the
                            # UI as `#REF!`.
                          "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
                          "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
                          "sheetId": 42, # The sheet this range is on.
                          "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
                          "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
                        },
                        "values": [ # A list of values to include in the pivot table.
                          { # The definition of how a value in a pivot table should be calculated.
                            "formula": "A String", # A custom formula to calculate the value.  The formula must start
                                # with an `=` character.
                            "summarizeFunction": "A String", # A function to summarize the value.
                                # If formula is set, the only supported values are
                                # SUM and
                                # CUSTOM.
                                # If sourceColumnOffset is set, then `CUSTOM`
                                # is not supported.
                            "sourceColumnOffset": 42, # The column offset of the source range that this value reads from.
                                #
                                # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                                # means this value refers to column `C`, whereas the offset `1` would
                                # refer to column `D`.
                            "name": "A String", # A name to use for the value. This is only used if formula was set.
                                # Otherwise, the column name is used.
                          },
                        ],
                        "criteria": { # An optional mapping of filters per source column offset.
                            #
                            # The filters will be applied before aggregating data into the pivot table.
                            # The map's key is the column offset of the source range that you want to
                            # filter, and the value is the criteria for that column.
                            #
                            # For example, if the source was `C10:E15`, a key of `0` will have the filter
                            # for column `C`, whereas the key `1` is for column `D`.
                          "a_key": { # Criteria for showing/hiding rows in a pivot table.
                            "visibleValues": [ # Values that should be included.  Values not listed here are excluded.
                              "A String",
                            ],
                          },
                        },
                        "columns": [ # Each column grouping in the pivot table.
                          { # A single grouping (either row or column) in a pivot table.
                            "showTotals": True or False, # True if the pivot table should include the totals for this grouping.
                            "valueMetadata": [ # Metadata about values in the grouping.
                              { # Metadata about a value in a pivot grouping.
                                "collapsed": True or False, # True if the data corresponding to the value is collapsed.
                                "value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.
                                    # (Note that formulaValue is not valid,
                                    #  because the values will be calculated.)
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              },
                            ],
                            "valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.
                                # If not specified, sorting is alphabetical by this group's values.
                              "buckets": [ # Determines the bucket from which values are chosen to sort.
                                  #
                                  # For example, in a pivot table with one row group & two column groups,
                                  # the row group can list up to two values. The first value corresponds
                                  # to a value within the first column group, and the second value
                                  # corresponds to a value in the second column group.  If no values
                                  # are listed, this would indicate that the row should be sorted according
                                  # to the "Grand Total" over the column groups. If a single value is listed,
                                  # this would correspond to using the "Total" of that bucket.
                                { # The kinds of value that a cell in a spreadsheet can have.
                                  "numberValue": 3.14, # Represents a double value.
                                      # Note: Dates, Times and DateTimes are represented as doubles in
                                      # "serial number" format.
                                  "boolValue": True or False, # Represents a boolean value.
                                  "formulaValue": "A String", # Represents a formula.
                                  "stringValue": "A String", # Represents a string value.
                                      # Leading single quotes are not included. For example, if the user typed
                                      # `'123` into the UI, this would be represented as a `stringValue` of
                                      # `"123"`.
                                  "errorValue": { # An error in a cell. # Represents an error.
                                      # This field is read-only.
                                    "message": "A String", # A message with more information about the error
                                        # (in the spreadsheet's locale).
                                    "type": "A String", # The type of error.
                                  },
                                },
                              ],
                              "valuesIndex": 42, # The offset in the PivotTable.values list which the values in this
                                  # grouping should be sorted by.
                            },
                            "sortOrder": "A String", # The order the values in this group should be sorted.
                            "sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.
                                #
                                # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
                                # means this group refers to column `C`, whereas the offset `1` would refer
                                # to column `D`.
                          },
                        ],
                      },
                      "hyperlink": "A String", # A hyperlink this cell points to, if any.
                          # This field is read-only.  (To set it, use a `=HYPERLINK` formula.)
                      "effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be
                          # the calculated value.  For cells with literals, this will be
                          # the same as the user_entered_value.
                          # This field is read-only.
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                      "formattedValue": "A String", # The formatted value of the cell.
                          # This is the value as it's shown to the user.
                          # This field is read-only.
                      "userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
                          # Note: Dates, Times and DateTimes are represented as doubles in
                          # serial number format.
                        "numberValue": 3.14, # Represents a double value.
                            # Note: Dates, Times and DateTimes are represented as doubles in
                            # "serial number" format.
                        "boolValue": True or False, # Represents a boolean value.
                        "formulaValue": "A String", # Represents a formula.
                        "stringValue": "A String", # Represents a string value.
                            # Leading single quotes are not included. For example, if the user typed
                            # `'123` into the UI, this would be represented as a `stringValue` of
                            # `"123"`.
                        "errorValue": { # An error in a cell. # Represents an error.
                            # This field is read-only.
                          "message": "A String", # A message with more information about the error
                              # (in the spreadsheet's locale).
                          "type": "A String", # The type of error.
                        },
                      },
                      "note": "A String", # Any note on the cell.
                      "effectiveFormat": { # The format of a cell. # The effective format being used by the cell.
                          # This includes the results of applying any conditional formatting and,
                          # if the cell contains a formula, the computed number format.
                          # If the effective format is the default format, effective format will
                          # not be written.
                          # This field is read-only.
                        "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                          "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                              # the user's locale will be used if necessary for the given type.
                              # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                              # information about the supported patterns.
                          "type": "A String", # The type of the number format.
                              # When writing, this field must be set.
                        },
                        "textDirection": "A String", # The direction of the text in the cell.
                        "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                            # When updating padding, every field must be specified.
                          "top": 42, # The top padding of the cell.
                          "right": 42, # The right padding of the cell.
                          "bottom": 42, # The bottom padding of the cell.
                          "left": 42, # The left padding of the cell.
                        },
                        "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                        "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                        "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                            # Absent values indicate that the field isn't specified.
                          "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "bold": True or False, # True if the text is bold.
                          "strikethrough": True or False, # True if the text has a strikethrough.
                          "fontFamily": "A String", # The font family.
                          "fontSize": 42, # The size of the font.
                          "italic": True or False, # True if the text is italicized.
                          "underline": True or False, # True if the text is underlined.
                        },
                        "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                        "borders": { # The borders of the cell. # The borders of the cell.
                          "top": { # A border along a cell. # The top border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "right": { # A border along a cell. # The right border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "bottom": { # A border along a cell. # The bottom border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "left": { # A border along a cell. # The left border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                        },
                        "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                      },
                      "userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
                          #
                          # When writing, the new format will be merged with the existing format.
                        "numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.
                          "pattern": "A String", # Pattern string used for formatting.  If not set, a default pattern based on
                              # the user's locale will be used if necessary for the given type.
                              # See the [Date and Number Formats guide](/sheets/guides/formats) for more
                              # information about the supported patterns.
                          "type": "A String", # The type of the number format.
                              # When writing, this field must be set.
                        },
                        "textDirection": "A String", # The direction of the text in the cell.
                        "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
                            # When updating padding, every field must be specified.
                          "top": 42, # The top padding of the cell.
                          "right": 42, # The right padding of the cell.
                          "bottom": 42, # The bottom padding of the cell.
                          "left": 42, # The left padding of the cell.
                        },
                        "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
                        "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
                            # for simplicity of conversion to/from color representations in various
                            # languages over compactness; for example, the fields of this representation
                            # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                            # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                            # method in iOS; and, with just a little work, it can be easily formatted into
                            # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                            #
                            # Example (Java):
                            #
                            #      import com.google.type.Color;
                            #
                            #      // ...
                            #      public static java.awt.Color fromProto(Color protocolor) {
                            #        float alpha = protocolor.hasAlpha()
                            #            ? protocolor.getAlpha().getValue()
                            #            : 1.0;
                            #
                            #        return new java.awt.Color(
                            #            protocolor.getRed(),
                            #            protocolor.getGreen(),
                            #            protocolor.getBlue(),
                            #            alpha);
                            #      }
                            #
                            #      public static Color toProto(java.awt.Color color) {
                            #        float red = (float) color.getRed();
                            #        float green = (float) color.getGreen();
                            #        float blue = (float) color.getBlue();
                            #        float denominator = 255.0;
                            #        Color.Builder resultBuilder =
                            #            Color
                            #                .newBuilder()
                            #                .setRed(red / denominator)
                            #                .setGreen(green / denominator)
                            #                .setBlue(blue / denominator);
                            #        int alpha = color.getAlpha();
                            #        if (alpha != 255) {
                            #          result.setAlpha(
                            #              FloatValue
                            #                  .newBuilder()
                            #                  .setValue(((float) alpha) / denominator)
                            #                  .build());
                            #        }
                            #        return resultBuilder.build();
                            #      }
                            #      // ...
                            #
                            # Example (iOS / Obj-C):
                            #
                            #      // ...
                            #      static UIColor* fromProto(Color* protocolor) {
                            #         float red = [protocolor red];
                            #         float green = [protocolor green];
                            #         float blue = [protocolor blue];
                            #         FloatValue* alpha_wrapper = [protocolor alpha];
                            #         float alpha = 1.0;
                            #         if (alpha_wrapper != nil) {
                            #           alpha = [alpha_wrapper value];
                            #         }
                            #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                            #      }
                            #
                            #      static Color* toProto(UIColor* color) {
                            #          CGFloat red, green, blue, alpha;
                            #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                            #            return nil;
                            #          }
                            #          Color* result = [Color alloc] init];
                            #          [result setRed:red];
                            #          [result setGreen:green];
                            #          [result setBlue:blue];
                            #          if (alpha <= 0.9999) {
                            #            [result setAlpha:floatWrapperWithValue(alpha)];
                            #          }
                            #          [result autorelease];
                            #          return result;
                            #     }
                            #     // ...
                            #
                            #  Example (JavaScript):
                            #
                            #     // ...
                            #
                            #     var protoToCssColor = function(rgb_color) {
                            #        var redFrac = rgb_color.red || 0.0;
                            #        var greenFrac = rgb_color.green || 0.0;
                            #        var blueFrac = rgb_color.blue || 0.0;
                            #        var red = Math.floor(redFrac * 255);
                            #        var green = Math.floor(greenFrac * 255);
                            #        var blue = Math.floor(blueFrac * 255);
                            #
                            #        if (!('alpha' in rgb_color)) {
                            #           return rgbToCssColor_(red, green, blue);
                            #        }
                            #
                            #        var alphaFrac = rgb_color.alpha.value || 0.0;
                            #        var rgbParams = [red, green, blue].join(',');
                            #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                            #     };
                            #
                            #     var rgbToCssColor_ = function(red, green, blue) {
                            #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                            #       var hexString = rgbNumber.toString(16);
                            #       var missingZeros = 6 - hexString.length;
                            #       var resultBuilder = ['#'];
                            #       for (var i = 0; i < missingZeros; i++) {
                            #          resultBuilder.push('0');
                            #       }
                            #       resultBuilder.push(hexString);
                            #       return resultBuilder.join('');
                            #     };
                            #
                            #     // ...
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                              # the final pixel color is defined by the equation:
                              #
                              #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                              #
                              # This means that a value of 1.0 corresponds to a solid color, whereas
                              # a value of 0.0 corresponds to a completely transparent color. This
                              # uses a wrapper message rather than a simple float scalar so that it is
                              # possible to distinguish between a default value and the value being unset.
                              # If omitted, this color object is to be rendered as a solid color
                              # (as if the alpha value had been explicitly given with a value of 1.0).
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
                        "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
                            # Absent values indicate that the field isn't specified.
                          "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                              # for simplicity of conversion to/from color representations in various
                              # languages over compactness; for example, the fields of this representation
                              # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                              # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                              # method in iOS; and, with just a little work, it can be easily formatted into
                              # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                              #
                              # Example (Java):
                              #
                              #      import com.google.type.Color;
                              #
                              #      // ...
                              #      public static java.awt.Color fromProto(Color protocolor) {
                              #        float alpha = protocolor.hasAlpha()
                              #            ? protocolor.getAlpha().getValue()
                              #            : 1.0;
                              #
                              #        return new java.awt.Color(
                              #            protocolor.getRed(),
                              #            protocolor.getGreen(),
                              #            protocolor.getBlue(),
                              #            alpha);
                              #      }
                              #
                              #      public static Color toProto(java.awt.Color color) {
                              #        float red = (float) color.getRed();
                              #        float green = (float) color.getGreen();
                              #        float blue = (float) color.getBlue();
                              #        float denominator = 255.0;
                              #        Color.Builder resultBuilder =
                              #            Color
                              #                .newBuilder()
                              #                .setRed(red / denominator)
                              #                .setGreen(green / denominator)
                              #                .setBlue(blue / denominator);
                              #        int alpha = color.getAlpha();
                              #        if (alpha != 255) {
                              #          result.setAlpha(
                              #              FloatValue
                              #                  .newBuilder()
                              #                  .setValue(((float) alpha) / denominator)
                              #                  .build());
                              #        }
                              #        return resultBuilder.build();
                              #      }
                              #      // ...
                              #
                              # Example (iOS / Obj-C):
                              #
                              #      // ...
                              #      static UIColor* fromProto(Color* protocolor) {
                              #         float red = [protocolor red];
                              #         float green = [protocolor green];
                              #         float blue = [protocolor blue];
                              #         FloatValue* alpha_wrapper = [protocolor alpha];
                              #         float alpha = 1.0;
                              #         if (alpha_wrapper != nil) {
                              #           alpha = [alpha_wrapper value];
                              #         }
                              #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                              #      }
                              #
                              #      static Color* toProto(UIColor* color) {
                              #          CGFloat red, green, blue, alpha;
                              #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                              #            return nil;
                              #          }
                              #          Color* result = [Color alloc] init];
                              #          [result setRed:red];
                              #          [result setGreen:green];
                              #          [result setBlue:blue];
                              #          if (alpha <= 0.9999) {
                              #            [result setAlpha:floatWrapperWithValue(alpha)];
                              #          }
                              #          [result autorelease];
                              #          return result;
                              #     }
                              #     // ...
                              #
                              #  Example (JavaScript):
                              #
                              #     // ...
                              #
                              #     var protoToCssColor = function(rgb_color) {
                              #        var redFrac = rgb_color.red || 0.0;
                              #        var greenFrac = rgb_color.green || 0.0;
                              #        var blueFrac = rgb_color.blue || 0.0;
                              #        var red = Math.floor(redFrac * 255);
                              #        var green = Math.floor(greenFrac * 255);
                              #        var blue = Math.floor(blueFrac * 255);
                              #
                              #        if (!('alpha' in rgb_color)) {
                              #           return rgbToCssColor_(red, green, blue);
                              #        }
                              #
                              #        var alphaFrac = rgb_color.alpha.value || 0.0;
                              #        var rgbParams = [red, green, blue].join(',');
                              #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                              #     };
                              #
                              #     var rgbToCssColor_ = function(red, green, blue) {
                              #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                              #       var hexString = rgbNumber.toString(16);
                              #       var missingZeros = 6 - hexString.length;
                              #       var resultBuilder = ['#'];
                              #       for (var i = 0; i < missingZeros; i++) {
                              #          resultBuilder.push('0');
                              #       }
                              #       resultBuilder.push(hexString);
                              #       return resultBuilder.join('');
                              #     };
                              #
                              #     // ...
                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                # the final pixel color is defined by the equation:
                                #
                                #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                #
                                # This means that a value of 1.0 corresponds to a solid color, whereas
                                # a value of 0.0 corresponds to a completely transparent color. This
                                # uses a wrapper message rather than a simple float scalar so that it is
                                # possible to distinguish between a default value and the value being unset.
                                # If omitted, this color object is to be rendered as a solid color
                                # (as if the alpha value had been explicitly given with a value of 1.0).
                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                          },
                          "bold": True or False, # True if the text is bold.
                          "strikethrough": True or False, # True if the text has a strikethrough.
                          "fontFamily": "A String", # The font family.
                          "fontSize": 42, # The size of the font.
                          "italic": True or False, # True if the text is italicized.
                          "underline": True or False, # True if the text is underlined.
                        },
                        "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
                        "borders": { # The borders of the cell. # The borders of the cell.
                          "top": { # A border along a cell. # The top border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "right": { # A border along a cell. # The right border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "bottom": { # A border along a cell. # The bottom border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                          "left": { # A border along a cell. # The left border of the cell.
                            "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "width": 42, # The width of the border, in pixels.
                                # Deprecated; the width is determined by the "style" field.
                            "style": "A String", # The style of the border.
                          },
                        },
                        "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
                      },
                      "dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
                          #
                          # When writing, the new data validation rule will overwrite any prior rule.
                        "showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.
                            # If true, "List" conditions will show a dropdown.
                        "strict": True or False, # True if invalid data should be rejected.
                        "inputMessage": "A String", # A message to show the user when adding data to the cell.
                        "condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.
                            # BooleanConditions are used by conditional formatting,
                            # data validation, and the criteria in filters.
                          "type": "A String", # The type of condition.
                          "values": [ # The values of the condition. The number of supported values depends
                              # on the condition type.  Some support zero values,
                              # others one or two values,
                              # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
                            { # The value of the condition.
                              "relativeDate": "A String", # A relative date (based on the current date).
                                  # Valid only if the type is
                                  # DATE_BEFORE,
                                  # DATE_AFTER,
                                  # DATE_ON_OR_BEFORE or
                                  # DATE_ON_OR_AFTER.
                                  #
                                  # Relative dates are not supported in data validation.
                                  # They are supported only in conditional formatting and
                                  # conditional filters.
                              "userEnteredValue": "A String", # A value the condition is based on.
                                  # The value will be parsed as if the user typed into a cell.
                                  # Formulas are supported (and must begin with an `=`).
                            },
                          ],
                        },
                      },
                      "textFormatRuns": [ # Runs of rich text applied to subsections of the cell.  Runs are only valid
                          # on user entered strings, not formulas, bools, or numbers.
                          # Runs start at specific indexes in the text and continue until the next
                          # run. Properties of a run will continue unless explicitly changed
                          # in a subsequent run (and properties of the first run will continue
                          # the properties of the cell unless explicitly changed).
                          #
                          # When writing, the new runs will overwrite any prior runs.  When writing a
                          # new user_entered_value, previous runs will be erased.
                        { # A run of a text format. The format of this run continues until the start
                            # index of the next run.
                            # When updating, all fields must be set.
                          "startIndex": 42, # The character index where this run starts.
                          "format": { # The format of a run of text in a cell. # The format of this run.  Absent values inherit the cell's format.
                              # Absent values indicate that the field isn't specified.
                            "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
                                # for simplicity of conversion to/from color representations in various
                                # languages over compactness; for example, the fields of this representation
                                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                                # method in iOS; and, with just a little work, it can be easily formatted into
                                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                                #
                                # Example (Java):
                                #
                                #      import com.google.type.Color;
                                #
                                #      // ...
                                #      public static java.awt.Color fromProto(Color protocolor) {
                                #        float alpha = protocolor.hasAlpha()
                                #            ? protocolor.getAlpha().getValue()
                                #            : 1.0;
                                #
                                #        return new java.awt.Color(
                                #            protocolor.getRed(),
                                #            protocolor.getGreen(),
                                #            protocolor.getBlue(),
                                #            alpha);
                                #      }
                                #
                                #      public static Color toProto(java.awt.Color color) {
                                #        float red = (float) color.getRed();
                                #        float green = (float) color.getGreen();
                                #        float blue = (float) color.getBlue();
                                #        float denominator = 255.0;
                                #        Color.Builder resultBuilder =
                                #            Color
                                #                .newBuilder()
                                #                .setRed(red / denominator)
                                #                .setGreen(green / denominator)
                                #                .setBlue(blue / denominator);
                                #        int alpha = color.getAlpha();
                                #        if (alpha != 255) {
                                #          result.setAlpha(
                                #              FloatValue
                                #                  .newBuilder()
                                #                  .setValue(((float) alpha) / denominator)
                                #                  .build());
                                #        }
                                #        return resultBuilder.build();
                                #      }
                                #      // ...
                                #
                                # Example (iOS / Obj-C):
                                #
                                #      // ...
                                #      static UIColor* fromProto(Color* protocolor) {
                                #         float red = [protocolor red];
                                #         float green = [protocolor green];
                                #         float blue = [protocolor blue];
                                #         FloatValue* alpha_wrapper = [protocolor alpha];
                                #         float alpha = 1.0;
                                #         if (alpha_wrapper != nil) {
                                #           alpha = [alpha_wrapper value];
                                #         }
                                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                                #      }
                                #
                                #      static Color* toProto(UIColor* color) {
                                #          CGFloat red, green, blue, alpha;
                                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                                #            return nil;
                                #          }
                                #          Color* result = [Color alloc] init];
                                #          [result setRed:red];
                                #          [result setGreen:green];
                                #          [result setBlue:blue];
                                #          if (alpha <= 0.9999) {
                                #            [result setAlpha:floatWrapperWithValue(alpha)];
                                #          }
                                #          [result autorelease];
                                #          return result;
                                #     }
                                #     // ...
                                #
                                #  Example (JavaScript):
                                #
                                #     // ...
                                #
                                #     var protoToCssColor = function(rgb_color) {
                                #        var redFrac = rgb_color.red || 0.0;
                                #        var greenFrac = rgb_color.green || 0.0;
                                #        var blueFrac = rgb_color.blue || 0.0;
                                #        var red = Math.floor(redFrac * 255);
                                #        var green = Math.floor(greenFrac * 255);
                                #        var blue = Math.floor(blueFrac * 255);
                                #
                                #        if (!('alpha' in rgb_color)) {
                                #           return rgbToCssColor_(red, green, blue);
                                #        }
                                #
                                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                                #        var rgbParams = [red, green, blue].join(',');
                                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                                #     };
                                #
                                #     var rgbToCssColor_ = function(red, green, blue) {
                                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                                #       var hexString = rgbNumber.toString(16);
                                #       var missingZeros = 6 - hexString.length;
                                #       var resultBuilder = ['#'];
                                #       for (var i = 0; i < missingZeros; i++) {
                                #          resultBuilder.push('0');
                                #       }
                                #       resultBuilder.push(hexString);
                                #       return resultBuilder.join('');
                                #     };
                                #
                                #     // ...
                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                                  # the final pixel color is defined by the equation:
                                  #
                                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                                  #
                                  # This means that a value of 1.0 corresponds to a solid color, whereas
                                  # a value of 0.0 corresponds to a completely transparent color. This
                                  # uses a wrapper message rather than a simple float scalar so that it is
                                  # possible to distinguish between a default value and the value being unset.
                                  # If omitted, this color object is to be rendered as a solid color
                                  # (as if the alpha value had been explicitly given with a value of 1.0).
                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                            },
                            "bold": True or False, # True if the text is bold.
                            "strikethrough": True or False, # True if the text has a strikethrough.
                            "fontFamily": "A String", # The font family.
                            "fontSize": 42, # The size of the font.
                            "italic": True or False, # True if the text is italicized.
                            "underline": True or False, # True if the text is underlined.
                          },
                        },
                      ],
                    },
                  ],
                },
              ],
            },
          ],
          "properties": { # Properties of a sheet. # The properties of the sheet.
            "sheetType": "A String", # The type of sheet. Defaults to GRID.
                # This field cannot be changed once set.
            "index": 42, # The index of the sheet within the spreadsheet.
                # When adding or updating sheet properties, if this field
                # is excluded then the sheet will be added or moved to the end
                # of the sheet list.
            "title": "A String", # The name of the sheet.
            "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
                # (If the sheet is an object sheet, containing a chart or image, then
                # this field will be absent.)
                # When writing it is an error to set any grid properties on non-grid sheets.
              "columnCount": 42, # The number of columns in the grid.
              "rowCount": 42, # The number of rows in the grid.
              "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
              "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
              "frozenRowCount": 42, # The number of rows that are frozen in the grid.
            },
            "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
            "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
                # for simplicity of conversion to/from color representations in various
                # languages over compactness; for example, the fields of this representation
                # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                # method in iOS; and, with just a little work, it can be easily formatted into
                # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                #
                # Example (Java):
                #
                #      import com.google.type.Color;
                #
                #      // ...
                #      public static java.awt.Color fromProto(Color protocolor) {
                #        float alpha = protocolor.hasAlpha()
                #            ? protocolor.getAlpha().getValue()
                #            : 1.0;
                #
                #        return new java.awt.Color(
                #            protocolor.getRed(),
                #            protocolor.getGreen(),
                #            protocolor.getBlue(),
                #            alpha);
                #      }
                #
                #      public static Color toProto(java.awt.Color color) {
                #        float red = (float) color.getRed();
                #        float green = (float) color.getGreen();
                #        float blue = (float) color.getBlue();
                #        float denominator = 255.0;
                #        Color.Builder resultBuilder =
                #            Color
                #                .newBuilder()
                #                .setRed(red / denominator)
                #                .setGreen(green / denominator)
                #                .setBlue(blue / denominator);
                #        int alpha = color.getAlpha();
                #        if (alpha != 255) {
                #          result.setAlpha(
                #              FloatValue
                #                  .newBuilder()
                #                  .setValue(((float) alpha) / denominator)
                #                  .build());
                #        }
                #        return resultBuilder.build();
                #      }
                #      // ...
                #
                # Example (iOS / Obj-C):
                #
                #      // ...
                #      static UIColor* fromProto(Color* protocolor) {
                #         float red = [protocolor red];
                #         float green = [protocolor green];
                #         float blue = [protocolor blue];
                #         FloatValue* alpha_wrapper = [protocolor alpha];
                #         float alpha = 1.0;
                #         if (alpha_wrapper != nil) {
                #           alpha = [alpha_wrapper value];
                #         }
                #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                #      }
                #
                #      static Color* toProto(UIColor* color) {
                #          CGFloat red, green, blue, alpha;
                #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                #            return nil;
                #          }
                #          Color* result = [Color alloc] init];
                #          [result setRed:red];
                #          [result setGreen:green];
                #          [result setBlue:blue];
                #          if (alpha <= 0.9999) {
                #            [result setAlpha:floatWrapperWithValue(alpha)];
                #          }
                #          [result autorelease];
                #          return result;
                #     }
                #     // ...
                #
                #  Example (JavaScript):
                #
                #     // ...
                #
                #     var protoToCssColor = function(rgb_color) {
                #        var redFrac = rgb_color.red || 0.0;
                #        var greenFrac = rgb_color.green || 0.0;
                #        var blueFrac = rgb_color.blue || 0.0;
                #        var red = Math.floor(redFrac * 255);
                #        var green = Math.floor(greenFrac * 255);
                #        var blue = Math.floor(blueFrac * 255);
                #
                #        if (!('alpha' in rgb_color)) {
                #           return rgbToCssColor_(red, green, blue);
                #        }
                #
                #        var alphaFrac = rgb_color.alpha.value || 0.0;
                #        var rgbParams = [red, green, blue].join(',');
                #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                #     };
                #
                #     var rgbToCssColor_ = function(red, green, blue) {
                #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                #       var hexString = rgbNumber.toString(16);
                #       var missingZeros = 6 - hexString.length;
                #       var resultBuilder = ['#'];
                #       for (var i = 0; i < missingZeros; i++) {
                #          resultBuilder.push('0');
                #       }
                #       resultBuilder.push(hexString);
                #       return resultBuilder.join('');
                #     };
                #
                #     // ...
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                  # the final pixel color is defined by the equation:
                  #
                  #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                  #
                  # This means that a value of 1.0 corresponds to a solid color, whereas
                  # a value of 0.0 corresponds to a completely transparent color. This
                  # uses a wrapper message rather than a simple float scalar so that it is
                  # possible to distinguish between a default value and the value being unset.
                  # If omitted, this color object is to be rendered as a solid color
                  # (as if the alpha value had been explicitly given with a value of 1.0).
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
            "sheetId": 42, # The ID of the sheet. Must be non-negative.
                # This field cannot be changed once set.
          },
        },
      ],
    }
google-api-python-client-1.5.5/docs/dyn/sheets_v4.spreadsheets.sheets.html000066400000000000000000000224311300622755700266500ustar00rootroot00000000000000

Google Sheets API . spreadsheets . sheets

Instance Methods

copyTo(spreadsheetId, sheetId, body, x__xgafv=None)

Copies a single sheet from a spreadsheet to another spreadsheet.

Method Details

copyTo(spreadsheetId, sheetId, body, x__xgafv=None) 
Copies a single sheet from a spreadsheet to another spreadsheet.
Returns the properties of the newly created sheet.

Args:
  spreadsheetId: string, The ID of the spreadsheet containing the sheet to copy. (required)
  sheetId: integer, The ID of the sheet to copy. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request to copy a sheet across spreadsheets.
    "destinationSpreadsheetId": "A String", # The ID of the spreadsheet to copy the sheet to.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Properties of a sheet.
    "sheetType": "A String", # The type of sheet. Defaults to GRID.
        # This field cannot be changed once set.
    "index": 42, # The index of the sheet within the spreadsheet.
        # When adding or updating sheet properties, if this field
        # is excluded then the sheet will be added or moved to the end
        # of the sheet list.
    "title": "A String", # The name of the sheet.
    "gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.
        # (If the sheet is an object sheet, containing a chart or image, then
        # this field will be absent.)
        # When writing it is an error to set any grid properties on non-grid sheets.
      "columnCount": 42, # The number of columns in the grid.
      "rowCount": 42, # The number of rows in the grid.
      "frozenColumnCount": 42, # The number of columns that are frozen in the grid.
      "hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.
      "frozenRowCount": 42, # The number of rows that are frozen in the grid.
    },
    "rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.
    "tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.
        # for simplicity of conversion to/from color representations in various
        # languages over compactness; for example, the fields of this representation
        # can be trivially provided to the constructor of "java.awt.Color" in Java; it
        # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
        # method in iOS; and, with just a little work, it can be easily formatted into
        # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
        #
        # Example (Java):
        #
        #      import com.google.type.Color;
        #
        #      // ...
        #      public static java.awt.Color fromProto(Color protocolor) {
        #        float alpha = protocolor.hasAlpha()
        #            ? protocolor.getAlpha().getValue()
        #            : 1.0;
        #
        #        return new java.awt.Color(
        #            protocolor.getRed(),
        #            protocolor.getGreen(),
        #            protocolor.getBlue(),
        #            alpha);
        #      }
        #
        #      public static Color toProto(java.awt.Color color) {
        #        float red = (float) color.getRed();
        #        float green = (float) color.getGreen();
        #        float blue = (float) color.getBlue();
        #        float denominator = 255.0;
        #        Color.Builder resultBuilder =
        #            Color
        #                .newBuilder()
        #                .setRed(red / denominator)
        #                .setGreen(green / denominator)
        #                .setBlue(blue / denominator);
        #        int alpha = color.getAlpha();
        #        if (alpha != 255) {
        #          result.setAlpha(
        #              FloatValue
        #                  .newBuilder()
        #                  .setValue(((float) alpha) / denominator)
        #                  .build());
        #        }
        #        return resultBuilder.build();
        #      }
        #      // ...
        #
        # Example (iOS / Obj-C):
        #
        #      // ...
        #      static UIColor* fromProto(Color* protocolor) {
        #         float red = [protocolor red];
        #         float green = [protocolor green];
        #         float blue = [protocolor blue];
        #         FloatValue* alpha_wrapper = [protocolor alpha];
        #         float alpha = 1.0;
        #         if (alpha_wrapper != nil) {
        #           alpha = [alpha_wrapper value];
        #         }
        #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
        #      }
        #
        #      static Color* toProto(UIColor* color) {
        #          CGFloat red, green, blue, alpha;
        #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
        #            return nil;
        #          }
        #          Color* result = [Color alloc] init];
        #          [result setRed:red];
        #          [result setGreen:green];
        #          [result setBlue:blue];
        #          if (alpha <= 0.9999) {
        #            [result setAlpha:floatWrapperWithValue(alpha)];
        #          }
        #          [result autorelease];
        #          return result;
        #     }
        #     // ...
        #
        #  Example (JavaScript):
        #
        #     // ...
        #
        #     var protoToCssColor = function(rgb_color) {
        #        var redFrac = rgb_color.red || 0.0;
        #        var greenFrac = rgb_color.green || 0.0;
        #        var blueFrac = rgb_color.blue || 0.0;
        #        var red = Math.floor(redFrac * 255);
        #        var green = Math.floor(greenFrac * 255);
        #        var blue = Math.floor(blueFrac * 255);
        #
        #        if (!('alpha' in rgb_color)) {
        #           return rgbToCssColor_(red, green, blue);
        #        }
        #
        #        var alphaFrac = rgb_color.alpha.value || 0.0;
        #        var rgbParams = [red, green, blue].join(',');
        #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
        #     };
        #
        #     var rgbToCssColor_ = function(red, green, blue) {
        #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
        #       var hexString = rgbNumber.toString(16);
        #       var missingZeros = 6 - hexString.length;
        #       var resultBuilder = ['#'];
        #       for (var i = 0; i < missingZeros; i++) {
        #          resultBuilder.push('0');
        #       }
        #       resultBuilder.push(hexString);
        #       return resultBuilder.join('');
        #     };
        #
        #     // ...
      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
          # the final pixel color is defined by the equation:
          #
          #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
          #
          # This means that a value of 1.0 corresponds to a solid color, whereas
          # a value of 0.0 corresponds to a completely transparent color. This
          # uses a wrapper message rather than a simple float scalar so that it is
          # possible to distinguish between a default value and the value being unset.
          # If omitted, this color object is to be rendered as a solid color
          # (as if the alpha value had been explicitly given with a value of 1.0).
      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
    },
    "hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.
    "sheetId": 42, # The ID of the sheet. Must be non-negative.
        # This field cannot be changed once set.
  }
google-api-python-client-1.5.5/docs/dyn/sheets_v4.spreadsheets.values.html000066400000000000000000000527711300622755700266660ustar00rootroot00000000000000

Google Sheets API . spreadsheets . values

Instance Methods

append(spreadsheetId, range=None, body, insertDataOption=None, valueInputOption=None, x__xgafv=None)

Appends values to a spreadsheet. The input range is used to search for

batchClear(spreadsheetId, body, x__xgafv=None)

Clears one or more ranges of values from a spreadsheet.

batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)

Returns one or more ranges of values from a spreadsheet.

batchUpdate(spreadsheetId, body, x__xgafv=None)

Sets values in one or more ranges of a spreadsheet.

clear(spreadsheetId, range, body, x__xgafv=None)

Clears values from a spreadsheet.

get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)

Returns a range of values from a spreadsheet.

update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None)

Sets values in a range of a spreadsheet.

Method Details

append(spreadsheetId, range=None, body, insertDataOption=None, valueInputOption=None, x__xgafv=None) 
Appends values to a spreadsheet. The input range is used to search for
existing data and find a "table" within that range. Values will be
appended to the next row of the table, starting with the first column of
the table. See the
[guide](/sheets/guides/values#appending_values)
and
[sample code](/sheets/samples/writing#append_values)
for specific details of how tables are detected and data is appended.

The caller must specify the spreadsheet ID, range, and
a valueInputOption.  The `valueInputOption` only
controls how the input data will be added to the sheet (column-wise or
row-wise), it does not influence what cell the data starts being written
to.

Args:
  spreadsheetId: string, The ID of the spreadsheet to update. (required)
  range: string, The A1 notation of a range to search for a logical table of data.
Values will be appended after the last row of the table. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Data within a range of the spreadsheet.
  "range": "A String", # The range the values cover, in A1 notation.
      # For output, this range indicates the entire requested range,
      # even though the values will exclude trailing rows and columns.
      # When appending values, this field represents the range to search for a
      # table, after which values will be appended.
  "values": [ # The data that was read or to be written.  This is an array of arrays,
      # the outer array representing all the data and each inner array
      # representing a major dimension. Each item in the inner array
      # corresponds with one cell.
      # 
      # For output, empty trailing rows and columns will not be included.
      # 
      # For input, supported value types are: bool, string, and double.
      # Null values will be skipped.
      # To set a cell to an empty value, set the string value to an empty string.
    [
      "",
    ],
  ],
  "majorDimension": "A String", # The major dimension of the values.
      # 
      # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
      # then requesting `range=A1:B2,majorDimension=ROWS` will return
      # `[[1,2],[3,4]]`,
      # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
      # `[[1,3],[2,4]]`.
      # 
      # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
      # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
      # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
      # 
      # When writing, if this field is not set, it defaults to ROWS.
}

  insertDataOption: string, How the input data should be inserted.
  valueInputOption: string, How the input data should be interpreted.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response when updating a range of values in a spreadsheet.
    "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
    "tableRange": "A String", # The range (in A1 notation) of the table that values are being appended to
        # (before the values were appended).
        # Empty if no table was found.
    "updates": { # The response when updating a range of values in a spreadsheet. # Information about the updates that were applied.
      "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
      "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
      "updatedCells": 42, # The number of cells updated.
      "updatedRows": 42, # The number of rows where at least one cell in the row was updated.
      "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
    },
  }
batchClear(spreadsheetId, body, x__xgafv=None) 
Clears one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more ranges.
Only values are cleared -- all other properties of the cell (such as
formatting, data validation, etc..) are kept.

Args:
  spreadsheetId: string, The ID of the spreadsheet to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for clearing more than one range of values in a spreadsheet.
    "ranges": [ # The ranges to clear, in A1 notation.
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response when updating a range of values in a spreadsheet.
    "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
    "clearedRanges": [ # The ranges that were cleared, in A1 notation.
        # (If the requests were for an unbounded range or a ranger larger
        #  than the bounds of the sheet, this will be the actual ranges
        #  that were cleared, bounded to the sheet's limits.)
      "A String",
    ],
  }
batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None) 
Returns one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more ranges.

Args:
  spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
  valueRenderOption: string, How values should be represented in the output.
  majorDimension: string, The major dimension that results should use.

For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
then requesting `range=A1:B2,majorDimension=ROWS` will return
`[[1,2],[3,4]]`,
whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`.
  ranges: string, The A1 notation of the values to retrieve. (repeated)
  dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
This is ignored if value_render_option is
FORMATTED_VALUE.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response when retrieving more than one range of values in a spreadsheet.
    "spreadsheetId": "A String", # The ID of the spreadsheet the data was retrieved from.
    "valueRanges": [ # The requested values. The order of the ValueRanges is the same as the
        # order of the requested ranges.
      { # Data within a range of the spreadsheet.
        "range": "A String", # The range the values cover, in A1 notation.
            # For output, this range indicates the entire requested range,
            # even though the values will exclude trailing rows and columns.
            # When appending values, this field represents the range to search for a
            # table, after which values will be appended.
        "values": [ # The data that was read or to be written.  This is an array of arrays,
            # the outer array representing all the data and each inner array
            # representing a major dimension. Each item in the inner array
            # corresponds with one cell.
            #
            # For output, empty trailing rows and columns will not be included.
            #
            # For input, supported value types are: bool, string, and double.
            # Null values will be skipped.
            # To set a cell to an empty value, set the string value to an empty string.
          [
            "",
          ],
        ],
        "majorDimension": "A String", # The major dimension of the values.
            #
            # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
            # then requesting `range=A1:B2,majorDimension=ROWS` will return
            # `[[1,2],[3,4]]`,
            # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
            # `[[1,3],[2,4]]`.
            #
            # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
            # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
            # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
            #
            # When writing, if this field is not set, it defaults to ROWS.
      },
    ],
  }
batchUpdate(spreadsheetId, body, x__xgafv=None) 
Sets values in one or more ranges of a spreadsheet.
The caller must specify the spreadsheet ID,
a valueInputOption, and one or more
ValueRanges.

Args:
  spreadsheetId: string, The ID of the spreadsheet to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for updating more than one range of values in a spreadsheet.
    "data": [ # The new values to apply to the spreadsheet.
      { # Data within a range of the spreadsheet.
        "range": "A String", # The range the values cover, in A1 notation.
            # For output, this range indicates the entire requested range,
            # even though the values will exclude trailing rows and columns.
            # When appending values, this field represents the range to search for a
            # table, after which values will be appended.
        "values": [ # The data that was read or to be written.  This is an array of arrays,
            # the outer array representing all the data and each inner array
            # representing a major dimension. Each item in the inner array
            # corresponds with one cell.
            #
            # For output, empty trailing rows and columns will not be included.
            #
            # For input, supported value types are: bool, string, and double.
            # Null values will be skipped.
            # To set a cell to an empty value, set the string value to an empty string.
          [
            "",
          ],
        ],
        "majorDimension": "A String", # The major dimension of the values.
            #
            # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
            # then requesting `range=A1:B2,majorDimension=ROWS` will return
            # `[[1,2],[3,4]]`,
            # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
            # `[[1,3],[2,4]]`.
            #
            # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
            # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
            # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
            #
            # When writing, if this field is not set, it defaults to ROWS.
      },
    ],
    "valueInputOption": "A String", # How the input data should be interpreted.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response when updating a range of values in a spreadsheet.
    "responses": [ # One UpdateValuesResponse per requested range, in the same order as
        # the requests appeared.
      { # The response when updating a range of values in a spreadsheet.
        "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
        "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
        "updatedCells": 42, # The number of cells updated.
        "updatedRows": 42, # The number of rows where at least one cell in the row was updated.
        "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
      },
    ],
    "totalUpdatedCells": 42, # The total number of cells updated.
    "totalUpdatedColumns": 42, # The total number of columns where at least one cell in the column was
        # updated.
    "totalUpdatedRows": 42, # The total number of rows where at least one cell in the row was updated.
    "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
    "totalUpdatedSheets": 42, # The total number of sheets where at least one cell in the sheet was
        # updated.
  }
clear(spreadsheetId, range, body, x__xgafv=None) 
Clears values from a spreadsheet.
The caller must specify the spreadsheet ID and range.
Only values are cleared -- all other properties of the cell (such as
formatting, data validation, etc..) are kept.

Args:
  spreadsheetId: string, The ID of the spreadsheet to update. (required)
  range: string, The A1 notation of the values to clear. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request for clearing a range of values in a spreadsheet.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response when clearing a range of values in a spreadsheet.
    "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
    "clearedRange": "A String", # The range (in A1 notation) that was cleared.
        # (If the request was for an unbounded range or a ranger larger
        #  than the bounds of the sheet, this will be the actual range
        #  that was cleared, bounded to the sheet's limits.)
  }
get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None) 
Returns a range of values from a spreadsheet.
The caller must specify the spreadsheet ID and a range.

Args:
  spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
  range: string, The A1 notation of the values to retrieve. (required)
  valueRenderOption: string, How values should be represented in the output.
  majorDimension: string, The major dimension that results should use.

For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
then requesting `range=A1:B2,majorDimension=ROWS` will return
`[[1,2],[3,4]]`,
whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`.
  dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
This is ignored if value_render_option is
FORMATTED_VALUE.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Data within a range of the spreadsheet.
    "range": "A String", # The range the values cover, in A1 notation.
        # For output, this range indicates the entire requested range,
        # even though the values will exclude trailing rows and columns.
        # When appending values, this field represents the range to search for a
        # table, after which values will be appended.
    "values": [ # The data that was read or to be written.  This is an array of arrays,
        # the outer array representing all the data and each inner array
        # representing a major dimension. Each item in the inner array
        # corresponds with one cell.
        #
        # For output, empty trailing rows and columns will not be included.
        #
        # For input, supported value types are: bool, string, and double.
        # Null values will be skipped.
        # To set a cell to an empty value, set the string value to an empty string.
      [
        "",
      ],
    ],
    "majorDimension": "A String", # The major dimension of the values.
        #
        # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
        # then requesting `range=A1:B2,majorDimension=ROWS` will return
        # `[[1,2],[3,4]]`,
        # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
        # `[[1,3],[2,4]]`.
        #
        # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
        # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
        # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
        #
        # When writing, if this field is not set, it defaults to ROWS.
  }
update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None) 
Sets values in a range of a spreadsheet.
The caller must specify the spreadsheet ID, range, and
a valueInputOption.

Args:
  spreadsheetId: string, The ID of the spreadsheet to update. (required)
  range: string, The A1 notation of the values to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Data within a range of the spreadsheet.
  "range": "A String", # The range the values cover, in A1 notation.
      # For output, this range indicates the entire requested range,
      # even though the values will exclude trailing rows and columns.
      # When appending values, this field represents the range to search for a
      # table, after which values will be appended.
  "values": [ # The data that was read or to be written.  This is an array of arrays,
      # the outer array representing all the data and each inner array
      # representing a major dimension. Each item in the inner array
      # corresponds with one cell.
      # 
      # For output, empty trailing rows and columns will not be included.
      # 
      # For input, supported value types are: bool, string, and double.
      # Null values will be skipped.
      # To set a cell to an empty value, set the string value to an empty string.
    [
      "",
    ],
  ],
  "majorDimension": "A String", # The major dimension of the values.
      # 
      # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
      # then requesting `range=A1:B2,majorDimension=ROWS` will return
      # `[[1,2],[3,4]]`,
      # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
      # `[[1,3],[2,4]]`.
      # 
      # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
      # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
      # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
      # 
      # When writing, if this field is not set, it defaults to ROWS.
}

  valueInputOption: string, How the input data should be interpreted.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response when updating a range of values in a spreadsheet.
    "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
    "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
    "updatedCells": 42, # The number of cells updated.
    "updatedRows": 42, # The number of rows where at least one cell in the row was updated.
    "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
  }
google-api-python-client-1.5.5/docs/dyn/siteVerification_v1.html000066400000000000000000000041661300622755700247030ustar00rootroot00000000000000

Google Site Verification API

Instance Methods

webResource()

Returns the webResource Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/siteVerification_v1.webResource.html000066400000000000000000000245471300622755700271740ustar00rootroot00000000000000

Google Site Verification API . webResource

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).
      },
    }
google-api-python-client-1.5.5/docs/dyn/spectrum_v1explorer.html000066400000000000000000000041411300622755700250100ustar00rootroot00000000000000

Google Spectrum Database API

Instance Methods

paws()

Returns the paws Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/spectrum_v1explorer.paws.html000066400000000000000000003472661300622755700260030ustar00rootroot00000000000000

Google Spectrum Database API . paws

Instance Methods

getSpectrum(body)

Requests information about the available spectrum for a device at a location. Requests from a fixed-mode device must include owner information so the device can be registered with the database.

getSpectrumBatch(body)

The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error.

init(body)

Initializes the connection between a white space device and the database.

notifySpectrumUse(body)

Notifies the database that the device has selected certain frequency ranges for transmission. Only to be invoked when required by the regulator. The Google Spectrum Database does not operate in domains that require notification, so this always yields an UNIMPLEMENTED error.

register(body)

The Google Spectrum Database implements registration in the getSpectrum method. As such this always returns an UNIMPLEMENTED error.

verifyDevice(body)

Validates a device for white space use in accordance with regulatory rules. The Google Spectrum Database does not support master/slave configurations, so this always yields an UNIMPLEMENTED error.

Method Details

getSpectrum(body) 
Requests information about the available spectrum for a device at a location. Requests from a fixed-mode device must include owner information so the device can be registered with the database.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for the available spectrum query protocol which must include the device's geolocation.
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for that device is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        # 
        # Required field.
    "antenna": { # Antenna characteristics provide additional information, such as the antenna height, antenna type, etc. Whether antenna characteristics must be provided in a request depends on the device type and regulatory domain. # Depending on device type and regulatory domain, the characteristics of the antenna may be required.
      "heightType": "A String", # If the height is required, then the height type (AGL for above ground level or AMSL for above mean sea level) is also required. The default is AGL.
      "heightUncertainty": 3.14, # The height uncertainty in meters. Whether this is required depends on the regulatory domain.
      "height": 3.14, # The antenna height in meters. Whether the antenna height is required depends on the device type and the regulatory domain. Note that the height may be negative.
    },
    "requestType": "A String", # The request type parameter is an optional parameter that can be used to modify an available spectrum request, but its use depends on applicable regulatory rules. It may be used, for example, to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the deviceDesc parameter for the device on whose behalf the request is made is required.
    "capabilities": { # Device capabilities provide additional information that may be used by a device to provide additional information to the database that may help it to determine available spectrum. If the database does not support device capabilities it will ignore the parameter altogether. # The master device may include its device capabilities to limit the available-spectrum response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.
      "frequencyRanges": [ # An optional list of frequency ranges supported by the device. Each element must contain start and stop frequencies in which the device can operate. Channel identifiers are optional. When specified, the database should not return available spectrum that falls outside these ranges or channel IDs.
        { # A specific range of frequencies together with the associated maximum power level and channel identifier.
          "startHz": 3.14, # The required inclusive start of the frequency range (in Hertz).
          "channelId": "A String", # The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
          "stopHz": 3.14, # The required exclusive end of the frequency range (in Hertz).
          "maxPowerDBm": 3.14, # The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
        },
      ],
    },
    "masterDeviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # When an available spectrum request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device, which is provided in a separate parameter).
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "location": { # This parameter is used to specify the geolocation of the device. # The geolocation of the master device (a device with geolocation capability that makes an available spectrum request) is required whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability). The location must be the location of the radiation center of the master device's antenna. To support mobile devices, a regulatory domain may allow the anticipated position of the master device to be given instead. If the location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error code if it does not support query by region.
      "confidence": 42, # The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
      "region": { # A region is represented using the polygonal shape. # If present, indicates that the geolocation represents a region. Database support for regions is optional.
        "exterior": [ # When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
            # - A connecting line shall not cross another connecting line of the same polygon.
            # - The vertices must be defined in a counterclockwise order.
            # - The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
            # - All vertices are assumed to be at the same altitude.
            # - Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
          { # A single geolocation on the globe.
            "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          },
        ],
      },
      "point": { # A "point" with uncertainty is represented using the Ellipse shape. # If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
        "semiMajorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "center": { # A single geolocation on the globe. # A required geo-spatial point representing the center of the ellipse.
          "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
        },
        "semiMinorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "orientation": 3.14, # A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
      },
    },
    "owner": { # This parameter contains device-owner information required as part of device registration. The regulatory domains may require additional parameters. # Depending on device type and regulatory domain, device owner information may be included in an available spectrum request. This allows the device to register and get spectrum-availability information in a single request.
        #
        # All contact information must be expressed using the structure defined by the vCard format specification. Only the contact fields of vCard are supported:
        # - fn: Full name of an individual
        # - org: Name of the organization
        # - adr: Address fields
        # - tel: Telephone numbers
        # - email: Email addresses
        #
        # Note that the vCard specification defines maximum lengths for each field.
      "operator": { # A vCard-in-JSON message that contains only the fields needed for PAWS: # The vCard contact information for the device operator is optional, but may be required by specific regulatory domains.
          # - fn: Full name of an individual
          # - org: Name of the organization
          # - adr: Address fields
          # - tel: Telephone numbers
          # - email: Email addresses
        "org": { # The structure used to represent an organization and an email address. # The organization associated with the registering entity.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "tel": { # The structure used to represent a telephone number. # A telephone number that can be used to call the contact.
          "uri": "A String", # A nested telephone URI of the form: tel:+1-123-456-7890.
        },
        "adr": { # The structure used to represent a street address. # The street address of the entity.
          "code": "A String", # The postal code associated with the address. For example: 94423.
          "locality": "A String", # The city or local equivalent portion of the address. For example: San Jose.
          "country": "A String", # The country name. For example: US.
          "region": "A String", # The state or local equivalent portion of the address. For example: CA.
          "pobox": "A String", # An optional post office box number.
          "street": "A String", # The street number and name. For example: 123 Any St.
        },
        "email": { # The structure used to represent an organization and an email address. # An email address that can be used to reach the contact.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "fn": "A String", # The full name of the contact person. For example: John A. Smith.
      },
      "owner": { # A vCard-in-JSON message that contains only the fields needed for PAWS: # The vCard contact information for the individual or business that owns the device is required.
          # - fn: Full name of an individual
          # - org: Name of the organization
          # - adr: Address fields
          # - tel: Telephone numbers
          # - email: Email addresses
        "org": { # The structure used to represent an organization and an email address. # The organization associated with the registering entity.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "tel": { # The structure used to represent a telephone number. # A telephone number that can be used to call the contact.
          "uri": "A String", # A nested telephone URI of the form: tel:+1-123-456-7890.
        },
        "adr": { # The structure used to represent a street address. # The street address of the entity.
          "code": "A String", # The postal code associated with the address. For example: 94423.
          "locality": "A String", # The city or local equivalent portion of the address. For example: San Jose.
          "country": "A String", # The country name. For example: US.
          "region": "A String", # The state or local equivalent portion of the address. For example: CA.
          "pobox": "A String", # An optional post office box number.
          "street": "A String", # The street number and name. For example: 123 Any St.
        },
        "email": { # The structure used to represent an organization and an email address. # An email address that can be used to reach the contact.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "fn": "A String", # The full name of the contact person. For example: John A. Smith.
      },
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        # 
        # Required field.
  }


Returns:
  An object of the form:

    { # The response message for the available spectrum query which contains a schedule of available spectrum for the device.
    "kind": "spectrum#pawsGetSpectrumResponse", # Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsGetSpectrumResponse".
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # The database must return, in its available spectrum response, the device descriptor information it received in the master device's available spectrum request.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        #
        # Required field.
    "timestamp": "A String", # The database includes a timestamp of the form YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339) in its available spectrum response. The timestamp should be used by the device as a reference for the start and stop times specified in the response spectrum schedules.
    "databaseChange": { # This message is provided by the database to notify devices of an upcoming change to the database URI. # A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
      "databases": [ # A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
        { # This message contains the name and URI of a database.
          "name": "A String", # The display name for a database.
          "uri": "A String", # The corresponding URI of the database.
        },
      ],
    },
    "spectrumSchedules": [ # The available spectrum response must contain a spectrum schedule list. The list may be empty if spectrum is not available. The database may return more than one spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends on the applicable regulatory domain.
      { # The spectrum schedule element combines an event time with spectrum profile to define a time period in which the profile is valid.
        "eventTime": { # The start and stop times of an event. This is used to indicate the time period for which a spectrum profile is valid. # The event time expresses when the spectrum profile is valid. It will always be present.
            #
            # Both times are expressed using the format, YYYY-MM-DDThh:mm:ssZ, as defined in RFC3339. The times must be expressed using UTC.
          "stopTime": "A String", # The exclusive end of the event. It will be present.
          "startTime": "A String", # The inclusive start of the event. It will be present.
        },
        "spectra": [ # A list of spectrum messages representing the usable profile. It will always be present, but may be empty when there is no available spectrum.
          { # Available spectrum can be logically characterized by a list of frequency ranges and permissible power levels for each range.
            "bandwidth": 3.14, # The bandwidth (in Hertz) for which permissible power levels are specified. For example, FCC regulation would require only one spectrum specification at 6MHz bandwidth, but Ofcom regulation would require two specifications, at 0.1MHz and 8MHz. This parameter may be empty if there is no available spectrum. It will be present otherwise.
            "frequencyRanges": [ # The list of frequency ranges and permissible power levels. The list may be empty if there is no available spectrum, otherwise it will be present.
              { # A specific range of frequencies together with the associated maximum power level and channel identifier.
                "startHz": 3.14, # The required inclusive start of the frequency range (in Hertz).
                "channelId": "A String", # The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
                "stopHz": 3.14, # The required exclusive end of the frequency range (in Hertz).
                "maxPowerDBm": 3.14, # The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
              },
            ],
          },
        ],
      },
    ],
    "maxContiguousBwHz": 3.14, # The database may return a constraint on the allowed maximum contiguous bandwidth (in Hertz). A regulatory domain may require the database to return this parameter. When this parameter is present in the response, the device must apply this constraint to its spectrum-selection logic to ensure that no single block of spectrum has bandwidth that exceeds this value.
    "needsSpectrumReport": True or False, # For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the spectrum schedule list is not empty; otherwise, the database will either return false or omit this parameter. If this parameter is present and its value is true, the device must send a spectrum use notify message to the database; otherwise, the device must not send the notification.
    "maxTotalBwHz": 3.14, # The database may return a constraint on the allowed maximum total bandwidth (in Hertz), which need not be contiguous. A regulatory domain may require the database to return this parameter. When this parameter is present in the available spectrum response, the device must apply this constraint to its spectrum-selection logic to ensure that total bandwidth does not exceed this value.
    "rulesetInfo": { # This contains parameters for the ruleset of a regulatory domain that is communicated using the initialization and available-spectrum processes. # The database should return ruleset information, which identifies the applicable regulatory authority and ruleset for the available spectrum response. If included, the device must use the corresponding ruleset to interpret the response. Values provided in the returned ruleset information, such as maxLocationChange, take precedence over any conflicting values provided in the ruleset information returned in a prior initialization response sent by the database to the device.
      "rulesetIds": [ # The identifiers of the rulesets supported for the device's location. The database should include at least one applicable ruleset in the initialization response. The device may use the ruleset identifiers to determine parameters to include in subsequent requests. Within the context of the available-spectrum responses, the database should include the identifier of the ruleset that it used to determine the available-spectrum response. If included, the device must use the specified ruleset to interpret the response. If the device does not support the indicated ruleset, it must not operate in the spectrum governed by the ruleset.
        "A String",
      ],
      "maxPollingSecs": 42, # The maximum duration, in seconds, between requests for available spectrum. It is required in the initialization response, but optional otherwise. The device must contact the database to get available spectrum no less frequently than this duration. If the new spectrum information indicates that the device is using spectrum that is no longer available, it must immediately cease use of those frequencies under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
      "maxLocationChange": 3.14, # The maximum location change in meters is required in the initialization response, but optional otherwise. When the device changes location by more than this specified distance, it must contact the database to get the available spectrum for the new location. If the device is using spectrum that is no longer available, it must immediately cease use of the spectrum under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
      "authority": "A String", # The regulatory domain to which the ruleset belongs is required. It must be a 2-letter country code. The device should use this to determine additional device behavior required by the associated regulatory domain.
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        #
        # Required field.
  }
getSpectrumBatch(body) 
The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for a batch available spectrum query protocol.
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for the device on whose behalf the request is made is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        # 
        # Required field.
    "antenna": { # Antenna characteristics provide additional information, such as the antenna height, antenna type, etc. Whether antenna characteristics must be provided in a request depends on the device type and regulatory domain. # Depending on device type and regulatory domain, antenna characteristics may be required.
      "heightType": "A String", # If the height is required, then the height type (AGL for above ground level or AMSL for above mean sea level) is also required. The default is AGL.
      "heightUncertainty": 3.14, # The height uncertainty in meters. Whether this is required depends on the regulatory domain.
      "height": 3.14, # The antenna height in meters. Whether the antenna height is required depends on the device type and the regulatory domain. Note that the height may be negative.
    },
    "requestType": "A String", # The request type parameter is an optional parameter that can be used to modify an available spectrum batch request, but its use depends on applicable regulatory rules. For example, It may be used to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the device descriptor parameter for the device on whose behalf the batch request is made is required.
    "locations": [ # A geolocation list is required. This allows a device to specify its current location plus additional anticipated locations when allowed by the regulatory domain. At least one location must be included. Geolocation must be given as the location of the radiation center of the device's antenna. If a location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error if it does not support query by region.
        # 
        # There is no upper limit on the number of locations included in a available spectrum batch request, but the database may restrict the number of locations it supports by returning a response with fewer locations than specified in the batch request. Note that geolocations must be those of the master device (a device with geolocation capability that makes an available spectrum batch request), whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability).
      { # This parameter is used to specify the geolocation of the device.
        "confidence": 42, # The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
        "region": { # A region is represented using the polygonal shape. # If present, indicates that the geolocation represents a region. Database support for regions is optional.
          "exterior": [ # When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
              # - A connecting line shall not cross another connecting line of the same polygon.
              # - The vertices must be defined in a counterclockwise order.
              # - The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
              # - All vertices are assumed to be at the same altitude.
              # - Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
            { # A single geolocation on the globe.
              "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
              "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            },
          ],
        },
        "point": { # A "point" with uncertainty is represented using the Ellipse shape. # If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
          "semiMajorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
          "center": { # A single geolocation on the globe. # A required geo-spatial point representing the center of the ellipse.
            "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          },
          "semiMinorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
          "orientation": 3.14, # A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
        },
      },
    ],
    "capabilities": { # Device capabilities provide additional information that may be used by a device to provide additional information to the database that may help it to determine available spectrum. If the database does not support device capabilities it will ignore the parameter altogether. # The master device may include its device capabilities to limit the available-spectrum batch response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.
      "frequencyRanges": [ # An optional list of frequency ranges supported by the device. Each element must contain start and stop frequencies in which the device can operate. Channel identifiers are optional. When specified, the database should not return available spectrum that falls outside these ranges or channel IDs.
        { # A specific range of frequencies together with the associated maximum power level and channel identifier.
          "startHz": 3.14, # The required inclusive start of the frequency range (in Hertz).
          "channelId": "A String", # The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
          "stopHz": 3.14, # The required exclusive end of the frequency range (in Hertz).
          "maxPowerDBm": 3.14, # The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
        },
      ],
    },
    "masterDeviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # When an available spectrum batch request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device in a separate parameter).
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "owner": { # This parameter contains device-owner information required as part of device registration. The regulatory domains may require additional parameters. # Depending on device type and regulatory domain, device owner information may be included in an available spectrum batch request. This allows the device to register and get spectrum-availability information in a single request.
        #
        # All contact information must be expressed using the structure defined by the vCard format specification. Only the contact fields of vCard are supported:
        # - fn: Full name of an individual
        # - org: Name of the organization
        # - adr: Address fields
        # - tel: Telephone numbers
        # - email: Email addresses
        #
        # Note that the vCard specification defines maximum lengths for each field.
      "operator": { # A vCard-in-JSON message that contains only the fields needed for PAWS: # The vCard contact information for the device operator is optional, but may be required by specific regulatory domains.
          # - fn: Full name of an individual
          # - org: Name of the organization
          # - adr: Address fields
          # - tel: Telephone numbers
          # - email: Email addresses
        "org": { # The structure used to represent an organization and an email address. # The organization associated with the registering entity.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "tel": { # The structure used to represent a telephone number. # A telephone number that can be used to call the contact.
          "uri": "A String", # A nested telephone URI of the form: tel:+1-123-456-7890.
        },
        "adr": { # The structure used to represent a street address. # The street address of the entity.
          "code": "A String", # The postal code associated with the address. For example: 94423.
          "locality": "A String", # The city or local equivalent portion of the address. For example: San Jose.
          "country": "A String", # The country name. For example: US.
          "region": "A String", # The state or local equivalent portion of the address. For example: CA.
          "pobox": "A String", # An optional post office box number.
          "street": "A String", # The street number and name. For example: 123 Any St.
        },
        "email": { # The structure used to represent an organization and an email address. # An email address that can be used to reach the contact.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "fn": "A String", # The full name of the contact person. For example: John A. Smith.
      },
      "owner": { # A vCard-in-JSON message that contains only the fields needed for PAWS: # The vCard contact information for the individual or business that owns the device is required.
          # - fn: Full name of an individual
          # - org: Name of the organization
          # - adr: Address fields
          # - tel: Telephone numbers
          # - email: Email addresses
        "org": { # The structure used to represent an organization and an email address. # The organization associated with the registering entity.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "tel": { # The structure used to represent a telephone number. # A telephone number that can be used to call the contact.
          "uri": "A String", # A nested telephone URI of the form: tel:+1-123-456-7890.
        },
        "adr": { # The structure used to represent a street address. # The street address of the entity.
          "code": "A String", # The postal code associated with the address. For example: 94423.
          "locality": "A String", # The city or local equivalent portion of the address. For example: San Jose.
          "country": "A String", # The country name. For example: US.
          "region": "A String", # The state or local equivalent portion of the address. For example: CA.
          "pobox": "A String", # An optional post office box number.
          "street": "A String", # The street number and name. For example: 123 Any St.
        },
        "email": { # The structure used to represent an organization and an email address. # An email address that can be used to reach the contact.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "fn": "A String", # The full name of the contact person. For example: John A. Smith.
      },
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        # 
        # Required field.
  }


Returns:
  An object of the form:

    { # The response message for the batch available spectrum query contains a schedule of available spectrum for the device at multiple locations.
    "maxContiguousBwHz": 3.14, # The database may return a constraint on the allowed maximum contiguous bandwidth (in Hertz). A regulatory domain may require the database to return this parameter. When this parameter is present in the response, the device must apply this constraint to its spectrum-selection logic to ensure that no single block of spectrum has bandwidth that exceeds this value.
    "kind": "spectrum#pawsGetSpectrumBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsGetSpectrumBatchResponse".
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # The database must return in its available spectrum response the device descriptor information it received in the master device's available spectrum batch request.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        #
        # Required field.
    "timestamp": "A String", # The database includes a timestamp of the form, YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339), in its available spectrum batch response. The timestamp should be used by the device as a reference for the start and stop times specified in the response spectrum schedules.
    "databaseChange": { # This message is provided by the database to notify devices of an upcoming change to the database URI. # A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
      "databases": [ # A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
        { # This message contains the name and URI of a database.
          "name": "A String", # The display name for a database.
          "uri": "A String", # The corresponding URI of the database.
        },
      ],
    },
    "geoSpectrumSchedules": [ # The available spectrum batch response must contain a geo-spectrum schedule list, The list may be empty if spectrum is not available. The database may return more than one geo-spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends upon the applicable regulatory domain. The database may return available spectrum for fewer geolocations than requested. The device must not make assumptions about the order of the entries in the list, and must use the geolocation value in each geo-spectrum schedule entry to match available spectrum to a location.
      { # The schedule of spectrum profiles available at a particular geolocation.
        "spectrumSchedules": [ # A list of available spectrum profiles and associated times. It will always be present, and at least one schedule must be included (though it may be empty if there is no available spectrum). More than one schedule may be included to represent future changes to the available spectrum.
          { # The spectrum schedule element combines an event time with spectrum profile to define a time period in which the profile is valid.
            "eventTime": { # The start and stop times of an event. This is used to indicate the time period for which a spectrum profile is valid. # The event time expresses when the spectrum profile is valid. It will always be present.
                #
                # Both times are expressed using the format, YYYY-MM-DDThh:mm:ssZ, as defined in RFC3339. The times must be expressed using UTC.
              "stopTime": "A String", # The exclusive end of the event. It will be present.
              "startTime": "A String", # The inclusive start of the event. It will be present.
            },
            "spectra": [ # A list of spectrum messages representing the usable profile. It will always be present, but may be empty when there is no available spectrum.
              { # Available spectrum can be logically characterized by a list of frequency ranges and permissible power levels for each range.
                "bandwidth": 3.14, # The bandwidth (in Hertz) for which permissible power levels are specified. For example, FCC regulation would require only one spectrum specification at 6MHz bandwidth, but Ofcom regulation would require two specifications, at 0.1MHz and 8MHz. This parameter may be empty if there is no available spectrum. It will be present otherwise.
                "frequencyRanges": [ # The list of frequency ranges and permissible power levels. The list may be empty if there is no available spectrum, otherwise it will be present.
                  { # A specific range of frequencies together with the associated maximum power level and channel identifier.
                    "startHz": 3.14, # The required inclusive start of the frequency range (in Hertz).
                    "channelId": "A String", # The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
                    "stopHz": 3.14, # The required exclusive end of the frequency range (in Hertz).
                    "maxPowerDBm": 3.14, # The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
                  },
                ],
              },
            ],
          },
        ],
        "location": { # This parameter is used to specify the geolocation of the device. # The geolocation identifies the location at which the spectrum schedule applies. It will always be present.
          "confidence": 42, # The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
          "region": { # A region is represented using the polygonal shape. # If present, indicates that the geolocation represents a region. Database support for regions is optional.
            "exterior": [ # When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
                # - A connecting line shall not cross another connecting line of the same polygon.
                # - The vertices must be defined in a counterclockwise order.
                # - The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
                # - All vertices are assumed to be at the same altitude.
                # - Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
              { # A single geolocation on the globe.
                "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
                "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
              },
            ],
          },
          "point": { # A "point" with uncertainty is represented using the Ellipse shape. # If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
            "semiMajorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
            "center": { # A single geolocation on the globe. # A required geo-spatial point representing the center of the ellipse.
              "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
              "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            },
            "semiMinorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
            "orientation": 3.14, # A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
          },
        },
      },
    ],
    "needsSpectrumReport": True or False, # For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the geo-spectrum schedules list is not empty; otherwise, the database should either return false or omit this parameter. If this parameter is present and its value is true, the device must send a spectrum use notify message to the database; otherwise, the device should not send the notification.
    "maxTotalBwHz": 3.14, # The database may return a constraint on the allowed maximum total bandwidth (in Hertz), which does not need to be contiguous. A regulatory domain may require the database to return this parameter. When this parameter is present in the available spectrum batch response, the device must apply this constraint to its spectrum-selection logic to ensure that total bandwidth does not exceed this value.
    "rulesetInfo": { # This contains parameters for the ruleset of a regulatory domain that is communicated using the initialization and available-spectrum processes. # The database should return ruleset information, which identifies the applicable regulatory authority and ruleset for the available spectrum batch response. If included, the device must use the corresponding ruleset to interpret the response. Values provided in the returned ruleset information, such as maxLocationChange, take precedence over any conflicting values provided in the ruleset information returned in a prior initialization response sent by the database to the device.
      "rulesetIds": [ # The identifiers of the rulesets supported for the device's location. The database should include at least one applicable ruleset in the initialization response. The device may use the ruleset identifiers to determine parameters to include in subsequent requests. Within the context of the available-spectrum responses, the database should include the identifier of the ruleset that it used to determine the available-spectrum response. If included, the device must use the specified ruleset to interpret the response. If the device does not support the indicated ruleset, it must not operate in the spectrum governed by the ruleset.
        "A String",
      ],
      "maxPollingSecs": 42, # The maximum duration, in seconds, between requests for available spectrum. It is required in the initialization response, but optional otherwise. The device must contact the database to get available spectrum no less frequently than this duration. If the new spectrum information indicates that the device is using spectrum that is no longer available, it must immediately cease use of those frequencies under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
      "maxLocationChange": 3.14, # The maximum location change in meters is required in the initialization response, but optional otherwise. When the device changes location by more than this specified distance, it must contact the database to get the available spectrum for the new location. If the device is using spectrum that is no longer available, it must immediately cease use of the spectrum under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
      "authority": "A String", # The regulatory domain to which the ruleset belongs is required. It must be a 2-letter country code. The device should use this to determine additional device behavior required by the associated regulatory domain.
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        #
        # Required field.
  }
init(body) 
Initializes the connection between a white space device and the database.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The initialization request message allows the master device to initiate exchange of capabilities with the database.
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # The DeviceDescriptor parameter is required. If the database does not support the device or any of the rulesets specified in the device descriptor, it must return an UNSUPPORTED error code in the error response.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        # 
        # Required field.
    "location": { # This parameter is used to specify the geolocation of the device. # A device's geolocation is required.
      "confidence": 42, # The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
      "region": { # A region is represented using the polygonal shape. # If present, indicates that the geolocation represents a region. Database support for regions is optional.
        "exterior": [ # When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
            # - A connecting line shall not cross another connecting line of the same polygon.
            # - The vertices must be defined in a counterclockwise order.
            # - The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
            # - All vertices are assumed to be at the same altitude.
            # - Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
          { # A single geolocation on the globe.
            "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          },
        ],
      },
      "point": { # A "point" with uncertainty is represented using the Ellipse shape. # If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
        "semiMajorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "center": { # A single geolocation on the globe. # A required geo-spatial point representing the center of the ellipse.
          "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
        },
        "semiMinorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "orientation": 3.14, # A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
      },
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        # 
        # Required field.
  }


Returns:
  An object of the form:

    { # The initialization response message communicates database parameters to the requesting device.
    "databaseChange": { # This message is provided by the database to notify devices of an upcoming change to the database URI. # A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
      "databases": [ # A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
        { # This message contains the name and URI of a database.
          "name": "A String", # The display name for a database.
          "uri": "A String", # The corresponding URI of the database.
        },
      ],
    },
    "kind": "spectrum#pawsInitResponse", # Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsInitResponse".
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        #
        # Required field.
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        #
        # Required field.
    "rulesetInfo": { # This contains parameters for the ruleset of a regulatory domain that is communicated using the initialization and available-spectrum processes. # The rulesetInfo parameter must be included in the response. This parameter specifies the regulatory domain and parameters applicable to that domain. The database must include the authority field, which defines the regulatory domain for the location specified in the INIT_REQ message.
      "rulesetIds": [ # The identifiers of the rulesets supported for the device's location. The database should include at least one applicable ruleset in the initialization response. The device may use the ruleset identifiers to determine parameters to include in subsequent requests. Within the context of the available-spectrum responses, the database should include the identifier of the ruleset that it used to determine the available-spectrum response. If included, the device must use the specified ruleset to interpret the response. If the device does not support the indicated ruleset, it must not operate in the spectrum governed by the ruleset.
        "A String",
      ],
      "maxPollingSecs": 42, # The maximum duration, in seconds, between requests for available spectrum. It is required in the initialization response, but optional otherwise. The device must contact the database to get available spectrum no less frequently than this duration. If the new spectrum information indicates that the device is using spectrum that is no longer available, it must immediately cease use of those frequencies under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
      "maxLocationChange": 3.14, # The maximum location change in meters is required in the initialization response, but optional otherwise. When the device changes location by more than this specified distance, it must contact the database to get the available spectrum for the new location. If the device is using spectrum that is no longer available, it must immediately cease use of the spectrum under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
      "authority": "A String", # The regulatory domain to which the ruleset belongs is required. It must be a 2-letter country code. The device should use this to determine additional device behavior required by the associated regulatory domain.
    },
  }
notifySpectrumUse(body) 
Notifies the database that the device has selected certain frequency ranges for transmission. Only to be invoked when required by the regulator. The Google Spectrum Database does not operate in domains that require notification, so this always yields an UNIMPLEMENTED error.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The spectrum-use notification message which must contain the geolocation of the Device and parameters required by the regulatory domain.
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # Device descriptor information is required in the spectrum-use notification message.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        # 
        # Required field.
    "location": { # This parameter is used to specify the geolocation of the device. # The geolocation of the master device (the device that is sending the spectrum-use notification) to the database is required in the spectrum-use notification message.
      "confidence": 42, # The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
      "region": { # A region is represented using the polygonal shape. # If present, indicates that the geolocation represents a region. Database support for regions is optional.
        "exterior": [ # When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
            # - A connecting line shall not cross another connecting line of the same polygon.
            # - The vertices must be defined in a counterclockwise order.
            # - The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
            # - All vertices are assumed to be at the same altitude.
            # - Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
          { # A single geolocation on the globe.
            "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          },
        ],
      },
      "point": { # A "point" with uncertainty is represented using the Ellipse shape. # If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
        "semiMajorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "center": { # A single geolocation on the globe. # A required geo-spatial point representing the center of the ellipse.
          "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
        },
        "semiMinorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "orientation": 3.14, # A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
      },
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        # 
        # Required field.
    "spectra": [ # A spectrum list is required in the spectrum-use notification. The list specifies the spectrum that the device expects to use, which includes frequency ranges and maximum power levels. The list may be empty if the device decides not to use any of spectrum. For consistency, the psdBandwidthHz value should match that from one of the spectrum elements in the corresponding available spectrum response previously sent to the device by the database. Note that maximum power levels in the spectrum element must be expressed as power spectral density over the specified psdBandwidthHz value. The actual bandwidth to be used (as computed from the start and stop frequencies) may be different from the psdBandwidthHz value. As an example, when regulatory rules express maximum power spectral density in terms of maximum power over any 100 kHz band, then the psdBandwidthHz value should be set to 100 kHz, even though the actual bandwidth used can be 20 kHz.
      { # Available spectrum can be logically characterized by a list of frequency ranges and permissible power levels for each range.
        "bandwidth": 3.14, # The bandwidth (in Hertz) for which permissible power levels are specified. For example, FCC regulation would require only one spectrum specification at 6MHz bandwidth, but Ofcom regulation would require two specifications, at 0.1MHz and 8MHz. This parameter may be empty if there is no available spectrum. It will be present otherwise.
        "frequencyRanges": [ # The list of frequency ranges and permissible power levels. The list may be empty if there is no available spectrum, otherwise it will be present.
          { # A specific range of frequencies together with the associated maximum power level and channel identifier.
            "startHz": 3.14, # The required inclusive start of the frequency range (in Hertz).
            "channelId": "A String", # The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
            "stopHz": 3.14, # The required exclusive end of the frequency range (in Hertz).
            "maxPowerDBm": 3.14, # The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
          },
        ],
      },
    ],
  }


Returns:
  An object of the form:

    { # An empty response to the notification.
    "kind": "spectrum#pawsNotifySpectrumUseResponse", # Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsNotifySpectrumUseResponse".
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        #
        # Required field.
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        #
        # Required field.
  }
register(body) 
The Google Spectrum Database implements registration in the getSpectrum method. As such this always returns an UNIMPLEMENTED error.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The registration request message contains the required registration parameters.
    "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # A DeviceDescriptor is required.
      "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
          #
          # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
        "A String",
      ],
      "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
      "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
      "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
      "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
      "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
      "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
      "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
      "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
      "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
    },
    "antenna": { # Antenna characteristics provide additional information, such as the antenna height, antenna type, etc. Whether antenna characteristics must be provided in a request depends on the device type and regulatory domain. # Antenna characteristics, including its height and height type.
      "heightType": "A String", # If the height is required, then the height type (AGL for above ground level or AMSL for above mean sea level) is also required. The default is AGL.
      "heightUncertainty": 3.14, # The height uncertainty in meters. Whether this is required depends on the regulatory domain.
      "height": 3.14, # The antenna height in meters. Whether the antenna height is required depends on the device type and the regulatory domain. Note that the height may be negative.
    },
    "deviceOwner": { # This parameter contains device-owner information required as part of device registration. The regulatory domains may require additional parameters. # Device owner information is required.
        #
        # All contact information must be expressed using the structure defined by the vCard format specification. Only the contact fields of vCard are supported:
        # - fn: Full name of an individual
        # - org: Name of the organization
        # - adr: Address fields
        # - tel: Telephone numbers
        # - email: Email addresses
        #
        # Note that the vCard specification defines maximum lengths for each field.
      "operator": { # A vCard-in-JSON message that contains only the fields needed for PAWS: # The vCard contact information for the device operator is optional, but may be required by specific regulatory domains.
          # - fn: Full name of an individual
          # - org: Name of the organization
          # - adr: Address fields
          # - tel: Telephone numbers
          # - email: Email addresses
        "org": { # The structure used to represent an organization and an email address. # The organization associated with the registering entity.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "tel": { # The structure used to represent a telephone number. # A telephone number that can be used to call the contact.
          "uri": "A String", # A nested telephone URI of the form: tel:+1-123-456-7890.
        },
        "adr": { # The structure used to represent a street address. # The street address of the entity.
          "code": "A String", # The postal code associated with the address. For example: 94423.
          "locality": "A String", # The city or local equivalent portion of the address. For example: San Jose.
          "country": "A String", # The country name. For example: US.
          "region": "A String", # The state or local equivalent portion of the address. For example: CA.
          "pobox": "A String", # An optional post office box number.
          "street": "A String", # The street number and name. For example: 123 Any St.
        },
        "email": { # The structure used to represent an organization and an email address. # An email address that can be used to reach the contact.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "fn": "A String", # The full name of the contact person. For example: John A. Smith.
      },
      "owner": { # A vCard-in-JSON message that contains only the fields needed for PAWS: # The vCard contact information for the individual or business that owns the device is required.
          # - fn: Full name of an individual
          # - org: Name of the organization
          # - adr: Address fields
          # - tel: Telephone numbers
          # - email: Email addresses
        "org": { # The structure used to represent an organization and an email address. # The organization associated with the registering entity.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "tel": { # The structure used to represent a telephone number. # A telephone number that can be used to call the contact.
          "uri": "A String", # A nested telephone URI of the form: tel:+1-123-456-7890.
        },
        "adr": { # The structure used to represent a street address. # The street address of the entity.
          "code": "A String", # The postal code associated with the address. For example: 94423.
          "locality": "A String", # The city or local equivalent portion of the address. For example: San Jose.
          "country": "A String", # The country name. For example: US.
          "region": "A String", # The state or local equivalent portion of the address. For example: CA.
          "pobox": "A String", # An optional post office box number.
          "street": "A String", # The street number and name. For example: 123 Any St.
        },
        "email": { # The structure used to represent an organization and an email address. # An email address that can be used to reach the contact.
          "text": "A String", # The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
        },
        "fn": "A String", # The full name of the contact person. For example: John A. Smith.
      },
    },
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        # 
        # Required field.
    "location": { # This parameter is used to specify the geolocation of the device. # A device's geolocation is required.
      "confidence": 42, # The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
      "region": { # A region is represented using the polygonal shape. # If present, indicates that the geolocation represents a region. Database support for regions is optional.
        "exterior": [ # When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
            # - A connecting line shall not cross another connecting line of the same polygon.
            # - The vertices must be defined in a counterclockwise order.
            # - The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
            # - All vertices are assumed to be at the same altitude.
            # - Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
          { # A single geolocation on the globe.
            "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
            "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          },
        ],
      },
      "point": { # A "point" with uncertainty is represented using the Ellipse shape. # If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
        "semiMajorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "center": { # A single geolocation on the globe. # A required geo-spatial point representing the center of the ellipse.
          "latitude": 3.14, # A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
          "longitude": 3.14, # A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
        },
        "semiMinorAxis": 3.14, # A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
        "orientation": 3.14, # A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
      },
    },
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        # 
        # Required field.
  }


Returns:
  An object of the form:

    { # The registration response message simply acknowledges receipt of the request and is otherwise empty.
    "databaseChange": { # This message is provided by the database to notify devices of an upcoming change to the database URI. # A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
      "databases": [ # A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
        { # This message contains the name and URI of a database.
          "name": "A String", # The display name for a database.
          "uri": "A String", # The corresponding URI of the database.
        },
      ],
    },
    "kind": "spectrum#pawsRegisterResponse", # Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsRegisterResponse".
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        #
        # Required field.
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        #
        # Required field.
  }
verifyDevice(body) 
Validates a device for white space use in accordance with regulatory rules. The Google Spectrum Database does not support master/slave configurations, so this always yields an UNIMPLEMENTED error.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # The device validation request message.
    "deviceDescs": [ # A list of device descriptors, which specifies the slave devices to be validated, is required.
      { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains.
        "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
            #
            # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
          "A String",
        ],
        "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
        "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
        "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
        "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
        "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
        "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
        "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
        "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
        "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
      },
    ],
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        # 
        # Required field.
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        # 
        # Required field.
  }


Returns:
  An object of the form:

    { # The device validation response message.
    "databaseChange": { # This message is provided by the database to notify devices of an upcoming change to the database URI. # A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
      "databases": [ # A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
        { # This message contains the name and URI of a database.
          "name": "A String", # The display name for a database.
          "uri": "A String", # The corresponding URI of the database.
        },
      ],
    },
    "kind": "spectrum#pawsVerifyDeviceResponse", # Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsVerifyDeviceResponse".
    "version": "A String", # The PAWS version. Must be exactly 1.0.
        #
        # Required field.
    "deviceValidities": [ # A device validities list is required in the device validation response to report whether each slave device listed in a previous device validation request is valid. The number of entries must match the number of device descriptors listed in the previous device validation request.
      { # The device validity element describes whether a particular device is valid to operate in the regulatory domain.
        "isValid": True or False, # The validity status: true if the device is valid for operation, false otherwise. It will always be present.
        "reason": "A String", # If the device identifier is not valid, the database may include a reason. The reason may be in any language. The length of the value should not exceed 128 characters.
        "deviceDesc": { # The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. # The descriptor of the device for which the validity check was requested. It will always be present.
          "rulesetIds": [ # The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.
              #
              # For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
            "A String",
          ],
          "etsiEnDeviceType": "A String", # Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
          "fccId": "A String", # Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
          "serialNumber": "A String", # The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
          "etsiEnTechnologyId": "A String", # Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
          "fccTvbdDeviceType": "A String", # Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
          "etsiEnDeviceCategory": "A String", # Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
          "etsiEnDeviceEmissionsClass": "A String", # Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
          "manufacturerId": "A String", # The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
          "modelId": "A String", # The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
        },
      },
    ],
    "type": "A String", # The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
        #
        # Required field.
  }
google-api-python-client-1.5.5/docs/dyn/speech_v1beta1.html000066400000000000000000000043711300622755700235560ustar00rootroot00000000000000

Google Cloud Speech API

Instance Methods

operations()

Returns the operations Resource.

speech()

Returns the speech Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/speech_v1beta1.operations.html000066400000000000000000000422451300622755700257420ustar00rootroot00000000000000

Google Cloud Speech API . operations

Instance Methods

cancel(name, body, x__xgafv=None)

Starts asynchronous cancellation on a long-running operation. The server

delete(name, x__xgafv=None)

Deletes a long-running operation. This method indicates that the client is

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this

list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

cancel(name, body, x__xgafv=None) 
Starts asynchronous cancellation on a long-running operation.  The server
makes a best effort to cancel the operation, but success is not
guaranteed.  If the server doesn't support this method, it returns
`google.rpc.Code.UNIMPLEMENTED`.  Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to `Code.CANCELLED`.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The request message for Operations.CancelOperation.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
`google.rpc.Code.UNIMPLEMENTED`.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation.  Clients can use this
method to poll the operation result at intervals as recommended by the API
service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding below allows API services to override the binding
to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The name of the operation collection.
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Operations.ListOperations.
    "nextPageToken": "A String", # The standard List next-page token.
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If true, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should have the format of `operations/some/unique/name`.
        "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/speech_v1beta1.speech.html000066400000000000000000000405521300622755700250250ustar00rootroot00000000000000

Google Cloud Speech API . speech

Instance Methods

asyncrecognize(body, x__xgafv=None)

Perform asynchronous speech-recognition: receive results via the

syncrecognize(body, x__xgafv=None)

Perform synchronous speech-recognition: receive results after all audio

Method Details

asyncrecognize(body, x__xgafv=None) 
Perform asynchronous speech-recognition: receive results via the
google.longrunning.Operations interface. Returns either an
`Operation.error` or an `Operation.response` which contains
an `AsyncRecognizeResponse` message.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # `AsyncRecognizeRequest` is the top-level message sent by the client for
      # the `AsyncRecognize` method.
    "audio": { # Contains audio data in the encoding specified in the `RecognitionConfig`. # [Required] The audio data to be recognized.
        # Either `content` or `uri` must be supplied. Supplying both or neither
        # returns google.rpc.Code.INVALID_ARGUMENT. See
        # [audio limits](https://cloud.google.com/speech/limits#content).
      "content": "A String", # The audio data bytes encoded as specified in
          # `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a
          # pure binary representation, whereas JSON representations use base64.
      "uri": "A String", # URI that points to a file that contains audio data bytes as specified in
          # `RecognitionConfig`. Currently, only Google Cloud Storage URIs are
          # supported, which must be specified in the following format:
          # `gs://bucket_name/object_name` (other URI formats return
          # google.rpc.Code.INVALID_ARGUMENT). For more information, see
          # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
    },
    "config": { # The `RecognitionConfig` message provides information to the recognizer # [Required] The `config` message provides information to the recognizer
        # that specifies how to process the request.
        # that specifies how to process the request.
      "languageCode": "A String", # [Optional] The language of the supplied audio as a BCP-47 language tag.
          # Example: "en-GB"  https://www.rfc-editor.org/rfc/bcp/bcp47.txt
          # If omitted, defaults to "en-US". See
          # [Language Support](https://cloud.google.com/speech/docs/languages)
          # for a list of the currently supported language codes.
      "speechContext": { # Provides "hints" to the speech recognizer to favor specific words and phrases # [Optional] A means to provide context to assist the speech recognition.
          # in the results.
        "phrases": [ # [Optional] A list of strings containing words and phrases "hints" so that
            # the speech recognition is more likely to recognize them. This can be used
            # to improve the accuracy for specific words and phrases, for example, if
            # specific commands are typically spoken by the user. This can also be used
            # to add additional words to the vocabulary of the recognizer. See
            # [usage limits](https://cloud.google.com/speech/limits#content).
          "A String",
        ],
      },
      "encoding": "A String", # [Required] Encoding of audio data sent in all `RecognitionAudio` messages.
      "maxAlternatives": 42, # [Optional] Maximum number of recognition hypotheses to be returned.
          # Specifically, the maximum number of `SpeechRecognitionAlternative` messages
          # within each `SpeechRecognitionResult`.
          # The server may return fewer than `max_alternatives`.
          # Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
          # `1`. If omitted, defaults to `1`.
      "profanityFilter": True or False, # [Optional] If set to `true`, the server will attempt to filter out
          # profanities, replacing all but the initial character in each filtered word
          # with asterisks, e.g. "f***". If set to `false` or omitted, profanities
          # won't be filtered out.
      "sampleRate": 42, # [Required] Sample rate in Hertz of the audio data sent in all
          # `RecognitionAudio` messages. Valid values are: 8000-48000.
          # 16000 is optimal. For best results, set the sampling rate of the audio
          # source to 16000 Hz. If that's not possible, use the native sample rate of
          # the audio source (instead of re-sampling).
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If true, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should have the format of `operations/some/unique/name`.
    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
        # programming environments, including REST APIs and RPC APIs. It is used by
        # [gRPC](https://github.com/grpc). The error model is designed to be:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` which can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting purpose.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }
syncrecognize(body, x__xgafv=None) 
Perform synchronous speech-recognition: receive results after all audio
has been sent and processed.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # `SyncRecognizeRequest` is the top-level message sent by the client for
      # the `SyncRecognize` method.
    "audio": { # Contains audio data in the encoding specified in the `RecognitionConfig`. # [Required] The audio data to be recognized.
        # Either `content` or `uri` must be supplied. Supplying both or neither
        # returns google.rpc.Code.INVALID_ARGUMENT. See
        # [audio limits](https://cloud.google.com/speech/limits#content).
      "content": "A String", # The audio data bytes encoded as specified in
          # `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a
          # pure binary representation, whereas JSON representations use base64.
      "uri": "A String", # URI that points to a file that contains audio data bytes as specified in
          # `RecognitionConfig`. Currently, only Google Cloud Storage URIs are
          # supported, which must be specified in the following format:
          # `gs://bucket_name/object_name` (other URI formats return
          # google.rpc.Code.INVALID_ARGUMENT). For more information, see
          # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
    },
    "config": { # The `RecognitionConfig` message provides information to the recognizer # [Required] The `config` message provides information to the recognizer
        # that specifies how to process the request.
        # that specifies how to process the request.
      "languageCode": "A String", # [Optional] The language of the supplied audio as a BCP-47 language tag.
          # Example: "en-GB"  https://www.rfc-editor.org/rfc/bcp/bcp47.txt
          # If omitted, defaults to "en-US". See
          # [Language Support](https://cloud.google.com/speech/docs/languages)
          # for a list of the currently supported language codes.
      "speechContext": { # Provides "hints" to the speech recognizer to favor specific words and phrases # [Optional] A means to provide context to assist the speech recognition.
          # in the results.
        "phrases": [ # [Optional] A list of strings containing words and phrases "hints" so that
            # the speech recognition is more likely to recognize them. This can be used
            # to improve the accuracy for specific words and phrases, for example, if
            # specific commands are typically spoken by the user. This can also be used
            # to add additional words to the vocabulary of the recognizer. See
            # [usage limits](https://cloud.google.com/speech/limits#content).
          "A String",
        ],
      },
      "encoding": "A String", # [Required] Encoding of audio data sent in all `RecognitionAudio` messages.
      "maxAlternatives": 42, # [Optional] Maximum number of recognition hypotheses to be returned.
          # Specifically, the maximum number of `SpeechRecognitionAlternative` messages
          # within each `SpeechRecognitionResult`.
          # The server may return fewer than `max_alternatives`.
          # Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
          # `1`. If omitted, defaults to `1`.
      "profanityFilter": True or False, # [Optional] If set to `true`, the server will attempt to filter out
          # profanities, replacing all but the initial character in each filtered word
          # with asterisks, e.g. "f***". If set to `false` or omitted, profanities
          # won't be filtered out.
      "sampleRate": 42, # [Required] Sample rate in Hertz of the audio data sent in all
          # `RecognitionAudio` messages. Valid values are: 8000-48000.
          # 16000 is optimal. For best results, set the sampling rate of the audio
          # source to 16000 Hz. If that's not possible, use the native sample rate of
          # the audio source (instead of re-sampling).
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `SyncRecognizeResponse` is the only message returned to the client by
      # `SyncRecognize`. It contains the result as zero or more sequential
      # `SpeechRecognitionResult` messages.
    "results": [ # [Output-only] Sequential list of transcription results corresponding to
        # sequential portions of audio.
      { # A speech recognition result corresponding to a portion of the audio.
        "alternatives": [ # [Output-only] May contain one or more recognition hypotheses (up to the
            # maximum specified in `max_alternatives`).
          { # Alternative hypotheses (a.k.a. n-best list).
            "confidence": 3.14, # [Output-only] The confidence estimate between 0.0 and 1.0. A higher number
                # means the system is more confident that the recognition is correct.
                # This field is typically provided only for the top hypothesis, and only for
                # `is_final=true` results.
                # The default of 0.0 is a sentinel value indicating confidence was not set.
            "transcript": "A String", # [Output-only] Transcript text representing the words that the user spoke.
          },
        ],
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.backupRuns.html000066400000000000000000000146731300622755700262430ustar00rootroot00000000000000

Cloud SQL Administration API . backupRuns

Instance Methods

get(project, instance, backupConfiguration, dueTime)

Retrieves information about a specified backup run for a Cloud SQL instance.

list(project, instance, backupConfiguration, maxResults=None, pageToken=None)

Lists all backup runs associated with a Cloud SQL instance.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, instance, backupConfiguration, dueTime) 
Retrieves information about a specified backup run for a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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 start time of the four-hour backup window. The backup can occur any time in the window. The time is 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 Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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.
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.flags.html000066400000000000000000000047111300622755700252120ustar00rootroot00000000000000

Cloud SQL Administration API . flags

Instance Methods

list()

Lists all database flags that can be set for Google Cloud SQL instances.

Method Details

list() 
Lists all database flags that can be set for Google Cloud SQL instances.

Args:

Returns:
  An object of the form:

    { # Flags list response.
    "items": [ # List of flags.
      { # A Google Cloud SQL service flag resource.
        "kind": "sql#flag", # This is always sql#flag.
        "name": "A String", # This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet
        "allowedStringValues": [ # For STRING flags, a list of strings that the value can be set to.
          "A String",
        ],
        "appliesTo": [ # The database version this flag applies to. Currently this can only be [MYSQL_5_5].
          "A String",
        ],
        "maxValue": "A String", # For INTEGER flags, the maximum allowed value.
        "minValue": "A String", # For INTEGER flags, the minimum allowed value.
        "type": "A String", # The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables.
      },
    ],
    "kind": "sql#flagsList", # This is always sql#flagsList.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.html000066400000000000000000000055651300622755700241270ustar00rootroot00000000000000

Cloud SQL Administration API

Instance Methods

backupRuns()

Returns the backupRuns Resource.

flags()

Returns the flags Resource.

instances()

Returns the instances Resource.

operations()

Returns the operations Resource.

sslCerts()

Returns the sslCerts Resource.

tiers()

Returns the tiers Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.instances.html000066400000000000000000001573541300622755700261210ustar00rootroot00000000000000

Cloud SQL Administration API . instances

Instance Methods

clone(project, body)

Creates a Cloud SQL instance as a clone of a source instance.

delete(project, instance)

Deletes a Cloud SQL instance.

export(project, instance, body)

Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.

get(project, instance)

Retrieves information about a Cloud SQL instance.

import_(project, instance, body)

Imports data into a Cloud SQL instance from a MySQL dump file stored in a Google Cloud Storage bucket.

insert(project, body)

Creates a new Cloud SQL instance.

list(project, pageToken=None, maxResults=None)

Lists instances for a given project, in alphabetical order by instance name.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, instance, body)

Updates the settings of a Cloud SQL instance. This method supports patch semantics.

promoteReplica(project, instance)

Promotes the read replica instance to be a stand-alone Cloud SQL instance.

resetSslConfig(project, instance)

Deletes all client certificates and generates a new server SSL certificate for a Cloud SQL instance.

restart(project, instance)

Restarts a Cloud SQL instance.

restoreBackup(project, instance, backupConfiguration, dueTime)

Restores a backup of a Cloud SQL instance.

setRootPassword(project, instance, body)

Sets the password for the root user of the specified Cloud SQL instance.

update(project, instance, body)

Updates the settings of a Cloud SQL instance.

Method Details

clone(project, body) 
Creates a Cloud SQL instance as a clone of a source instance.

Args:
  project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Database instance clone request.
    "cloneContext": { # Database instance clone context. # Contains details about the clone operation.
      "sourceInstanceName": "A String", # Name of the Cloud SQL instance to be cloned.
      "binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, indentify the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
        "binLogPosition": "A String", # Position (offset) within the binary log file.
        "kind": "sql#binLogCoordinates", # This is always sql#binLogCoordinates.
        "binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
      },
      "kind": "sql#cloneContext", # This is always sql#cloneContext.
      "destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
    },
  }


Returns:
  An object of the form:

    { # Database instance clone response.
    "kind": "sql#instancesClone", # This is always sql#instancesClone.
    "operation": "A String", # An unique identifier for the operation associated with the cloned instance. You can use this identifier to retrieve the Operations resource, which has information about the operation.
  }
delete(project, instance) 
Deletes a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance to be deleted. (required)
  instance: string, Cloud SQL 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 Cloud SQL 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. (required)
  instance: string, Cloud SQL 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 information about a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # A Cloud SQL instance resource.
      "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
      "kind": "sql#instance", # This is always sql#instance.
      "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
      "ipv6Address": "A String", # The IPv6 address assigned to the instance.
      "serverCaCert": { # SslCerts Resource # SSL configuration.
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "kind": "sql#sslCert", # This is always sql#sslCert.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "instance": "A String", # Name of the database instance.
        "cert": "A String", # PEM representation.
        "expirationTime": "A String", # Time when the certificate expires.
        "createTime": "A String", # Time when the certificate was created.
      },
      "replicaNames": [ # The replicas of the instance.
        "A String",
      ],
      "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
      "settings": { # Database instance settings. # The user settings.
        "databaseFlags": [ # The database flags passed to the instance at startup.
          { # MySQL flags for Cloud SQL instances.
            "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
            "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
          },
        ],
        "kind": "sql#settings", # This is always sql#settings.
        "authorizedGaeApplications": [ # The App Engine 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.
            "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
            "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.
            "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
          },
        ],
        "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
          "enabled": True or False, # Whether the instance should be assigned an IP address or not.
          "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
          "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
          "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
            "A String",
          ],
        },
        "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
        "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.
        "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
        "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
        "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
          "kind": "sql#locationPreference", # This is always sql#locationPreference.
          "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
          "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
        },
      },
      "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
      "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
      "instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
      "state": "A String", # The current serving state of the Cloud SQL 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", # HTTP 1.1 Entity tag for the resource.
      "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
      "ipAddresses": [ # The assigned IP addresses for the instance.
        { # Database instance IP Mapping.
          "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
          "ipAddress": "A String", # The IP address assigned.
        },
      ],
      "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
      "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
      "instanceType": "A String", # The instance type. This can be one of the following.
          # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
          # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
    }
import_(project, instance, body) 
Imports data into a Cloud SQL instance from a MySQL dump file stored in a Google Cloud Storage bucket.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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 Cloud SQL instance.

Args:
  project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL instance resource.
    "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    "kind": "sql#instance", # This is always sql#instance.
    "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
    "ipv6Address": "A String", # The IPv6 address assigned to the instance.
    "serverCaCert": { # SslCerts Resource # SSL configuration.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # Time when the certificate expires.
      "createTime": "A String", # Time when the certificate was created.
    },
    "replicaNames": [ # The replicas of the instance.
      "A String",
    ],
    "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
    "settings": { # Database instance settings. # The user settings.
      "databaseFlags": [ # The database flags passed to the instance at startup.
        { # MySQL flags for Cloud SQL instances.
          "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
          "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
        },
      ],
      "kind": "sql#settings", # This is always sql#settings.
      "authorizedGaeApplications": [ # The App Engine 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.
          "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
          "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.
          "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
        },
      ],
      "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
        "enabled": True or False, # Whether the instance should be assigned an IP address or not.
        "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
        "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
        "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
          "A String",
        ],
      },
      "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
      "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.
      "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
      "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
      "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
        "kind": "sql#locationPreference", # This is always sql#locationPreference.
        "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
        "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
      },
    },
    "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
    "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
    "instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
    "state": "A String", # The current serving state of the Cloud SQL 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", # HTTP 1.1 Entity tag for the resource.
    "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
    "ipAddresses": [ # The assigned IP addresses for the instance.
      { # Database instance IP Mapping.
        "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
        "ipAddress": "A String", # The IP address assigned.
      },
    ],
    "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
    "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
    "instanceType": "A String", # The instance type. This can be one of the following.
        # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
        # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
  }


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 for a given project, in alphabetical order by instance name.

Args:
  project: string, Project ID of the project for which to list Cloud SQL instances. (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 Cloud SQL instance resource.
          "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
          "kind": "sql#instance", # This is always sql#instance.
          "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
          "ipv6Address": "A String", # The IPv6 address assigned to the instance.
          "serverCaCert": { # SslCerts Resource # SSL configuration.
            "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
            "kind": "sql#sslCert", # This is always sql#sslCert.
            "sha1Fingerprint": "A String", # Sha1 Fingerprint.
            "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
            "instance": "A String", # Name of the database instance.
            "cert": "A String", # PEM representation.
            "expirationTime": "A String", # Time when the certificate expires.
            "createTime": "A String", # Time when the certificate was created.
          },
          "replicaNames": [ # The replicas of the instance.
            "A String",
          ],
          "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
          "settings": { # Database instance settings. # The user settings.
            "databaseFlags": [ # The database flags passed to the instance at startup.
              { # MySQL flags for Cloud SQL instances.
                "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
                "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
              },
            ],
            "kind": "sql#settings", # This is always sql#settings.
            "authorizedGaeApplications": [ # The App Engine 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.
                "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
                "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.
                "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
              },
            ],
            "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
              "enabled": True or False, # Whether the instance should be assigned an IP address or not.
              "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
              "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
              "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
                "A String",
              ],
            },
            "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
            "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.
            "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
            "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
            "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
              "kind": "sql#locationPreference", # This is always sql#locationPreference.
              "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
              "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
            },
          },
          "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
          "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
          "instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
          "state": "A String", # The current serving state of the Cloud SQL 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", # HTTP 1.1 Entity tag for the resource.
          "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
          "ipAddresses": [ # The assigned IP addresses for the instance.
            { # Database instance IP Mapping.
              "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
              "ipAddress": "A String", # The IP address assigned.
            },
          ],
          "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
          "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
          "instanceType": "A String", # The instance type. This can be one of the following.
              # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
              # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
        },
    ],
    "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 the settings of a Cloud SQL instance. This method supports patch semantics.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL instance resource.
    "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    "kind": "sql#instance", # This is always sql#instance.
    "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
    "ipv6Address": "A String", # The IPv6 address assigned to the instance.
    "serverCaCert": { # SslCerts Resource # SSL configuration.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # Time when the certificate expires.
      "createTime": "A String", # Time when the certificate was created.
    },
    "replicaNames": [ # The replicas of the instance.
      "A String",
    ],
    "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
    "settings": { # Database instance settings. # The user settings.
      "databaseFlags": [ # The database flags passed to the instance at startup.
        { # MySQL flags for Cloud SQL instances.
          "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
          "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
        },
      ],
      "kind": "sql#settings", # This is always sql#settings.
      "authorizedGaeApplications": [ # The App Engine 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.
          "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
          "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.
          "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
        },
      ],
      "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
        "enabled": True or False, # Whether the instance should be assigned an IP address or not.
        "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
        "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
        "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
          "A String",
        ],
      },
      "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
      "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.
      "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
      "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
      "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
        "kind": "sql#locationPreference", # This is always sql#locationPreference.
        "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
        "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
      },
    },
    "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
    "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
    "instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
    "state": "A String", # The current serving state of the Cloud SQL 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", # HTTP 1.1 Entity tag for the resource.
    "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
    "ipAddresses": [ # The assigned IP addresses for the instance.
      { # Database instance IP Mapping.
        "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
        "ipAddress": "A String", # The IP address assigned.
      },
    ],
    "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
    "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
    "instanceType": "A String", # The instance type. This can be one of the following.
        # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
        # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
  }


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.
  }
promoteReplica(project, instance) 
Promotes the read replica instance to be a stand-alone Cloud SQL instance.

Args:
  project: string, ID of the project that contains the read replica. (required)
  instance: string, Cloud SQL read replica instance name. (required)

Returns:
  An object of the form:

    { # Database promote read replica response.
    "kind": "sql#instancesPromoteReplica", # This is always sql#instancesPromoteReplica.
    "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.
  }
resetSslConfig(project, instance) 
Deletes all client certificates and generates a new server SSL certificate for a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # Database instance resetSslConfig response.
    "kind": "sql#instancesResetSslConfig", # This is always sql#instancesResetSslConfig.
    "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. All ssl client certificates will be deleted and a new server certificate will be created. Does not take effect until the next instance restart.
  }
restart(project, instance) 
Restarts a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance to be restarted. (required)
  instance: string, Cloud SQL 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 Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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 start time of the four-hour backup window. The backup can occur any time in the window. The time is 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.
  }
setRootPassword(project, instance, body) 
Sets the password for the root user of the specified Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Database instance set root password request.
    "setRootPasswordContext": { # Database instance set root password context. # Set Root Password Context.
      "kind": "sql#setRootUserContext", # This is always sql#setRootUserContext.
      "password": "A String", # The password for the root user.
    },
  }


Returns:
  An object of the form:

    { # Database instance set root password response.
    "kind": "sql#instancesSetRootPassword", # This is always sql#instancesSetRootPassword.
    "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 the settings of a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL instance resource.
    "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    "kind": "sql#instance", # This is always sql#instance.
    "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
    "ipv6Address": "A String", # The IPv6 address assigned to the instance.
    "serverCaCert": { # SslCerts Resource # SSL configuration.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # Time when the certificate expires.
      "createTime": "A String", # Time when the certificate was created.
    },
    "replicaNames": [ # The replicas of the instance.
      "A String",
    ],
    "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
    "settings": { # Database instance settings. # The user settings.
      "databaseFlags": [ # The database flags passed to the instance at startup.
        { # MySQL flags for Cloud SQL instances.
          "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
          "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
        },
      ],
      "kind": "sql#settings", # This is always sql#settings.
      "authorizedGaeApplications": [ # The App Engine 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.
          "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
          "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.
          "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
        },
      ],
      "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
        "enabled": True or False, # Whether the instance should be assigned an IP address or not.
        "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
        "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
        "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
          "A String",
        ],
      },
      "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
      "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.
      "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
      "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
      "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
        "kind": "sql#locationPreference", # This is always sql#locationPreference.
        "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
        "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
      },
    },
    "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
    "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
    "instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
    "state": "A String", # The current serving state of the Cloud SQL 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", # HTTP 1.1 Entity tag for the resource.
    "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
    "ipAddresses": [ # The assigned IP addresses for the instance.
      { # Database instance IP Mapping.
        "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
        "ipAddress": "A String", # The IP address assigned.
      },
    ],
    "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
    "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
    "instanceType": "A String", # The instance type. This can be one of the following.
        # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
        # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
  }


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.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.operations.html000066400000000000000000000234241300622755700263030ustar00rootroot00000000000000

Cloud SQL Administration API . operations

Instance Methods

get(project, instance, operation)

Retrieves information about a specific operation that was performed on a Cloud SQL instance.

list(project, instance, maxResults=None, pageToken=None)

Lists all operations that have been performed on a Cloud SQL instance.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, instance, operation) 
Retrieves information about a specific operation that was performed on a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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 operations that have been performed on a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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.
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.sslCerts.html000066400000000000000000000165771300622755700257350ustar00rootroot00000000000000

Cloud SQL Administration API . sslCerts

Instance Methods

delete(project, instance, sha1Fingerprint)

Deletes an SSL certificate from a Cloud SQL instance.

get(project, instance, sha1Fingerprint)

Retrieves an SSL certificate as specified by its SHA-1 fingerprint.

insert(project, instance, body)

Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.

list(project, instance)

Lists all of the current SSL certificates defined for a Cloud SQL instance.

Method Details

delete(project, instance, sha1Fingerprint) 
Deletes an SSL certificate from a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance to be deleted. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  sha1Fingerprint: string, Sha1 FingerPrint. (required)

Returns:
  An object of the form:

    { # SslCert delete response.
    "kind": "sql#sslCertsDelete", # This is always sql#sslCertsDelete.
    "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, sha1Fingerprint) 
Retrieves an SSL certificate as specified by its SHA-1 fingerprint.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  sha1Fingerprint: string, Sha1 FingerPrint. (required)

Returns:
  An object of the form:

    { # SslCerts Resource
    "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
    "kind": "sql#sslCert", # This is always sql#sslCert.
    "sha1Fingerprint": "A String", # Sha1 Fingerprint.
    "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
    "instance": "A String", # Name of the database instance.
    "cert": "A String", # PEM representation.
    "expirationTime": "A String", # Time when the certificate expires.
    "createTime": "A String", # Time when the certificate was created.
  }
insert(project, instance, body) 
Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.

Args:
  project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # SslCerts insert request.
    "commonName": "A String", # User supplied name. Must be a distinct name from the other certificates for this instance. New certificates will not be usable until the instance is restarted.
  }


Returns:
  An object of the form:

    { # SslCert insert response.
    "kind": "sql#sslCertsInsert", # This is always sql#sslCertsInsert.
    "clientCert": { # SslCertDetail. # The new client certificate and private key. The new certificate will not work until the instance is restarted.
      "certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.
      "certInfo": { # SslCerts Resource # The public information about the cert.
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "kind": "sql#sslCert", # This is always sql#sslCert.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "instance": "A String", # Name of the database instance.
        "cert": "A String", # PEM representation.
        "expirationTime": "A String", # Time when the certificate expires.
        "createTime": "A String", # Time when the certificate was created.
      },
    },
    "serverCaCert": { # SslCerts Resource # The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource..
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # Time when the certificate expires.
      "createTime": "A String", # Time when the certificate was created.
    },
  }
list(project, instance) 
Lists all of the current SSL certificates defined for a Cloud SQL instance.

Args:
  project: string, Project ID of the project for which to list Cloud SQL instances. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # SslCerts list response.
    "items": [ # List of client certificates for the instance.
      { # SslCerts Resource
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "kind": "sql#sslCert", # This is always sql#sslCert.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "instance": "A String", # Name of the database instance.
        "cert": "A String", # PEM representation.
        "expirationTime": "A String", # Time when the certificate expires.
        "createTime": "A String", # Time when the certificate was created.
      },
    ],
    "kind": "sql#sslCertsList", # This is always sql#sslCertsList.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta3.tiers.html000066400000000000000000000043361300622755700252470ustar00rootroot00000000000000

Cloud SQL Administration API . tiers

Instance Methods

list(project)

Lists service tiers that can be used to create Google Cloud SQL instances.

Method Details

list(project) 
Lists service tiers that can be used to create Google Cloud SQL instances.

Args:
  project: string, Project ID of the project for which to list tiers. (required)

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, europe-west1, or asia-east1.
          "A String",
        ],
      },
    ],
    "kind": "sql#tiersList", # This is always sql#tiersList.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.backupRuns.html000066400000000000000000000467731300622755700262520ustar00rootroot00000000000000

Cloud SQL Administration API . backupRuns

Instance Methods

delete(project, instance, id)

Deletes the backup taken by a backup run.

get(project, instance, id)

Retrieves a resource containing information about a backup run.

insert(project, instance, body)

Creates a new backup run on demand. This method is applicable only to Second Generation instances.

list(project, instance, 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

delete(project, instance, id) 
Deletes the backup taken by a backup run.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
get(project, instance, id) 
Retrieves a resource containing information about a backup run.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  id: string, The ID of this Backup Run. (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.
      "description": "A String", # The description of this run, only applicable to on-demand backups.
      "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted 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.
      "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.
        "message": "A String", # Additional information about the error encountered.
      },
      "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
      "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
      "selfLink": "A String", # The URI of this resource.
    }
insert(project, instance, body) 
Creates a new backup run on demand. This method is applicable only to Second Generation instances.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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 backup run resource.
    "status": "A String", # The status of this run.
    "kind": "sql#backupRun", # This is always sql#backupRun.
    "description": "A String", # The description of this run, only applicable to on-demand backups.
    "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted 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.
    "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.
      "message": "A String", # Additional information about the error encountered.
    },
    "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
    "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
list(project, instance, 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. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (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.
          "description": "A String", # The description of this run, only applicable to on-demand backups.
          "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted 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.
          "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.
            "message": "A String", # Additional information about the error encountered.
          },
          "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
          "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
          "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
          "selfLink": "A String", # The URI of this resource.
        },
    ],
    "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.
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.databases.html000066400000000000000000000705171300622755700260550ustar00rootroot00000000000000

Cloud SQL Administration API . databases

Instance Methods

delete(project, instance, database)

Deletes a database from a Cloud SQL instance.

get(project, instance, database)

Retrieves a resource containing information about a database inside a Cloud SQL instance.

insert(project, instance, body)

Inserts a resource containing information about a database inside a Cloud SQL instance.

list(project, instance)

Lists databases in the specified Cloud SQL instance.

patch(project, instance, database, body)

Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

update(project, instance, database, body)

Updates a resource containing information about a database inside a Cloud SQL instance.

Method Details

delete(project, instance, database) 
Deletes a database from a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)
  database: string, Name of the database to be deleted in the instance. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
get(project, instance, database) 
Retrieves a resource containing information about a database inside a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)
  database: string, Name of the database in the instance. (required)

Returns:
  An object of the form:

    { # A database resource inside a Cloud SQL instance.
      "kind": "sql#database", # This is always sql#database.
      "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
      "charset": "A String", # The MySQL charset value.
      "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
      "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
      "etag": "A String", # HTTP 1.1 Entity tag for the resource.
      "collation": "A String", # The MySQL collation value.
      "selfLink": "A String", # The URI of this resource.
    }
insert(project, instance, body) 
Inserts a resource containing information about a database inside a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (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 resource inside a Cloud SQL instance.
    "kind": "sql#database", # This is always sql#database.
    "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
    "charset": "A String", # The MySQL charset value.
    "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
    "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "collation": "A String", # The MySQL collation value.
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
list(project, instance) 
Lists databases in the specified Cloud SQL instance.

Args:
  project: string, Project ID of the project for which to list Cloud SQL instances. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # Database list response.
    "items": [ # List of database resources in the instance.
      { # A database resource inside a Cloud SQL instance.
          "kind": "sql#database", # This is always sql#database.
          "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
          "charset": "A String", # The MySQL charset value.
          "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
          "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
          "etag": "A String", # HTTP 1.1 Entity tag for the resource.
          "collation": "A String", # The MySQL collation value.
          "selfLink": "A String", # The URI of this resource.
        },
    ],
    "kind": "sql#databasesList", # This is always sql#databasesList.
  }
patch(project, instance, database, body) 
Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)
  database: string, Name of the database to be updated in the instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A database resource inside a Cloud SQL instance.
    "kind": "sql#database", # This is always sql#database.
    "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
    "charset": "A String", # The MySQL charset value.
    "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
    "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "collation": "A String", # The MySQL collation value.
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
update(project, instance, database, body) 
Updates a resource containing information about a database inside a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)
  database: string, Name of the database to be updated in the instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A database resource inside a Cloud SQL instance.
    "kind": "sql#database", # This is always sql#database.
    "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
    "charset": "A String", # The MySQL charset value.
    "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
    "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "collation": "A String", # The MySQL collation value.
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.flags.html000066400000000000000000000052351300622755700252150ustar00rootroot00000000000000

Cloud SQL Administration API . flags

Instance Methods

list()

List all available database flags for Google Cloud SQL instances.

Method Details

list() 
List all available database flags for Google Cloud SQL instances.

Args:

Returns:
  An object of the form:

    { # Flags list response.
    "items": [ # List of flags.
      { # A Google Cloud SQL service flag resource.
        "kind": "sql#flag", # This is always sql#flag.
        "name": "A String", # This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet
        "allowedStringValues": [ # For STRING flags, a list of strings that the value can be set to.
          "A String",
        ],
        "requiresRestart": True or False, # Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
        "appliesTo": [ # The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances.
          "A String",
        ],
        "maxValue": "A String", # For INTEGER flags, the maximum allowed value.
        "minValue": "A String", # For INTEGER flags, the minimum allowed value.
        "type": "A String", # The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables.
      },
    ],
    "kind": "sql#flagsList", # This is always sql#flagsList.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.html000066400000000000000000000062511300622755700241210ustar00rootroot00000000000000

Cloud SQL Administration API

Instance Methods

backupRuns()

Returns the backupRuns Resource.

databases()

Returns the databases Resource.

flags()

Returns the flags Resource.

instances()

Returns the instances Resource.

operations()

Returns the operations Resource.

sslCerts()

Returns the sslCerts Resource.

tiers()

Returns the tiers Resource.

users()

Returns the users Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.instances.html000066400000000000000000004721721300622755700261200ustar00rootroot00000000000000

Cloud SQL Administration API . instances

Instance Methods

clone(project, instance, body)

Creates a Cloud SQL instance as a clone of the source instance. The API is not ready for Second Generation instances yet.

delete(project, instance)

Deletes a Cloud SQL instance.

export(project, instance, body)

Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.

failover(project, instance, body)

Failover the instance to its failover replica instance.

get(project, instance)

Retrieves a resource containing information about a Cloud SQL instance.

import_(project, instance, body)

Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.

insert(project, body)

Creates a new Cloud SQL 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 Cloud SQL 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.

promoteReplica(project, instance)

Promotes the read replica instance to be a stand-alone Cloud SQL instance.

resetSslConfig(project, instance)

Deletes all client certificates and generates a new server SSL certificate for the instance. The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate.

restart(project, instance)

Restarts a Cloud SQL instance.

restoreBackup(project, instance, body)

Restores a backup of a Cloud SQL instance.

startReplica(project, instance)

Starts the replication in the read replica instance.

stopReplica(project, instance)

Stops the replication in the read replica instance.

update(project, instance, body)

Updates settings of a Cloud SQL 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

clone(project, instance, body) 
Creates a Cloud SQL instance as a clone of the source instance. The API is not ready for Second Generation instances yet.

Args:
  project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
  instance: string, The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Database instance clone request.
    "cloneContext": { # Database instance clone context. # Contains details about the clone operation.
      "binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, indentify the the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordintes.
        "binLogPosition": "A String", # Position (offset) within the binary log file.
        "kind": "sql#binLogCoordinates", # This is always sql#binLogCoordinates.
        "binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
      },
      "kind": "sql#cloneContext", # This is always sql#cloneContext.
      "destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
    },
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
delete(project, instance) 
Deletes a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance to be deleted. (required)
  instance: string, Cloud SQL instance ID. This does not include the project 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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
export(project, instance, body) 
Exports data from a Cloud SQL 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. (required)
  instance: string, Cloud SQL 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.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
failover(project, instance, body) 
Failover the instance to its failover replica instance.

Args:
  project: string, ID of the project that contains the read replica. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Instance failover request.
    "failoverContext": { # Database instance failover context. # Failover Context.
      "kind": "sql#failoverContext", # This is always sql#failoverContext.
      "settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.
    },
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
get(project, instance) 
Retrieves a resource containing information about a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # A Cloud SQL instance resource.
      "backendType": "A String", # FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container.
          # SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM.
          # EXTERNAL: A MySQL server that is not managed by Google.
      "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details.
      "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
      "ipAddresses": [ # The assigned IP addresses for the instance.
        { # Database instance IP Mapping.
          "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
          "ipAddress": "A String", # The IP address assigned.
        },
      ],
      "databaseVersion": "A String", # The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances.
      "instanceType": "A String", # The instance type. This can be one of the following.
          # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
          # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
          # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
      "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
      "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
        "A String",
      ],
      "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
      "state": "A String", # The current serving state of the Cloud SQL 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.
          # FAILED: The instance creation failed.
          # UNKNOWN_STATE: The state of the instance is unknown.
      "etag": "A String", # HTTP 1.1 Entity tag for the resource.
      "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
        "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true.
        "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
      },
      "replicaNames": [ # The replicas of the instance.
        "A String",
      ],
      "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
        "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
        "hostPort": "A String", # The host and port of the on-premises instance in host:port format
      },
      "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
      "kind": "sql#instance", # This is always sql#instance.
      "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
      "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
      "serverCaCert": { # SslCerts Resource # SSL configuration.
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "kind": "sql#sslCert", # This is always sql#sslCert.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "instance": "A String", # Name of the database instance.
        "cert": "A String", # PEM representation.
        "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
        "selfLink": "A String", # The URI of this resource.
      },
      "region": "A String", # The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
      "settings": { # Database instance settings. # The user settings.
        "databaseFlags": [ # The database flags passed to the instance at startup.
          { # MySQL flags for Cloud SQL instances.
            "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
            "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
          },
        ],
        "kind": "sql#settings", # This is always sql#settings.
        "dataDiskType": "A String", # The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. Applies only to Second Generation instances.
        "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.
          "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow.
          "updateTrack": "A String",
          "day": 42, # day of week (1-7), starting on Monday.
          "hour": 42, # hour of day - 0 to 23.
        },
        "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.
          "A String",
        ],
        "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. The activation policy cannot be updated together with other settings for Second Generation instances. Valid values:
            # ALWAYS: The instance is on; it is not deactivated by inactivity.
            # NEVER: The instance is off; it is not activated, even if a connection request arrives.
            # ON_DEMAND: The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.
        "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
          "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
          "enabled": True or False, # Whether this configuration is enabled.
          "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
          "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
        },
        "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
          "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
          "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
          "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
            { # An entry for an Access Control list.
              "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
              "kind": "sql#aclEntry", # This is always sql#aclEntry.
              "value": "A String", # The whitelisted value for the access control list.
              "name": "A String", # An optional label to identify this entry.
            },
          ],
        },
        "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
        "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
        "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.
        "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.
        "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
        "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
        "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is false. Applies only to Second Generation instances.
        "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance. App Engine co-location is only applicable to First Generation instances.
          "kind": "sql#locationPreference", # This is always sql#locationPreference.
          "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
          "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
        },
        "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances.
      },
      "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
      "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
        "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
        "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.
            # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.
        "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
          "username": "A String", # The username for the replication connection.
          "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
          "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
          "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
          "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
          "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
          "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
          "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
          "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
          "password": "A String", # The password for the replication connection.
          "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
        },
      },
      "selfLink": "A String", # The URI of this resource.
    }
import_(project, instance, body) 
Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
insert(project, body) 
Creates a new Cloud SQL instance.

Args:
  project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL instance resource.
    "backendType": "A String", # FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container.
        # SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM.
        # EXTERNAL: A MySQL server that is not managed by Google.
    "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details.
    "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
    "ipAddresses": [ # The assigned IP addresses for the instance.
      { # Database instance IP Mapping.
        "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
        "ipAddress": "A String", # The IP address assigned.
      },
    ],
    "databaseVersion": "A String", # The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances.
    "instanceType": "A String", # The instance type. This can be one of the following.
        # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
        # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
        # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
    "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
    "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
      "A String",
    ],
    "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
    "state": "A String", # The current serving state of the Cloud SQL 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.
        # FAILED: The instance creation failed.
        # UNKNOWN_STATE: The state of the instance is unknown.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
      "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true.
      "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
    },
    "replicaNames": [ # The replicas of the instance.
      "A String",
    ],
    "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
      "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
      "hostPort": "A String", # The host and port of the on-premises instance in host:port format
    },
    "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
    "kind": "sql#instance", # This is always sql#instance.
    "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
    "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
    "serverCaCert": { # SslCerts Resource # SSL configuration.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
      "selfLink": "A String", # The URI of this resource.
    },
    "region": "A String", # The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
    "settings": { # Database instance settings. # The user settings.
      "databaseFlags": [ # The database flags passed to the instance at startup.
        { # MySQL flags for Cloud SQL instances.
          "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
          "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
        },
      ],
      "kind": "sql#settings", # This is always sql#settings.
      "dataDiskType": "A String", # The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. Applies only to Second Generation instances.
      "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.
        "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow.
        "updateTrack": "A String",
        "day": 42, # day of week (1-7), starting on Monday.
        "hour": 42, # hour of day - 0 to 23.
      },
      "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.
        "A String",
      ],
      "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. The activation policy cannot be updated together with other settings for Second Generation instances. Valid values:
          # ALWAYS: The instance is on; it is not deactivated by inactivity.
          # NEVER: The instance is off; it is not activated, even if a connection request arrives.
          # ON_DEMAND: The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.
      "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
        "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
        "enabled": True or False, # Whether this configuration is enabled.
        "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
        "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
      },
      "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
        "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
        "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
        "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
          { # An entry for an Access Control list.
            "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
            "kind": "sql#aclEntry", # This is always sql#aclEntry.
            "value": "A String", # The whitelisted value for the access control list.
            "name": "A String", # An optional label to identify this entry.
          },
        ],
      },
      "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
      "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
      "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.
      "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.
      "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
      "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
      "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is false. Applies only to Second Generation instances.
      "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance. App Engine co-location is only applicable to First Generation instances.
        "kind": "sql#locationPreference", # This is always sql#locationPreference.
        "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
        "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
      },
      "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances.
    },
    "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
      "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
      "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.
          # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.
      "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
        "username": "A String", # The username for the replication connection.
        "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
        "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
        "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
        "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
        "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
        "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
        "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
        "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
        "password": "A String", # The password for the replication connection.
        "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
      },
    },
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this 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 Cloud SQL instances. (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 Cloud SQL instance resource.
          "backendType": "A String", # FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container.
              # SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM.
              # EXTERNAL: A MySQL server that is not managed by Google.
          "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details.
          "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
          "ipAddresses": [ # The assigned IP addresses for the instance.
            { # Database instance IP Mapping.
              "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
              "ipAddress": "A String", # The IP address assigned.
            },
          ],
          "databaseVersion": "A String", # The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances.
          "instanceType": "A String", # The instance type. This can be one of the following.
              # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
              # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
              # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
          "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
          "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
            "A String",
          ],
          "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
          "state": "A String", # The current serving state of the Cloud SQL 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.
              # FAILED: The instance creation failed.
              # UNKNOWN_STATE: The state of the instance is unknown.
          "etag": "A String", # HTTP 1.1 Entity tag for the resource.
          "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
            "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true.
            "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
          },
          "replicaNames": [ # The replicas of the instance.
            "A String",
          ],
          "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
            "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
            "hostPort": "A String", # The host and port of the on-premises instance in host:port format
          },
          "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
          "kind": "sql#instance", # This is always sql#instance.
          "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
          "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
          "serverCaCert": { # SslCerts Resource # SSL configuration.
            "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
            "kind": "sql#sslCert", # This is always sql#sslCert.
            "sha1Fingerprint": "A String", # Sha1 Fingerprint.
            "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
            "instance": "A String", # Name of the database instance.
            "cert": "A String", # PEM representation.
            "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
            "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
            "selfLink": "A String", # The URI of this resource.
          },
          "region": "A String", # The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
          "settings": { # Database instance settings. # The user settings.
            "databaseFlags": [ # The database flags passed to the instance at startup.
              { # MySQL flags for Cloud SQL instances.
                "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
                "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
              },
            ],
            "kind": "sql#settings", # This is always sql#settings.
            "dataDiskType": "A String", # The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. Applies only to Second Generation instances.
            "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.
              "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow.
              "updateTrack": "A String",
              "day": 42, # day of week (1-7), starting on Monday.
              "hour": 42, # hour of day - 0 to 23.
            },
            "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.
              "A String",
            ],
            "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. The activation policy cannot be updated together with other settings for Second Generation instances. Valid values:
                # ALWAYS: The instance is on; it is not deactivated by inactivity.
                # NEVER: The instance is off; it is not activated, even if a connection request arrives.
                # ON_DEMAND: The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.
            "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
              "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
              "enabled": True or False, # Whether this configuration is enabled.
              "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
              "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
            },
            "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
              "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
              "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
              "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
                { # An entry for an Access Control list.
                  "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
                  "kind": "sql#aclEntry", # This is always sql#aclEntry.
                  "value": "A String", # The whitelisted value for the access control list.
                  "name": "A String", # An optional label to identify this entry.
                },
              ],
            },
            "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
            "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
            "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.
            "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.
            "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
            "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
            "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is false. Applies only to Second Generation instances.
            "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance. App Engine co-location is only applicable to First Generation instances.
              "kind": "sql#locationPreference", # This is always sql#locationPreference.
              "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
              "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
            },
            "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances.
          },
          "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
          "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
            "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
            "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.
                # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.
            "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
              "username": "A String", # The username for the replication connection.
              "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
              "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
              "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
              "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
              "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
              "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
              "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
              "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
              "password": "A String", # The password for the replication connection.
              "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
            },
          },
          "selfLink": "A String", # The URI of this resource.
        },
    ],
    "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 Cloud SQL 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. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL instance resource.
    "backendType": "A String", # FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container.
        # SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM.
        # EXTERNAL: A MySQL server that is not managed by Google.
    "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details.
    "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
    "ipAddresses": [ # The assigned IP addresses for the instance.
      { # Database instance IP Mapping.
        "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
        "ipAddress": "A String", # The IP address assigned.
      },
    ],
    "databaseVersion": "A String", # The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances.
    "instanceType": "A String", # The instance type. This can be one of the following.
        # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
        # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
        # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
    "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
    "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
      "A String",
    ],
    "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
    "state": "A String", # The current serving state of the Cloud SQL 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.
        # FAILED: The instance creation failed.
        # UNKNOWN_STATE: The state of the instance is unknown.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
      "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true.
      "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
    },
    "replicaNames": [ # The replicas of the instance.
      "A String",
    ],
    "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
      "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
      "hostPort": "A String", # The host and port of the on-premises instance in host:port format
    },
    "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
    "kind": "sql#instance", # This is always sql#instance.
    "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
    "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
    "serverCaCert": { # SslCerts Resource # SSL configuration.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
      "selfLink": "A String", # The URI of this resource.
    },
    "region": "A String", # The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
    "settings": { # Database instance settings. # The user settings.
      "databaseFlags": [ # The database flags passed to the instance at startup.
        { # MySQL flags for Cloud SQL instances.
          "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
          "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
        },
      ],
      "kind": "sql#settings", # This is always sql#settings.
      "dataDiskType": "A String", # The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. Applies only to Second Generation instances.
      "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.
        "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow.
        "updateTrack": "A String",
        "day": 42, # day of week (1-7), starting on Monday.
        "hour": 42, # hour of day - 0 to 23.
      },
      "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.
        "A String",
      ],
      "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. The activation policy cannot be updated together with other settings for Second Generation instances. Valid values:
          # ALWAYS: The instance is on; it is not deactivated by inactivity.
          # NEVER: The instance is off; it is not activated, even if a connection request arrives.
          # ON_DEMAND: The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.
      "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
        "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
        "enabled": True or False, # Whether this configuration is enabled.
        "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
        "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
      },
      "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
        "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
        "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
        "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
          { # An entry for an Access Control list.
            "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
            "kind": "sql#aclEntry", # This is always sql#aclEntry.
            "value": "A String", # The whitelisted value for the access control list.
            "name": "A String", # An optional label to identify this entry.
          },
        ],
      },
      "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
      "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
      "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.
      "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.
      "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
      "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
      "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is false. Applies only to Second Generation instances.
      "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance. App Engine co-location is only applicable to First Generation instances.
        "kind": "sql#locationPreference", # This is always sql#locationPreference.
        "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
        "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
      },
      "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances.
    },
    "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
      "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
      "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.
          # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.
      "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
        "username": "A String", # The username for the replication connection.
        "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
        "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
        "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
        "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
        "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
        "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
        "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
        "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
        "password": "A String", # The password for the replication connection.
        "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
      },
    },
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
promoteReplica(project, instance) 
Promotes the read replica instance to be a stand-alone Cloud SQL instance.

Args:
  project: string, ID of the project that contains the read replica. (required)
  instance: string, Cloud SQL read replica instance name. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
resetSslConfig(project, instance) 
Deletes all client certificates and generates a new server SSL certificate for the instance. The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project 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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
restart(project, instance) 
Restarts a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance to be restarted. (required)
  instance: string, Cloud SQL instance ID. This does not include the project 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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
restoreBackup(project, instance, body) 
Restores a backup of a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Database instance restore backup request.
    "restoreBackupContext": { # Database instance restore from backup context. # Parameters required to perform the restore backup operation.
      "instanceId": "A String", # The ID of the instance that the backup was taken from.
      "kind": "sql#restoreBackupContext", # This is always sql#restoreBackupContext.
      "backupRunId": "A String", # The ID of the backup run to restore from.
    },
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
startReplica(project, instance) 
Starts the replication in the read replica instance.

Args:
  project: string, ID of the project that contains the read replica. (required)
  instance: string, Cloud SQL read replica instance name. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
stopReplica(project, instance) 
Stops the replication in the read replica instance.

Args:
  project: string, ID of the project that contains the read replica. (required)
  instance: string, Cloud SQL read replica instance name. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
update(project, instance, body) 
Updates settings of a Cloud SQL 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. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL instance resource.
    "backendType": "A String", # FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container.
        # SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM.
        # EXTERNAL: A MySQL server that is not managed by Google.
    "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details.
    "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
    "ipAddresses": [ # The assigned IP addresses for the instance.
      { # Database instance IP Mapping.
        "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
        "ipAddress": "A String", # The IP address assigned.
      },
    ],
    "databaseVersion": "A String", # The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances.
    "instanceType": "A String", # The instance type. This can be one of the following.
        # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.
        # ON_PREMISES_INSTANCE: An instance running on the customer's premises.
        # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
    "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
    "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
      "A String",
    ],
    "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
    "state": "A String", # The current serving state of the Cloud SQL 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.
        # FAILED: The instance creation failed.
        # UNKNOWN_STATE: The state of the instance is unknown.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
      "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true.
      "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
    },
    "replicaNames": [ # The replicas of the instance.
      "A String",
    ],
    "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
      "kind": "sql#onPremisesConfiguration", # This is always sql#onPremisesConfiguration.
      "hostPort": "A String", # The host and port of the on-premises instance in host:port format
    },
    "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
    "kind": "sql#instance", # This is always sql#instance.
    "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
    "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
    "serverCaCert": { # SslCerts Resource # SSL configuration.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
      "selfLink": "A String", # The URI of this resource.
    },
    "region": "A String", # The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
    "settings": { # Database instance settings. # The user settings.
      "databaseFlags": [ # The database flags passed to the instance at startup.
        { # MySQL flags for Cloud SQL instances.
          "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
          "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
        },
      ],
      "kind": "sql#settings", # This is always sql#settings.
      "dataDiskType": "A String", # The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. Applies only to Second Generation instances.
      "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.
        "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow.
        "updateTrack": "A String",
        "day": 42, # day of week (1-7), starting on Monday.
        "hour": 42, # hour of day - 0 to 23.
      },
      "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.
        "A String",
      ],
      "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. The activation policy cannot be updated together with other settings for Second Generation instances. Valid values:
          # ALWAYS: The instance is on; it is not deactivated by inactivity.
          # NEVER: The instance is off; it is not activated, even if a connection request arrives.
          # ON_DEMAND: The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.
      "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
        "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
        "enabled": True or False, # Whether this configuration is enabled.
        "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
        "binaryLogEnabled": True or False, # Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
      },
      "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
        "requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
        "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
        "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
          { # An entry for an Access Control list.
            "expirationTime": "A String", # The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
            "kind": "sql#aclEntry", # This is always sql#aclEntry.
            "value": "A String", # The whitelisted value for the access control list.
            "name": "A String", # An optional label to identify this entry.
          },
        ],
      },
      "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
      "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
      "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.
      "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.
      "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
      "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
      "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is false. Applies only to Second Generation instances.
      "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance. App Engine co-location is only applicable to First Generation instances.
        "kind": "sql#locationPreference", # This is always sql#locationPreference.
        "zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
        "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
      },
      "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances.
    },
    "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters.
      "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration.
      "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.
          # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.
      "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
        "username": "A String", # The username for the replication connection.
        "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration.
        "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
        "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
        "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
        "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
        "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
        "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
        "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
        "password": "A String", # The password for the replication connection.
        "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
      },
    },
    "selfLink": "A String", # The URI of this resource.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.operations.html000066400000000000000000000326201300622755700263020ustar00rootroot00000000000000

Cloud SQL Administration API . operations

Instance Methods

get(project, 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 Cloud SQL 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, operation) 
Retrieves an instance operation that has been performed on an instance.

Args:
  project: string, Project ID of the project that contains the instance. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "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 Cloud SQL instance in the reverse chronological order of the start time.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL 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.
        "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
        "importContext": { # Database instance import context. # The context for import operation, if applicable.
          "fileType": "A String", # The file type for the specified uri.
              # SQL: The file contains SQL statements.
              # CSV: The file contains CSV data.
          "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
          "kind": "sql#importContext", # This is always sql#importContext.
          "uri": "A String", # A path to the 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 supported when fileType is SQL.
          "csvImportOptions": { # Options for importing data as CSV.
            "table": "A String", # The table to which CSV data is imported.
            "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
              "A String",
            ],
          },
        },
        "kind": "sql#operation", # This is always sql#operation.
        "name": "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.
        "exportContext": { # Database instance export context. # The context for export operation, if applicable.
          "kind": "sql#exportContext", # This is always sql#exportContext.
          "fileType": "A String", # The file type for the specified uri.
              # SQL: The file contains SQL statements.
              # CSV: The file contains CSV data.
          "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
          "csvExportOptions": { # Options for exporting data as CSV.
            "selectQuery": "A String", # The select query used to extract the data.
          },
          "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
            "A String",
          ],
          "sqlExportOptions": { # Options for exporting data as SQL statements.
            "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
              "A String",
            ],
            "schemaOnly": True or False, # Export only schemas.
          },
        },
        "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "targetProject": "A String", # The project ID of the target instance related to this operation.
        "targetId": "A String", # Name of the database instance related to this operation.
        "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
        "targetLink": "A String", # The URI of the instance related to the operation.
        "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
          "kind": "sql#operationErrors", # This is always sql#operationErrors.
          "errors": [ # The list of errors encountered while processing this operation.
            { # Database instance operation error.
              "kind": "sql#operationError", # This is always sql#operationError.
              "code": "A String", # Identifies the specific error that occurred.
              "message": "A String", # Additional information about the error encountered.
            },
          ],
        },
        "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "selfLink": "A String", # The URI of this resource.
        "user": "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.
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.sslCerts.html000066400000000000000000000474371300622755700257350ustar00rootroot00000000000000

Cloud SQL Administration API . sslCerts

Instance Methods

createEphemeral(project, instance, body)

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

delete(project, instance, sha1Fingerprint)

Deletes the SSL certificate. The change will not take effect until the instance is restarted.

get(project, instance, sha1Fingerprint)

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

insert(project, instance, body)

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

list(project, instance)

Lists all of the current SSL certificates for the instance.

Method Details

createEphemeral(project, instance, body) 
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

Args:
  project: string, Project ID of the Cloud SQL project. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # SslCerts create ephemeral certificate request.
    "public_key": "A String", # PEM encoded public key to include in the signed certificate.
  }


Returns:
  An object of the form:

    { # SslCerts Resource
    "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
    "kind": "sql#sslCert", # This is always sql#sslCert.
    "sha1Fingerprint": "A String", # Sha1 Fingerprint.
    "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
    "instance": "A String", # Name of the database instance.
    "cert": "A String", # PEM representation.
    "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
    "selfLink": "A String", # The URI of this resource.
  }
delete(project, instance, sha1Fingerprint) 
Deletes the SSL certificate. The change will not take effect until the instance is restarted.

Args:
  project: string, Project ID of the project that contains the instance to be deleted. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  sha1Fingerprint: string, Sha1 FingerPrint. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
get(project, instance, sha1Fingerprint) 
Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  sha1Fingerprint: string, Sha1 FingerPrint. (required)

Returns:
  An object of the form:

    { # SslCerts Resource
    "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
    "kind": "sql#sslCert", # This is always sql#sslCert.
    "sha1Fingerprint": "A String", # Sha1 Fingerprint.
    "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
    "instance": "A String", # Name of the database instance.
    "cert": "A String", # PEM representation.
    "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
    "selfLink": "A String", # The URI of this resource.
  }
insert(project, instance, body) 
Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

Args:
  project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # SslCerts insert request.
    "commonName": "A String", # User supplied name. Must be a distinct name from the other certificates for this instance. New certificates will not be usable until the instance is restarted.
  }


Returns:
  An object of the form:

    { # SslCert insert response.
    "kind": "sql#sslCertsInsert", # This is always sql#sslCertsInsert.
    "clientCert": { # SslCertDetail. # The new client certificate and private key. The new certificate will not work until the instance is restarted for First Generation instances.
      "certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.
      "certInfo": { # SslCerts Resource # The public information about the cert.
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "kind": "sql#sslCert", # This is always sql#sslCert.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "instance": "A String", # Name of the database instance.
        "cert": "A String", # PEM representation.
        "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
        "selfLink": "A String", # The URI of this resource.
      },
    },
    "operation": { # 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. # The operation to track the ssl certs insert request.
      "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
      "importContext": { # Database instance import context. # The context for import operation, if applicable.
        "fileType": "A String", # The file type for the specified uri.
            # SQL: The file contains SQL statements.
            # CSV: The file contains CSV data.
        "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
        "kind": "sql#importContext", # This is always sql#importContext.
        "uri": "A String", # A path to the 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 supported when fileType is SQL.
        "csvImportOptions": { # Options for importing data as CSV.
          "table": "A String", # The table to which CSV data is imported.
          "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
            "A String",
          ],
        },
      },
      "kind": "sql#operation", # This is always sql#operation.
      "name": "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.
      "exportContext": { # Database instance export context. # The context for export operation, if applicable.
        "kind": "sql#exportContext", # This is always sql#exportContext.
        "fileType": "A String", # The file type for the specified uri.
            # SQL: The file contains SQL statements.
            # CSV: The file contains CSV data.
        "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
        "csvExportOptions": { # Options for exporting data as CSV.
          "selectQuery": "A String", # The select query used to extract the data.
        },
        "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
          "A String",
        ],
        "sqlExportOptions": { # Options for exporting data as SQL statements.
          "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
            "A String",
          ],
          "schemaOnly": True or False, # Export only schemas.
        },
      },
      "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "targetProject": "A String", # The project ID of the target instance related to this operation.
      "targetId": "A String", # Name of the database instance related to this operation.
      "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
      "targetLink": "A String", # The URI of the instance related to the operation.
      "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
        "kind": "sql#operationErrors", # This is always sql#operationErrors.
        "errors": [ # The list of errors encountered while processing this operation.
          { # Database instance operation error.
            "kind": "sql#operationError", # This is always sql#operationError.
            "code": "A String", # Identifies the specific error that occurred.
            "message": "A String", # Additional information about the error encountered.
          },
        ],
      },
      "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "selfLink": "A String", # The URI of this resource.
      "user": "A String", # The email address of the user who initiated this operation.
    },
    "serverCaCert": { # SslCerts Resource # The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.
      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
      "kind": "sql#sslCert", # This is always sql#sslCert.
      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
      "instance": "A String", # Name of the database instance.
      "cert": "A String", # PEM representation.
      "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
      "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
      "selfLink": "A String", # The URI of this resource.
    },
  }
list(project, instance) 
Lists all of the current SSL certificates for the instance.

Args:
  project: string, Project ID of the project for which to list Cloud SQL instances. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # SslCerts list response.
    "items": [ # List of client certificates for the instance.
      { # SslCerts Resource
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "kind": "sql#sslCert", # This is always sql#sslCert.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "instance": "A String", # Name of the database instance.
        "cert": "A String", # PEM representation.
        "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
        "selfLink": "A String", # The URI of this resource.
      },
    ],
    "kind": "sql#sslCertsList", # This is always sql#sslCertsList.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.tiers.html000066400000000000000000000044531300622755700252500ustar00rootroot00000000000000

Cloud SQL Administration API . tiers

Instance Methods

list(project)

Lists all available service tiers for Google Cloud SQL, for example D1, D2. For related information, see Pricing.

Method Details

list(project) 
Lists all available service tiers for Google Cloud SQL, for example D1, D2. For related information, see Pricing.

Args:
  project: string, Project ID of the project for which to list tiers. (required)

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, europe-west1 or asia-east1.
          "A String",
        ],
      },
    ],
    "kind": "sql#tiersList", # This is always sql#tiersList.
  }
google-api-python-client-1.5.5/docs/dyn/sqladmin_v1beta4.users.html000066400000000000000000000525141300622755700252640ustar00rootroot00000000000000

Cloud SQL Administration API . users

Instance Methods

delete(project, instance, host, name)

Deletes a user from a Cloud SQL instance.

insert(project, instance, body)

Creates a new user in a Cloud SQL instance.

list(project, instance)

Lists users in the specified Cloud SQL instance.

update(project, instance, host, name, body)

Updates an existing user in a Cloud SQL instance.

Method Details

delete(project, instance, host, name) 
Deletes a user from a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)
  host: string, Host of the user in the instance. (required)
  name: string, Name of the user in the instance. (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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
insert(project, instance, body) 
Creates a new user in a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (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 Cloud SQL user resource.
    "kind": "sql#user", # This is always sql#user.
    "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.
    "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
    "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
    "host": "A String", # The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "password": "A String", # The password for the user.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
list(project, instance) 
Lists users in the specified Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)

Returns:
  An object of the form:

    { # User list response.
    "nextPageToken": "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.
    "items": [ # List of user resources in the instance.
      { # A Cloud SQL user resource.
          "kind": "sql#user", # This is always sql#user.
          "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.
          "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
          "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
          "host": "A String", # The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.
          "etag": "A String", # HTTP 1.1 Entity tag for the resource.
          "password": "A String", # The password for the user.
        },
    ],
    "kind": "sql#usersList", # This is always sql#usersList.
  }
update(project, instance, host, name, body) 
Updates an existing user in a Cloud SQL instance.

Args:
  project: string, Project ID of the project that contains the instance. (required)
  instance: string, Database instance ID. This does not include the project ID. (required)
  host: string, Host of the user in the instance. (required)
  name: string, Name of the user in the instance. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Cloud SQL user resource.
    "kind": "sql#user", # This is always sql#user.
    "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.
    "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
    "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
    "host": "A String", # The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.
    "etag": "A String", # HTTP 1.1 Entity tag for the resource.
    "password": "A String", # The password for the user.
  }


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.
    "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
      "kind": "sql#importContext", # This is always sql#importContext.
      "uri": "A String", # A path to the 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 supported when fileType is SQL.
      "csvImportOptions": { # Options for importing data as CSV.
        "table": "A String", # The table to which CSV data is imported.
        "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
          "A String",
        ],
      },
    },
    "kind": "sql#operation", # This is always sql#operation.
    "name": "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.
    "exportContext": { # Database instance export context. # The context for export operation, if applicable.
      "kind": "sql#exportContext", # This is always sql#exportContext.
      "fileType": "A String", # The file type for the specified uri.
          # SQL: The file contains SQL statements.
          # CSV: The file contains CSV data.
      "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
      "csvExportOptions": { # Options for exporting data as CSV.
        "selectQuery": "A String", # The select query used to extract the data.
      },
      "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
        "A String",
      ],
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
          "A String",
        ],
        "schemaOnly": True or False, # Export only schemas.
      },
    },
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
    "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
    "targetLink": "A String", # The URI of the instance related to the operation.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "sql#operationErrors", # This is always sql#operationErrors.
      "errors": [ # The list of errors encountered while processing this operation.
        { # Database instance operation error.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "selfLink": "A String", # The URI of this resource.
    "user": "A String", # The email address of the user who initiated this operation.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1.bucketAccessControls.html000066400000000000000000000416121300622755700271570ustar00rootroot00000000000000

Cloud Storage JSON API . bucketAccessControls

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "role": "A String", # The access permission for the entity.
      "id": "A String", # The ID of the access-control entry.
      "entityId": "A String", # The ID for the entity, if any.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "role": "A String", # The access permission for the entity.
      "id": "A String", # The ID of the access-control entry.
      "entityId": "A String", # The ID for the entity, if any.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "role": "A String", # The access permission for the entity.
      "id": "A String", # The ID of the access-control entry.
      "entityId": "A String", # The ID for the entity, if any.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "role": "A String", # The access permission for the entity.
      "id": "A String", # The ID of the access-control entry.
      "entityId": "A String", # The ID for the entity, if any.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "email": "A String", # The email address associated with the entity, if any.
      "selfLink": "A String", # The link to this access-control entry.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1.buckets.html000066400000000000000000002470241300622755700245010ustar00rootroot00000000000000

Cloud Storage JSON API . buckets

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, predefinedDefaultObjectAcl=None, predefinedAcl=None)

Creates a new bucket.

list(project, projection=None, pageToken=None, prefix=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, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics.

update(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Method Details

delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None) 
Permanently deletes an empty bucket.

Args:
  bucket: string, Name of a bucket. (required)
  ifMetagenerationMatch: string, If set, only deletes the bucket if its metageneration matches this value.
  ifMetagenerationNotMatch: string, If set, only deletes the bucket if its metageneration does not match this 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 owner, 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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
        "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
        "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
      },
      "selfLink": "A String", # The URI of this bucket.
      "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", # The creation time of the bucket in RFC 3339 format.
      "updated": "A String", # The modification 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
        "entityId": "A String", # The ID for the entity.
        "entity": "A String", # The entity, in the form project-owner-projectId.
      },
      "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
              "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
            },
            "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.
              "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
                "A String",
              ],
              "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
              "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.
              "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
      "projectNumber": "A String", # The project number of the project the bucket belongs to.
      "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
    }
insert(project, body, projection=None, predefinedDefaultObjectAcl=None, predefinedAcl=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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
      "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
      "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
    },
    "selfLink": "A String", # The URI of this bucket.
    "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", # The creation time of the bucket in RFC 3339 format.
    "updated": "A String", # The modification 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
      "entityId": "A String", # The ID for the entity.
      "entity": "A String", # The entity, in the form project-owner-projectId.
    },
    "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
            "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
          },
          "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.
            "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
              "A String",
            ],
            "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
            "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.
            "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
    "projectNumber": "A String", # The project number of the project the bucket belongs to.
    "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
  }

  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 owner, acl and defaultObjectAcl properties.
  predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  predefinedAcl: string, Apply a predefined set of access controls to this bucket.
    Allowed values
      authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access.
      private - Project team owners get OWNER access.
      projectPrivate - Project team members get access according to their roles.
      publicRead - Project team owners get OWNER access, and allUsers get READER access.
      publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access.

Returns:
  An object of the form:

    { # A bucket.
      "website": { # The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
        "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
        "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
      },
      "selfLink": "A String", # The URI of this bucket.
      "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", # The creation time of the bucket in RFC 3339 format.
      "updated": "A String", # The modification 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
        "entityId": "A String", # The ID for the entity.
        "entity": "A String", # The entity, in the form project-owner-projectId.
      },
      "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
              "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
            },
            "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.
              "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
                "A String",
              ],
              "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
              "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.
              "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
      "projectNumber": "A String", # The project number of the project the bucket belongs to.
      "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
    }
list(project, projection=None, pageToken=None, prefix=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 owner, acl and defaultObjectAcl properties.
  pageToken: string, A previously-returned page token representing part of the larger set of results to view.
  prefix: string, Filter results to buckets whose names begin with this prefix.
  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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
            "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
            "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
          },
          "selfLink": "A String", # The URI of this bucket.
          "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", # The creation time of the bucket in RFC 3339 format.
          "updated": "A String", # The modification 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
                    # - domain-domain
                    # - project-team-projectId
                    # - allUsers
                    # - allAuthenticatedUsers Examples:
                    # - The user liz@example.com would be user-liz@example.com.
                    # - The group example@googlegroups.com would be group-example@googlegroups.com.
                    # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
                "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
                "role": "A String", # The access permission for the entity.
                "id": "A String", # The ID of the access-control entry.
                "entityId": "A String", # The ID for the entity, if any.
                "projectTeam": { # The project team associated with the entity, if any.
                  "projectNumber": "A String", # The project number.
                  "team": "A String", # The team.
                },
                "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, if applied to an object.
              "object": "A String", # The name of the object, if applied to an 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
                  # - domain-domain
                  # - project-team-projectId
                  # - allUsers
                  # - allAuthenticatedUsers Examples:
                  # - The user liz@example.com would be user-liz@example.com.
                  # - The group example@googlegroups.com would be group-example@googlegroups.com.
                  # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
              "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
              "role": "A String", # The access permission for the entity.
              "id": "A String", # The ID of the access-control entry.
              "entityId": "A String", # The ID for the entity, if any.
              "projectTeam": { # The project team associated with the entity, if any.
                "projectNumber": "A String", # The project number.
                "team": "A String", # The team.
              },
              "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
            "entityId": "A String", # The ID for the entity.
            "entity": "A String", # The entity, in the form project-owner-projectId.
          },
          "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
                  "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
                },
                "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.
                  "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
                    "A String",
                  ],
                  "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
                  "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.
                  "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
          "projectNumber": "A String", # The project number of the project the bucket belongs to.
          "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
        },
    ],
    "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, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None) 
Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. 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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
      "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
      "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
    },
    "selfLink": "A String", # The URI of this bucket.
    "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", # The creation time of the bucket in RFC 3339 format.
    "updated": "A String", # The modification 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
      "entityId": "A String", # The ID for the entity.
      "entity": "A String", # The entity, in the form project-owner-projectId.
    },
    "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
            "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
          },
          "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.
            "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
              "A String",
            ],
            "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
            "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.
            "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
    "projectNumber": "A String", # The project number of the project the bucket belongs to.
    "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
  }

  projection: string, Set of properties to return. Defaults to full.
    Allowed values
      full - Include all properties.
      noAcl - Omit owner, 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.
  predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  predefinedAcl: string, Apply a predefined set of access controls to this bucket.
    Allowed values
      authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access.
      private - Project team owners get OWNER access.
      projectPrivate - Project team members get access according to their roles.
      publicRead - Project team owners get OWNER access, and allUsers get READER access.
      publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access.
  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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
        "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
        "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
      },
      "selfLink": "A String", # The URI of this bucket.
      "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", # The creation time of the bucket in RFC 3339 format.
      "updated": "A String", # The modification 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
        "entityId": "A String", # The ID for the entity.
        "entity": "A String", # The entity, in the form project-owner-projectId.
      },
      "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
              "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
            },
            "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.
              "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
                "A String",
              ],
              "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
              "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.
              "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
      "projectNumber": "A String", # The project number of the project the bucket belongs to.
      "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
    }
update(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None) 
Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
      "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
      "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
    },
    "selfLink": "A String", # The URI of this bucket.
    "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", # The creation time of the bucket in RFC 3339 format.
    "updated": "A String", # The modification 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
      "entityId": "A String", # The ID for the entity.
      "entity": "A String", # The entity, in the form project-owner-projectId.
    },
    "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
            "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
          },
          "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.
            "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
              "A String",
            ],
            "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
            "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.
            "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
    "projectNumber": "A String", # The project number of the project the bucket belongs to.
    "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
  }

  projection: string, Set of properties to return. Defaults to full.
    Allowed values
      full - Include all properties.
      noAcl - Omit owner, 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.
  predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  predefinedAcl: string, Apply a predefined set of access controls to this bucket.
    Allowed values
      authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access.
      private - Project team owners get OWNER access.
      projectPrivate - Project team members get access according to their roles.
      publicRead - Project team owners get OWNER access, and allUsers get READER access.
      publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access.
  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, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
        "notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
        "mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
      },
      "selfLink": "A String", # The URI of this bucket.
      "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", # The creation time of the bucket in RFC 3339 format.
      "updated": "A String", # The modification 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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. 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, (GET, OPTIONS, POST, etc) 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 is always the project team's owner group.
        "entityId": "A String", # The ID for the entity.
        "entity": "A String", # The entity, in the form project-owner-projectId.
      },
      "lifecycle": { # The bucket's lifecycle configuration. See 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. Currently, only Delete and SetStorageClass are supported.
              "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
            },
            "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.
              "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
                "A String",
              ],
              "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
              "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.
              "createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "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.
      "projectNumber": "A String", # The project number of the project the bucket belongs to.
      "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1.channels.html000066400000000000000000000052561300622755700246330ustar00rootroot00000000000000

Cloud Storage JSON API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1.defaultObjectAccessControls.html000066400000000000000000000446311300622755700304610ustar00rootroot00000000000000

Cloud Storage JSON API . defaultObjectAccessControls

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, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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, if applied to an object.
  "object": "A String", # The name of the object, if applied to an 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
      # - domain-domain
      # - project-team-projectId
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
  "role": "A String", # The access permission for the entity.
  "id": "A String", # The ID of the access-control entry.
  "entityId": "A String", # The ID for the entity, if any.
  "projectTeam": { # The project team associated with the entity, if any.
    "projectNumber": "A String", # The project number.
    "team": "A String", # The team.
  },
  "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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "email": "A String", # The email address associated with the entity, if any.
    "selfLink": "A String", # The link to this access-control entry.
  }
list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None) 
Retrieves default object ACL entries on the specified bucket.

Args:
  bucket: string, Name of a bucket. (required)
  ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value.
  ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value.

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.
        "generation": "A String", # The content generation of the object, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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, 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, user-emailAddress, group-groupId, group-emailAddress, 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, if applied to an object.
  "object": "A String", # The name of the object, if applied to an 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
      # - domain-domain
      # - project-team-projectId
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
  "role": "A String", # The access permission for the entity.
  "id": "A String", # The ID of the access-control entry.
  "entityId": "A String", # The ID for the entity, if any.
  "projectTeam": { # The project team associated with the entity, if any.
    "projectNumber": "A String", # The project number.
    "team": "A String", # The team.
  },
  "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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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, user-emailAddress, group-groupId, group-emailAddress, 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, if applied to an object.
  "object": "A String", # The name of the object, if applied to an 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
      # - domain-domain
      # - project-team-projectId
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
  "role": "A String", # The access permission for the entity.
  "id": "A String", # The ID of the access-control entry.
  "entityId": "A String", # The ID for the entity, if any.
  "projectTeam": { # The project team associated with the entity, if any.
    "projectNumber": "A String", # The project number.
    "team": "A String", # The team.
  },
  "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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "email": "A String", # The email address associated with the entity, if any.
    "selfLink": "A String", # The link to this access-control entry.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1.html000066400000000000000000000057031300622755700230360ustar00rootroot00000000000000

Cloud Storage JSON API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/storage_v1.objectAccessControls.html000066400000000000000000000473361300622755700271610ustar00rootroot00000000000000

Cloud Storage JSON API . objectAccessControls

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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, 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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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, if applied to an object.
  "object": "A String", # The name of the object, if applied to an 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
      # - domain-domain
      # - project-team-projectId
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
  "role": "A String", # The access permission for the entity.
  "id": "A String", # The ID of the access-control entry.
  "entityId": "A String", # The ID for the entity, if any.
  "projectTeam": { # The project team associated with the entity, if any.
    "projectNumber": "A String", # The project number.
    "team": "A String", # The team.
  },
  "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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
      { # An access-control entry.
        "domain": "A String", # The domain associated with the entity, if any.
        "generation": "A String", # The content generation of the object, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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, 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, 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, if applied to an object.
  "object": "A String", # The name of the object, if applied to an 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
      # - domain-domain
      # - project-team-projectId
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
  "role": "A String", # The access permission for the entity.
  "id": "A String", # The ID of the access-control entry.
  "entityId": "A String", # The ID for the entity, if any.
  "projectTeam": { # The project team associated with the entity, if any.
    "projectNumber": "A String", # The project number.
    "team": "A String", # The team.
  },
  "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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, 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, if applied to an object.
  "object": "A String", # The name of the object, if applied to an 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
      # - domain-domain
      # - project-team-projectId
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
  "role": "A String", # The access permission for the entity.
  "id": "A String", # The ID of the access-control entry.
  "entityId": "A String", # The ID for the entity, if any.
  "projectTeam": { # The project team associated with the entity, if any.
    "projectNumber": "A String", # The project number.
    "team": "A String", # The team.
  },
  "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, if applied to an object.
    "object": "A String", # The name of the object, if applied to an 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
        # - domain-domain
        # - project-team-projectId
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
    "role": "A String", # The access permission for the entity.
    "id": "A String", # The ID of the access-control entry.
    "entityId": "A String", # The ID for the entity, if any.
    "projectTeam": { # The project team associated with the entity, if any.
      "projectNumber": "A String", # The project number.
      "team": "A String", # The team.
    },
    "email": "A String", # The email address associated with the entity, if any.
    "selfLink": "A String", # The link to this access-control entry.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1.objects.html000066400000000000000000004135761300622755700245010ustar00rootroot00000000000000

Cloud Storage JSON API . objects

Instance Methods

compose(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None)

Concatenates a list of existing objects into a new object in the same bucket.

compose_media(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=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, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)

Copies a source object to a destination object. Optionally overrides metadata.

copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)

Copies a source object to a destination object. Optionally overrides metadata.

delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None)

Deletes an object and its 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 an object or its metadata.

get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)

Retrieves an object or its metadata.

insert(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)

Stores a new object and metadata.

insert_media(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None)

Stores a new object and 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, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)

Updates an object's metadata. This method supports patch semantics.

rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None)

Rewrites a source object to a destination object. Optionally overrides metadata.

update(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)

Updates an object's metadata.

update_media(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)

Updates an object's 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, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
        "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
        "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, if applied to an object.
            "object": "A String", # The name of the object, if applied to an 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
        "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
        "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
        "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
        "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", # The modification time of the object metadata in RFC 3339 format.
        "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
        "contentLanguage": "A String", # Content-Language of the object data.
        "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
          "encryptionAlgorithm": "A String", # The encryption algorithm.
          "keySha256": "A String", # SHA256 hash value of the encryption key.
        },
        "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
        "bucket": "A String", # The name of 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.
        "storageClass": "A String", # Storage class of the 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": { # Conditions that must be met for this operation to execute.
          "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.
        },
      },
    ],
  }

  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
  destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.

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.
      "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
      "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
      "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
      "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
      "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
      "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", # The modification time of the object metadata in RFC 3339 format.
      "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
      "contentLanguage": "A String", # Content-Language of the object data.
      "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
        "encryptionAlgorithm": "A String", # The encryption algorithm.
        "keySha256": "A String", # SHA256 hash value of the encryption key.
      },
      "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
      "bucket": "A String", # The name of 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.
      "storageClass": "A String", # Storage class of the object.
    }
compose_media(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
        "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
        "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, if applied to an object.
            "object": "A String", # The name of the object, if applied to an 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
        "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
        "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
        "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
        "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", # The modification time of the object metadata in RFC 3339 format.
        "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
        "contentLanguage": "A String", # Content-Language of the object data.
        "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
          "encryptionAlgorithm": "A String", # The encryption algorithm.
          "keySha256": "A String", # SHA256 hash value of the encryption key.
        },
        "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
        "bucket": "A String", # The name of 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.
        "storageClass": "A String", # Storage class of the 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": { # Conditions that must be met for this operation to execute.
          "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.
        },
      },
    ],
  }

  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
  destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.

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, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None) 
Copies a source object to a destination object. 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
  destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the 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 owner, 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.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
  destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  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.
  ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration 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.
      "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
      "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
      "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
      "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
      "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
      "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", # The modification time of the object metadata in RFC 3339 format.
      "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
      "contentLanguage": "A String", # Content-Language of the object data.
      "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
        "encryptionAlgorithm": "A String", # The encryption algorithm.
        "keySha256": "A String", # SHA256 hash value of the encryption key.
      },
      "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
      "bucket": "A String", # The name of 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.
      "storageClass": "A String", # Storage class of the object.
    }
copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None) 
Copies a source object to a destination object. 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
  destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the 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 owner, 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.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
  destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  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.
  ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value.

Returns:
  The media object as a string.
delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None) 
Deletes an object and its 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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 an object or its metadata.

Args:
  bucket: string, Name of the bucket in which the object resides. (required)
  object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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 owner, 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.
      "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
      "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
      "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
      "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
      "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
      "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", # The modification time of the object metadata in RFC 3339 format.
      "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
      "contentLanguage": "A String", # Content-Language of the object data.
      "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
        "encryptionAlgorithm": "A String", # The encryption algorithm.
        "keySha256": "A String", # SHA256 hash value of the encryption key.
      },
      "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
      "bucket": "A String", # The name of 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.
      "storageClass": "A String", # Storage class of the object.
    }
get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None) 
Retrieves an object or its metadata.

Args:
  bucket: string, Name of the bucket in which the object resides. (required)
  object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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 owner, acl property.

Returns:
  The media object as a string.
insert(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None) 
Stores a new object and 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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the 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 owner, acl property.
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  predefinedAcl: string, Apply a predefined set of access controls to this object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
  contentEncoding: string, If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
  ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration 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.
      "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
      "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
      "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
      "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
      "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
      "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", # The modification time of the object metadata in RFC 3339 format.
      "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
      "contentLanguage": "A String", # Content-Language of the object data.
      "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
        "encryptionAlgorithm": "A String", # The encryption algorithm.
        "keySha256": "A String", # SHA256 hash value of the encryption key.
      },
      "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
      "bucket": "A String", # The name of 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.
      "storageClass": "A String", # Storage class of the object.
    }
insert_media(bucket, body=None, projection=None, media_body=None, predefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, name=None, ifMetagenerationMatch=None, contentEncoding=None, ifMetagenerationNotMatch=None) 
Stores a new object and 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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the 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 owner, acl property.
  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  predefinedAcl: string, Apply a predefined set of access controls to this object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
  contentEncoding: string, If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
  ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration 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 owner, acl property.
  versions: boolean, If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
  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. The default value of this parameter is 1,000 items.
  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.
          "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
          "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, if applied to an object.
              "object": "A String", # The name of the object, if applied to an 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
                  # - domain-domain
                  # - project-team-projectId
                  # - allUsers
                  # - allAuthenticatedUsers Examples:
                  # - The user liz@example.com would be user-liz@example.com.
                  # - The group example@googlegroups.com would be group-example@googlegroups.com.
                  # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
              "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
              "role": "A String", # The access permission for the entity.
              "id": "A String", # The ID of the access-control entry.
              "entityId": "A String", # The ID for the entity, if any.
              "projectTeam": { # The project team associated with the entity, if any.
                "projectNumber": "A String", # The project number.
                "team": "A String", # The team.
              },
              "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
          "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
          "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
          "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
          "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", # The modification time of the object metadata in RFC 3339 format.
          "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
          "contentLanguage": "A String", # Content-Language of the object data.
          "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
            "encryptionAlgorithm": "A String", # The encryption algorithm.
            "keySha256": "A String", # SHA256 hash value of the encryption key.
          },
          "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
          "bucket": "A String", # The name of 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.
          "storageClass": "A String", # Storage class of the 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, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None) 
Updates an object's 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the object.
  }

  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  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.
  predefinedAcl: string, Apply a predefined set of access controls to this object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  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 owner, 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.
      "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
      "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
      "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
      "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
      "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
      "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", # The modification time of the object metadata in RFC 3339 format.
      "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
      "contentLanguage": "A String", # Content-Language of the object data.
      "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
        "encryptionAlgorithm": "A String", # The encryption algorithm.
        "keySha256": "A String", # SHA256 hash value of the encryption key.
      },
      "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
      "bucket": "A String", # The name of 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.
      "storageClass": "A String", # Storage class of the object.
    }
rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, maxBytesRewrittenPerCall=None, ifSourceGenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, rewriteToken=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationNotMatch=None) 
Rewrites a source object to a destination object. 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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the 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 owner, acl property.
  sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default).
  maxBytesRewrittenPerCall: string, The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.
  ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's generation 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.
  ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
  rewriteToken: string, Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
  ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
  destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  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.
  ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value.

Returns:
  An object of the form:

    { # A rewrite response.
    "objectSize": "A String", # The total size of the object being copied in bytes. This property is always present in the response.
    "kind": "storage#rewriteResponse", # The kind of item this is.
    "resource": { # An object. # A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes.
        "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.
        "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
        "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, if applied to an object.
            "object": "A String", # The name of the object, if applied to an 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
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "role": "A String", # The access permission for the entity.
            "id": "A String", # The ID of the access-control entry.
            "entityId": "A String", # The ID for the entity, if any.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
        "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
        "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
        "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
        "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", # The modification time of the object metadata in RFC 3339 format.
        "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
        "contentLanguage": "A String", # Content-Language of the object data.
        "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
          "encryptionAlgorithm": "A String", # The encryption algorithm.
          "keySha256": "A String", # SHA256 hash value of the encryption key.
        },
        "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
        "bucket": "A String", # The name of 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.
        "storageClass": "A String", # Storage class of the object.
      },
    "done": True or False, # true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response.
    "totalBytesRewritten": "A String", # The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.
    "rewriteToken": "A String", # A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy.
  }
update(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None) 
Updates an object's metadata.

Args:
  bucket: string, Name of the bucket in which the object resides. (required)
  object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the object.
  }

  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  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.
  predefinedAcl: string, Apply a predefined set of access controls to this object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  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 owner, 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.
      "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
      "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, if applied to an object.
          "object": "A String", # The name of the object, if applied to an 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
              # - domain-domain
              # - project-team-projectId
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
          "role": "A String", # The access permission for the entity.
          "id": "A String", # The ID of the access-control entry.
          "entityId": "A String", # The ID for the entity, if any.
          "projectTeam": { # The project team associated with the entity, if any.
            "projectNumber": "A String", # The project number.
            "team": "A String", # The team.
          },
          "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
      "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
      "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
      "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
      "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", # The modification time of the object metadata in RFC 3339 format.
      "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
      "contentLanguage": "A String", # Content-Language of the object data.
      "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
        "encryptionAlgorithm": "A String", # The encryption algorithm.
        "keySha256": "A String", # SHA256 hash value of the encryption key.
      },
      "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
      "bucket": "A String", # The name of 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.
      "storageClass": "A String", # Storage class of the object.
    }
update_media(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None) 
Updates an object's metadata.

Args:
  bucket: string, Name of the bucket in which the object resides. (required)
  object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (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.
    "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. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
    "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, if applied to an object.
        "object": "A String", # The name of the object, if applied to an 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
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "role": "A String", # The access permission for the entity.
        "id": "A String", # The ID of the access-control entry.
        "entityId": "A String", # The ID for the entity, if any.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "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", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
    "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
    "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
    "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
    "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", # The modification time of the object metadata in RFC 3339 format.
    "contentType": "A String", # Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.
    "contentLanguage": "A String", # Content-Language of the object data.
    "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
      "encryptionAlgorithm": "A String", # The encryption algorithm.
      "keySha256": "A String", # SHA256 hash value of the encryption key.
    },
    "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular 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.
    "bucket": "A String", # The name of 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.
    "storageClass": "A String", # Storage class of the object.
  }

  ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
  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.
  predefinedAcl: string, Apply a predefined set of access controls to this object.
    Allowed values
      authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
      bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
      bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
      private - Object owner gets OWNER access.
      projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
      publicRead - Object owner gets OWNER access, and allUsers get READER access.
  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 owner, 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:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }

  projection: string, Set of properties to return. Defaults to noAcl.
    Allowed values
      full - Include all properties.
      noAcl - Omit the owner, acl property.
  versions: boolean, If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
  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. The default value of this parameter is 1,000 items.
  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:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta1.bucketAccessControls.html000066400000000000000000000354501300622755700300770ustar00rootroot00000000000000

Cloud Storage JSON API . bucketAccessControls

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "email": "A String", # The email address associated with the entity, if any.
      "selfLink": "A String", # The link to this access-control entry.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta1.buckets.html000066400000000000000000001134721300622755700254150ustar00rootroot00000000000000

Cloud Storage JSON API . buckets

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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
                    # - domain-domain
                    # - allUsers
                    # - allAuthenticatedUsers Examples:
                    # - The user liz@example.com would be user-liz@example.com.
                    # - The group example@googlegroups.com would be group-example@googlegroups.com.
                    # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
                "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
                  # - domain-domain
                  # - allUsers
                  # - allAuthenticatedUsers Examples:
                  # - The user liz@example.com would be user-liz@example.com.
                  # - The group example@googlegroups.com would be group-example@googlegroups.com.
                  # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
              "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta1.html000066400000000000000000000051651300622755700237550ustar00rootroot00000000000000

Cloud Storage JSON API

Instance Methods

bucketAccessControls()

Returns the bucketAccessControls Resource.

buckets()

Returns the buckets Resource.

objectAccessControls()

Returns the objectAccessControls Resource.

objects()

Returns the objects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/storage_v1beta1.objectAccessControls.html000066400000000000000000000363041300622755700300670ustar00rootroot00000000000000

Cloud Storage JSON API . objectAccessControls

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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, user-emailAddress, group-groupId, group-emailAddress, 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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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, user-emailAddress, group-groupId, group-emailAddress, 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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "email": "A String", # The email address associated with the entity, if any.
    "selfLink": "A String", # The link to this access-control entry.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta1.objects.html000066400000000000000000001272761300622755700254150ustar00rootroot00000000000000

Cloud Storage JSON API . objects

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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
                  # - domain-domain
                  # - allUsers
                  # - allAuthenticatedUsers Examples:
                  # - The user liz@example.com would be user-liz@example.com.
                  # - The group example@googlegroups.com would be group-example@googlegroups.com.
                  # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
              "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.bucketAccessControls.html000066400000000000000000000366561300622755700301110ustar00rootroot00000000000000

Cloud Storage JSON API . bucketAccessControls

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
          # - domain-domain
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "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.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.buckets.html000066400000000000000000002043251300622755700254140ustar00rootroot00000000000000

Cloud Storage JSON API . buckets

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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
            },
            "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 are 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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
          },
          "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 are 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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
            },
            "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 are 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
                    # - domain-domain
                    # - allUsers
                    # - allAuthenticatedUsers Examples:
                    # - The user liz@example.com would be user-liz@example.com.
                    # - The group example@googlegroups.com would be group-example@googlegroups.com.
                    # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
                "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
                  # - domain-domain
                  # - allUsers
                  # - allAuthenticatedUsers Examples:
                  # - The user liz@example.com would be user-liz@example.com.
                  # - The group example@googlegroups.com would be group-example@googlegroups.com.
                  # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
              "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
                },
                "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 are 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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
          },
          "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 are 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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
            },
            "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 are 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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
          },
          "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 are 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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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: GET, OPTIONS, POST, etc. 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 is always 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. Currently only Delete is supported.
            },
            "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 are 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.
    }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.channels.html000066400000000000000000000052701300622755700255450ustar00rootroot00000000000000

Cloud Storage JSON API . channels

Instance Methods

stop(body)

Stop watching resources through this channel

Method Details

stop(body) 
Stop watching resources through this channel

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this channel.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.defaultObjectAccessControls.html000066400000000000000000000361031300622755700313720ustar00rootroot00000000000000

Cloud Storage JSON API . defaultObjectAccessControls

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, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None) 
Retrieves default object ACL entries on the specified bucket.

Args:
  bucket: string, Name of a bucket. (required)
  ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value.
  ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value.

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, user-emailAddress, group-groupId, group-emailAddress, 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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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, user-emailAddress, group-groupId, group-emailAddress, 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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.html000066400000000000000000000057461300622755700237630ustar00rootroot00000000000000

Cloud Storage JSON API

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.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.objectAccessControls.html000066400000000000000000000374661300622755700301020ustar00rootroot00000000000000

Cloud Storage JSON API . objectAccessControls

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, user-emailAddress, group-groupId, group-emailAddress, 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, user-emailAddress, group-groupId, group-emailAddress, 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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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, user-emailAddress, group-groupId, group-emailAddress, 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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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, user-emailAddress, group-groupId, group-emailAddress, 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
      # - domain-domain
      # - allUsers
      # - allAuthenticatedUsers Examples:
      # - The user liz@example.com would be user-liz@example.com.
      # - The group example@googlegroups.com would be group-example@googlegroups.com.
      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
  "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
        # - domain-domain
        # - allUsers
        # - allAuthenticatedUsers Examples:
        # - The user liz@example.com would be user-liz@example.com.
        # - The group example@googlegroups.com would be group-example@googlegroups.com.
        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
    "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.
  }
google-api-python-client-1.5.5/docs/dyn/storage_v1beta2.objects.html000066400000000000000000002711131300622755700254040ustar00rootroot00000000000000

Cloud Storage JSON API . objects

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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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.
        "contentDisposition": "A String", # Content-Disposition 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.
        "storageClass": "A String", # Storage class of the object.
        "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": { # Conditions that must be met for this operation to execute.
          "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
      "contentDisposition": "A String", # Content-Disposition 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.
      "storageClass": "A String", # Storage class of the object.
      "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
                # - domain-domain
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "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.
        "contentDisposition": "A String", # Content-Disposition 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.
        "storageClass": "A String", # Storage class of the object.
        "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": { # Conditions that must be met for this operation to execute.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
      "contentDisposition": "A String", # Content-Disposition 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.
      "storageClass": "A String", # Storage class of the object.
      "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
      "contentDisposition": "A String", # Content-Disposition 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.
      "storageClass": "A String", # Storage class of the object.
      "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
      "contentDisposition": "A String", # Content-Disposition 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.
      "storageClass": "A String", # Storage class of the object.
      "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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
                  # - domain-domain
                  # - allUsers
                  # - allAuthenticatedUsers Examples:
                  # - The user liz@example.com would be user-liz@example.com.
                  # - The group example@googlegroups.com would be group-example@googlegroups.com.
                  # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
              "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.
          "contentDisposition": "A String", # Content-Disposition 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.
          "storageClass": "A String", # Storage class of the object.
          "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
      "contentDisposition": "A String", # Content-Disposition 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.
      "storageClass": "A String", # Storage class of the object.
      "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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
              # - domain-domain
              # - allUsers
              # - allAuthenticatedUsers Examples:
              # - The user liz@example.com would be user-liz@example.com.
              # - The group example@googlegroups.com would be group-example@googlegroups.com.
              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
          "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.
      "contentDisposition": "A String", # Content-Disposition 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.
      "storageClass": "A String", # Storage class of the object.
      "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
            # - domain-domain
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "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.
    "contentDisposition": "A String", # Content-Disposition 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.
    "storageClass": "A String", # Storage class of the object.
    "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:

{ # An notification channel used to watch for resource changes.
    "resourceUri": "A String", # A version-specific identifier for the watched resource.
    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    "params": { # Additional parameters controlling delivery channel behavior. Optional.
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    "address": "A String", # The address where notifications are delivered for this channel.
    "type": "A String", # The type of delivery mechanism used for this channel.
    "id": "A String", # A UUID or similar unique string that identifies this 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:

    { # An notification channel used to watch for resource changes.
      "resourceUri": "A String", # A version-specific identifier for the watched resource.
      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
      "params": { # Additional parameters controlling delivery channel behavior. Optional.
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
      "address": "A String", # The address where notifications are delivered for this channel.
      "type": "A String", # The type of delivery mechanism used for this channel.
      "id": "A String", # A UUID or similar unique string that identifies this channel.
    }
google-api-python-client-1.5.5/docs/dyn/storagetransfer_v1.googleServiceAccounts.html000066400000000000000000000051341300622755700310750ustar00rootroot00000000000000

Google Storage Transfer API . googleServiceAccounts

Instance Methods

get(projectId, x__xgafv=None)

Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Developers Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Method Details

get(projectId, x__xgafv=None) 
Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Developers Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Args:
  projectId: string, The ID of the Google Developers Console project that the Google service account is associated with. Required. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Google service account
    "accountEmail": "A String", # Required.
  }
google-api-python-client-1.5.5/docs/dyn/storagetransfer_v1.html000066400000000000000000000052061300622755700246010ustar00rootroot00000000000000

Google Storage Transfer API

Instance Methods

googleServiceAccounts()

Returns the googleServiceAccounts Resource.

transferJobs()

Returns the transferJobs Resource.

transferOperations()

Returns the transferOperations Resource.

v1()

Returns the v1 Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/storagetransfer_v1.transferJobs.html000066400000000000000000002132401300622755700272410ustar00rootroot00000000000000

Google Storage Transfer API . transferJobs

Instance Methods

create(body, x__xgafv=None)

Creates a transfer job that runs periodically.

get(jobName, projectId=None, x__xgafv=None)

Gets a transfer job.

list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists transfer jobs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(jobName, body, x__xgafv=None)

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.

Method Details

create(body, x__xgafv=None) 
Creates a transfer job that runs periodically.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # This resource represents the configuration of a transfer job that runs periodically.
    "transferSpec": { # Configuration for running a transfer. # Transfer specification. Required.
      "objectConditions": { # Conditions that determine which objects will be transferred. # Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
        "maxTimeElapsedSinceLastModification": "A String", # `maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
        "includePrefixes": [ # If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.
          "A String",
        ],
        "excludePrefixes": [ # `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
          "A String",
        ],
        "minTimeElapsedSinceLastModification": "A String", # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
      },
      "gcsDataSource": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data source.
        "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
      },
      "httpDataSource": { # An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response. # An HTTP URL data source.
        "listUrl": "A String", # The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
      },
      "transferOptions": { # TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. # If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.
        "overwriteObjectsAlreadyExistingInSink": True or False, # Whether overwriting objects that already exist in the sink is allowed.
        "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink.
        "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted.
      },
      "gcsDataSink": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data sink.
        "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
      },
      "awsS3DataSource": { # An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name. # An AWS S3 data source.
        "awsAccessKey": { # AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). # AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
          "secretAccessKey": "A String", # AWS secret access key. This field is not returned in RPC responses. Required.
          "accessKeyId": "A String", # AWS access key ID. Required.
        },
        "bucketName": "A String", # S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
      },
    },
    "status": "A String", # Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
    "deletionTime": "A String", # This field cannot be changed by user requests.
    "name": "A String", # A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
    "schedule": { # Transfers can be scheduled to recur or to run just once. # Schedule specification. Required.
      "scheduleStartDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The first day the recurring transfer is scheduled to run. Required.
        "month": 42, # Month of year of date. Must be from 1 to 12.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
        "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
      },
      "startTimeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`. # The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC.
        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
      },
      "scheduleEndDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
        "month": 42, # Month of year of date. Must be from 1 to 12.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
        "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
      },
    },
    "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
    "lastModificationTime": "A String", # This field cannot be changed by user requests.
    "creationTime": "A String", # This field cannot be changed by user requests.
    "description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents the configuration of a transfer job that runs periodically.
      "transferSpec": { # Configuration for running a transfer. # Transfer specification. Required.
        "objectConditions": { # Conditions that determine which objects will be transferred. # Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
          "maxTimeElapsedSinceLastModification": "A String", # `maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
          "includePrefixes": [ # If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.
            "A String",
          ],
          "excludePrefixes": [ # `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
            "A String",
          ],
          "minTimeElapsedSinceLastModification": "A String", # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
        },
        "gcsDataSource": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data source.
          "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
        },
        "httpDataSource": { # An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response. # An HTTP URL data source.
          "listUrl": "A String", # The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
        },
        "transferOptions": { # TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. # If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.
          "overwriteObjectsAlreadyExistingInSink": True or False, # Whether overwriting objects that already exist in the sink is allowed.
          "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink.
          "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted.
        },
        "gcsDataSink": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data sink.
          "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
        },
        "awsS3DataSource": { # An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name. # An AWS S3 data source.
          "awsAccessKey": { # AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). # AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
            "secretAccessKey": "A String", # AWS secret access key. This field is not returned in RPC responses. Required.
            "accessKeyId": "A String", # AWS access key ID. Required.
          },
          "bucketName": "A String", # S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
        },
      },
      "status": "A String", # Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
      "deletionTime": "A String", # This field cannot be changed by user requests.
      "name": "A String", # A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
      "schedule": { # Transfers can be scheduled to recur or to run just once. # Schedule specification. Required.
        "scheduleStartDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The first day the recurring transfer is scheduled to run. Required.
          "month": 42, # Month of year of date. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
          "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
        },
        "startTimeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`. # The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC.
          "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
          "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
          "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
          "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
        },
        "scheduleEndDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
          "month": 42, # Month of year of date. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
          "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
        },
      },
      "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
      "lastModificationTime": "A String", # This field cannot be changed by user requests.
      "creationTime": "A String", # This field cannot be changed by user requests.
      "description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
    }
get(jobName, projectId=None, x__xgafv=None) 
Gets a transfer job.

Args:
  jobName: string, The job to get. Required. (required)
  projectId: string, The ID of the Google Developers Console project that owns the job. Required.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents the configuration of a transfer job that runs periodically.
      "transferSpec": { # Configuration for running a transfer. # Transfer specification. Required.
        "objectConditions": { # Conditions that determine which objects will be transferred. # Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
          "maxTimeElapsedSinceLastModification": "A String", # `maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
          "includePrefixes": [ # If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.
            "A String",
          ],
          "excludePrefixes": [ # `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
            "A String",
          ],
          "minTimeElapsedSinceLastModification": "A String", # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
        },
        "gcsDataSource": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data source.
          "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
        },
        "httpDataSource": { # An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response. # An HTTP URL data source.
          "listUrl": "A String", # The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
        },
        "transferOptions": { # TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. # If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.
          "overwriteObjectsAlreadyExistingInSink": True or False, # Whether overwriting objects that already exist in the sink is allowed.
          "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink.
          "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted.
        },
        "gcsDataSink": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data sink.
          "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
        },
        "awsS3DataSource": { # An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name. # An AWS S3 data source.
          "awsAccessKey": { # AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). # AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
            "secretAccessKey": "A String", # AWS secret access key. This field is not returned in RPC responses. Required.
            "accessKeyId": "A String", # AWS access key ID. Required.
          },
          "bucketName": "A String", # S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
        },
      },
      "status": "A String", # Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
      "deletionTime": "A String", # This field cannot be changed by user requests.
      "name": "A String", # A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
      "schedule": { # Transfers can be scheduled to recur or to run just once. # Schedule specification. Required.
        "scheduleStartDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The first day the recurring transfer is scheduled to run. Required.
          "month": 42, # Month of year of date. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
          "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
        },
        "startTimeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`. # The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC.
          "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
          "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
          "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
          "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
        },
        "scheduleEndDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
          "month": 42, # Month of year of date. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
          "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
        },
      },
      "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
      "lastModificationTime": "A String", # This field cannot be changed by user requests.
      "creationTime": "A String", # This field cannot be changed by user requests.
      "description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
    }
list(pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists transfer jobs.

Args:
  pageSize: integer, The list page size. The max allowed value is 256.
  filter: string, A list of query parameters specified as JSON text in the form of {"`project_id`":"my_project_id", "`job_names`":["jobid1","jobid2",...], "`job_statuses`":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.
  pageToken: string, The list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Response from ListTransferJobs.
    "nextPageToken": "A String", # The list next page token.
    "transferJobs": [ # A list of transfer jobs.
      { # This resource represents the configuration of a transfer job that runs periodically.
          "transferSpec": { # Configuration for running a transfer. # Transfer specification. Required.
            "objectConditions": { # Conditions that determine which objects will be transferred. # Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
              "maxTimeElapsedSinceLastModification": "A String", # `maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
              "includePrefixes": [ # If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.
                "A String",
              ],
              "excludePrefixes": [ # `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
                "A String",
              ],
              "minTimeElapsedSinceLastModification": "A String", # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
            },
            "gcsDataSource": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data source.
              "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
            },
            "httpDataSource": { # An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response. # An HTTP URL data source.
              "listUrl": "A String", # The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
            },
            "transferOptions": { # TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. # If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.
              "overwriteObjectsAlreadyExistingInSink": True or False, # Whether overwriting objects that already exist in the sink is allowed.
              "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink.
              "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted.
            },
            "gcsDataSink": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data sink.
              "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
            },
            "awsS3DataSource": { # An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name. # An AWS S3 data source.
              "awsAccessKey": { # AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). # AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
                "secretAccessKey": "A String", # AWS secret access key. This field is not returned in RPC responses. Required.
                "accessKeyId": "A String", # AWS access key ID. Required.
              },
              "bucketName": "A String", # S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
            },
          },
          "status": "A String", # Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
          "deletionTime": "A String", # This field cannot be changed by user requests.
          "name": "A String", # A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
          "schedule": { # Transfers can be scheduled to recur or to run just once. # Schedule specification. Required.
            "scheduleStartDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The first day the recurring transfer is scheduled to run. Required.
              "month": 42, # Month of year of date. Must be from 1 to 12.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
              "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
            },
            "startTimeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`. # The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC.
              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
            },
            "scheduleEndDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
              "month": 42, # Month of year of date. Must be from 1 to 12.
              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
              "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
            },
          },
          "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
          "lastModificationTime": "A String", # This field cannot be changed by user requests.
          "creationTime": "A String", # This field cannot be changed by user requests.
          "description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
        },
    ],
  }
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(jobName, body, x__xgafv=None) 
Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.

Args:
  jobName: string, The name of job to update. Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request passed to UpdateTransferJob.
    "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
    "updateTransferJobFieldMask": "A String", # The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: `description`, `transferSpec`, and `status`. To update the `transferSpec` of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error `INVALID_ARGUMENT`.
    "transferJob": { # This resource represents the configuration of a transfer job that runs periodically. # The job to update. Required.
        "transferSpec": { # Configuration for running a transfer. # Transfer specification. Required.
          "objectConditions": { # Conditions that determine which objects will be transferred. # Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
            "maxTimeElapsedSinceLastModification": "A String", # `maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
            "includePrefixes": [ # If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.
              "A String",
            ],
            "excludePrefixes": [ # `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
              "A String",
            ],
            "minTimeElapsedSinceLastModification": "A String", # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
          },
          "gcsDataSource": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data source.
            "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
          },
          "httpDataSource": { # An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response. # An HTTP URL data source.
            "listUrl": "A String", # The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
          },
          "transferOptions": { # TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. # If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.
            "overwriteObjectsAlreadyExistingInSink": True or False, # Whether overwriting objects that already exist in the sink is allowed.
            "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink.
            "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted.
          },
          "gcsDataSink": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data sink.
            "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
          },
          "awsS3DataSource": { # An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name. # An AWS S3 data source.
            "awsAccessKey": { # AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). # AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
              "secretAccessKey": "A String", # AWS secret access key. This field is not returned in RPC responses. Required.
              "accessKeyId": "A String", # AWS access key ID. Required.
            },
            "bucketName": "A String", # S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
          },
        },
        "status": "A String", # Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
        "deletionTime": "A String", # This field cannot be changed by user requests.
        "name": "A String", # A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
        "schedule": { # Transfers can be scheduled to recur or to run just once. # Schedule specification. Required.
          "scheduleStartDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The first day the recurring transfer is scheduled to run. Required.
            "month": 42, # Month of year of date. Must be from 1 to 12.
            "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
            "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
          },
          "startTimeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`. # The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC.
            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
          },
          "scheduleEndDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
            "month": 42, # Month of year of date. Must be from 1 to 12.
            "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
            "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
          },
        },
        "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
        "lastModificationTime": "A String", # This field cannot be changed by user requests.
        "creationTime": "A String", # This field cannot be changed by user requests.
        "description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
      },
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents the configuration of a transfer job that runs periodically.
      "transferSpec": { # Configuration for running a transfer. # Transfer specification. Required.
        "objectConditions": { # Conditions that determine which objects will be transferred. # Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
          "maxTimeElapsedSinceLastModification": "A String", # `maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
          "includePrefixes": [ # If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 20.
            "A String",
          ],
          "excludePrefixes": [ # `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
            "A String",
          ],
          "minTimeElapsedSinceLastModification": "A String", # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
        },
        "gcsDataSource": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data source.
          "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
        },
        "httpDataSource": { # An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response. # An HTTP URL data source.
          "listUrl": "A String", # The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
        },
        "transferOptions": { # TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. # If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.
          "overwriteObjectsAlreadyExistingInSink": True or False, # Whether overwriting objects that already exist in the sink is allowed.
          "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink.
          "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted.
        },
        "gcsDataSink": { # In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. # A Google Cloud Storage data sink.
          "bucketName": "A String", # Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
        },
        "awsS3DataSource": { # An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name. # An AWS S3 data source.
          "awsAccessKey": { # AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). # AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
            "secretAccessKey": "A String", # AWS secret access key. This field is not returned in RPC responses. Required.
            "accessKeyId": "A String", # AWS access key ID. Required.
          },
          "bucketName": "A String", # S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
        },
      },
      "status": "A String", # Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
      "deletionTime": "A String", # This field cannot be changed by user requests.
      "name": "A String", # A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
      "schedule": { # Transfers can be scheduled to recur or to run just once. # Schedule specification. Required.
        "scheduleStartDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The first day the recurring transfer is scheduled to run. Required.
          "month": 42, # Month of year of date. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
          "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
        },
        "startTimeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`. # The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, transfers are scheduled to start at midnight UTC.
          "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
          "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
          "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
          "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
        },
        "scheduleEndDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. # The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
          "month": 42, # Month of year of date. Must be from 1 to 12.
          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
          "year": 42, # Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
        },
      },
      "projectId": "A String", # The ID of the Google Developers Console project that owns the job. Required.
      "lastModificationTime": "A String", # This field cannot be changed by user requests.
      "creationTime": "A String", # This field cannot be changed by user requests.
      "description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
    }
google-api-python-client-1.5.5/docs/dyn/storagetransfer_v1.transferOperations.html000066400000000000000000000402441300622755700304710ustar00rootroot00000000000000

Google Storage Transfer API . transferOperations

Instance Methods

cancel(name, x__xgafv=None)

Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

delete(name, x__xgafv=None)

This method is not supported and the server returns `UNIMPLEMENTED`.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

list_next(previous_request, previous_response)

Retrieves the next page of results.

pause(name, body, x__xgafv=None)

Pauses a transfer operation.

resume(name, body, x__xgafv=None)

Resumes a transfer operation that is paused.

Method Details

cancel(name, x__xgafv=None) 
Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

Args:
  name: string, The name of the operation resource to be cancelled. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
delete(name, x__xgafv=None) 
This method is not supported and the server returns `UNIMPLEMENTED`.

Args:
  name: string, The name of the operation resource to be deleted. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None) 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Args:
  name: string, The name of the operation resource. (required)
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed and the `result` is available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
    "metadata": { # Represents the transfer operation object.
      "a_key": "", # Properties of the object. Contains field @ype with type URL.
    },
  }
list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

Args:
  name: string, The value `transferOperations`. (required)
  pageSize: integer, The standard list page size.
  filter: string, The standard list filter.
  pageToken: string, The standard list page token.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
    "operations": [ # A list of operations that matches the specified filter in the request.
      { # This resource represents a long-running operation that is the result of a network API call.
        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @ype with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed and the `result` is available.
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
        "metadata": { # Represents the transfer operation object.
          "a_key": "", # Properties of the object. Contains field @ype with type URL.
        },
      },
    ],
    "nextPageToken": "A String", # The standard List next-page token.
  }
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.
pause(name, body, x__xgafv=None) 
Pauses a transfer operation.

Args:
  name: string, The name of the transfer operation. Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request passed to PauseTransferOperation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
resume(name, body, x__xgafv=None) 
Resumes a transfer operation that is paused.

Args:
  name: string, The name of the transfer operation. Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request passed to ResumeTransferOperation.
  }

  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
google-api-python-client-1.5.5/docs/dyn/storagetransfer_v1.v1.html000066400000000000000000000052051300622755700251250ustar00rootroot00000000000000

Google Storage Transfer API . v1

Instance Methods

getGoogleServiceAccount(projectId=None, x__xgafv=None)

Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Developers Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Method Details

getGoogleServiceAccount(projectId=None, x__xgafv=None) 
Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Developers Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Args:
  projectId: string, The ID of the Google Developers Console project that the Google service account is associated with. Required.
  x__xgafv: string, V1 error format.

Returns:
  An object of the form:

    { # Google service account
    "accountEmail": "A String", # Required.
  }
google-api-python-client-1.5.5/docs/dyn/surveys_v2.html000066400000000000000000000046071300622755700231150ustar00rootroot00000000000000

Surveys API

Instance Methods

mobileapppanels()

Returns the mobileapppanels Resource.

results()

Returns the results Resource.

surveys()

Returns the surveys Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/surveys_v2.mobileapppanels.html000066400000000000000000000176751300622755700263000ustar00rootroot00000000000000

Surveys API . mobileapppanels

Instance Methods

get(panelId)

Retrieves a MobileAppPanel that is available to the authenticated user.

list(startIndex=None, maxResults=None, token=None)

Lists the MobileAppPanels available to the authenticated user.

update(panelId, body)

Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.

Method Details

get(panelId) 
Retrieves a MobileAppPanel that is available to the authenticated user.

Args:
  panelId: string, External URL ID for the panel. (required)

Returns:
  An object of the form:

    { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
    "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
      "A String",
    ],
    "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
    "name": "A String", # Human readable name of the audience panel.
    "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
    "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
    "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
  }
list(startIndex=None, maxResults=None, token=None) 
Lists the MobileAppPanels available to the authenticated user.

Args:
  startIndex: integer, A parameter
  maxResults: integer, A parameter
  token: string, A parameter

Returns:
  An object of the form:

    {
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "resources": [ # An individual predefined panel of Opinion Rewards mobile users.
      { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
        "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
          "A String",
        ],
        "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
        "name": "A String", # Human readable name of the audience panel.
        "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
        "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
        "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
      },
    ],
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
update(panelId, body) 
Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.

Args:
  panelId: string, External URL ID for the panel. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
  "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
    "A String",
  ],
  "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
  "name": "A String", # Human readable name of the audience panel.
  "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
  "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
  "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
}


Returns:
  An object of the form:

    { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
    "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
      "A String",
    ],
    "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
    "name": "A String", # Human readable name of the audience panel.
    "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
    "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
    "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
  }
google-api-python-client-1.5.5/docs/dyn/surveys_v2.results.html000066400000000000000000000052061300622755700246110ustar00rootroot00000000000000

Surveys API . results

Instance Methods

get(surveyUrlId)

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

get_media(surveyUrlId)

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Method Details

get(surveyUrlId) 
Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  An object of the form:

    { # Reference to the current results for a given survey.
    "status": "A String", # Human readable string describing the status of the request.
    "surveyUrlId": "A String", # External survey ID as viewable by survey owners in the editor view.
  }
get_media(surveyUrlId) 
Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  The media object as a string.
google-api-python-client-1.5.5/docs/dyn/surveys_v2.surveys.html000066400000000000000000002113671300622755700246370ustar00rootroot00000000000000

Surveys API . surveys

Instance Methods

delete(surveyUrlId)

Removes a survey from view in all user GET requests.

get(surveyUrlId)

Retrieves information about the specified survey.

insert(body)

Creates a survey.

list(startIndex=None, maxResults=None, token=None)

Lists the surveys owned by the authenticated user.

start(resourceId, body)

Begins running a survey.

stop(resourceId)

Stops a running survey.

update(surveyUrlId, body)

Updates a survey. Currently the only property that can be updated is the owners property.

Method Details

delete(surveyUrlId) 
Removes a survey from view in all user GET requests.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  An object of the form:

    {
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
get(surveyUrlId) 
Retrieves information about the specified survey.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)

Returns:
  An object of the form:

    { # Representation of an individual survey object.
      "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
        "A String",
      ],
      "description": "A String", # Text description of the survey.
      "title": "A String", # Optional name that will be given to the survey.
      "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
      "state": "A String", # State that the survey is in.
      "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
        "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
        "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
        "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
        "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
          "A String",
        ],
        "populationSource": "A String", # Online population source where the respondents are sampled from.
        "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
          "A String",
        ],
        "gender": "A String", # Optional gender to target.
      },
      "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
        "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
        "currencyCode": "A String", # Currency code that the cost is given in.
        "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
        "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
      },
      "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
      "questions": [ # List of questions defining the survey.
        { # Message defining the question specifications.
          "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
          "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
          "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
            "A String",
          ],
          "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
          "question": "A String", # Required question text shown to the respondent.
          "numStars": "A String", # Number of stars to use for ratings questions.
          "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
          "videoId": "A String", # The YouTube video ID to be show in video questions.
          "answers": [ # Required list of answer options for a question.
            "A String",
          ],
          "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
          "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
          "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
          "images": [
            { # Container object for image data and alt_text.
              "url": "A String", # The read-only URL for the hosted images.
              "altText": "A String", # The alt text property used in image tags is required for all images.
              "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
            },
          ],
          "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
          "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
            "A String",
          ],
          "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
          "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
          "openTextPlaceholder": "A String", # Placeholder text for an open text question.
        },
      ],
      "wantedResponseCount": 42, # Number of responses desired for the survey.
      "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
        "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
        "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
      },
    }
insert(body) 
Creates a survey.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of an individual survey object.
    "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
      "A String",
    ],
    "description": "A String", # Text description of the survey.
    "title": "A String", # Optional name that will be given to the survey.
    "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
    "state": "A String", # State that the survey is in.
    "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
      "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
      "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
      "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
      "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
        "A String",
      ],
      "populationSource": "A String", # Online population source where the respondents are sampled from.
      "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
        "A String",
      ],
      "gender": "A String", # Optional gender to target.
    },
    "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
      "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
      "currencyCode": "A String", # Currency code that the cost is given in.
      "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
      "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
    },
    "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
    "questions": [ # List of questions defining the survey.
      { # Message defining the question specifications.
        "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
        "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
        "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
          "A String",
        ],
        "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
        "question": "A String", # Required question text shown to the respondent.
        "numStars": "A String", # Number of stars to use for ratings questions.
        "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
        "videoId": "A String", # The YouTube video ID to be show in video questions.
        "answers": [ # Required list of answer options for a question.
          "A String",
        ],
        "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
        "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
        "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
        "images": [
          { # Container object for image data and alt_text.
            "url": "A String", # The read-only URL for the hosted images.
            "altText": "A String", # The alt text property used in image tags is required for all images.
            "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
          },
        ],
        "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
        "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
          "A String",
        ],
        "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
        "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
        "openTextPlaceholder": "A String", # Placeholder text for an open text question.
      },
    ],
    "wantedResponseCount": 42, # Number of responses desired for the survey.
    "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
      "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
      "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
    },
  }


Returns:
  An object of the form:

    { # Representation of an individual survey object.
      "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
        "A String",
      ],
      "description": "A String", # Text description of the survey.
      "title": "A String", # Optional name that will be given to the survey.
      "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
      "state": "A String", # State that the survey is in.
      "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
        "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
        "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
        "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
        "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
          "A String",
        ],
        "populationSource": "A String", # Online population source where the respondents are sampled from.
        "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
          "A String",
        ],
        "gender": "A String", # Optional gender to target.
      },
      "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
        "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
        "currencyCode": "A String", # Currency code that the cost is given in.
        "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
        "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
      },
      "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
      "questions": [ # List of questions defining the survey.
        { # Message defining the question specifications.
          "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
          "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
          "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
            "A String",
          ],
          "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
          "question": "A String", # Required question text shown to the respondent.
          "numStars": "A String", # Number of stars to use for ratings questions.
          "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
          "videoId": "A String", # The YouTube video ID to be show in video questions.
          "answers": [ # Required list of answer options for a question.
            "A String",
          ],
          "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
          "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
          "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
          "images": [
            { # Container object for image data and alt_text.
              "url": "A String", # The read-only URL for the hosted images.
              "altText": "A String", # The alt text property used in image tags is required for all images.
              "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
            },
          ],
          "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
          "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
            "A String",
          ],
          "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
          "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
          "openTextPlaceholder": "A String", # Placeholder text for an open text question.
        },
      ],
      "wantedResponseCount": 42, # Number of responses desired for the survey.
      "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
        "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
        "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
      },
    }
list(startIndex=None, maxResults=None, token=None) 
Lists the surveys owned by the authenticated user.

Args:
  startIndex: integer, A parameter
  maxResults: integer, A parameter
  token: string, A parameter

Returns:
  An object of the form:

    {
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "resources": [ # An individual survey resource.
      { # Representation of an individual survey object.
          "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
            "A String",
          ],
          "description": "A String", # Text description of the survey.
          "title": "A String", # Optional name that will be given to the survey.
          "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
          "state": "A String", # State that the survey is in.
          "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
            "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
            "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
            "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
            "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
              "A String",
            ],
            "populationSource": "A String", # Online population source where the respondents are sampled from.
            "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
              "A String",
            ],
            "gender": "A String", # Optional gender to target.
          },
          "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
            "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
            "currencyCode": "A String", # Currency code that the cost is given in.
            "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
            "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
          },
          "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
          "questions": [ # List of questions defining the survey.
            { # Message defining the question specifications.
              "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
              "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
              "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
                "A String",
              ],
              "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
              "question": "A String", # Required question text shown to the respondent.
              "numStars": "A String", # Number of stars to use for ratings questions.
              "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
              "videoId": "A String", # The YouTube video ID to be show in video questions.
              "answers": [ # Required list of answer options for a question.
                "A String",
              ],
              "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
              "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
              "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
              "images": [
                { # Container object for image data and alt_text.
                  "url": "A String", # The read-only URL for the hosted images.
                  "altText": "A String", # The alt text property used in image tags is required for all images.
                  "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
                },
              ],
              "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
              "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
                "A String",
              ],
              "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
              "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
              "openTextPlaceholder": "A String", # Placeholder text for an open text question.
            },
          ],
          "wantedResponseCount": 42, # Number of responses desired for the survey.
          "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
            "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
            "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
          },
        },
    ],
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
start(resourceId, body) 
Begins running a survey.

Args:
  resourceId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "maxCostPerResponseNanos": "A String", # Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details.
  }


Returns:
  An object of the form:

    {
    "resource": { # Representation of an individual survey object. # Survey object containing the specification of the started Survey.
        "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
          "A String",
        ],
        "description": "A String", # Text description of the survey.
        "title": "A String", # Optional name that will be given to the survey.
        "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
        "state": "A String", # State that the survey is in.
        "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
          "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
          "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
          "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
          "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
            "A String",
          ],
          "populationSource": "A String", # Online population source where the respondents are sampled from.
          "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
            "A String",
          ],
          "gender": "A String", # Optional gender to target.
        },
        "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
          "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
          "currencyCode": "A String", # Currency code that the cost is given in.
          "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
          "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
        },
        "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
        "questions": [ # List of questions defining the survey.
          { # Message defining the question specifications.
            "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
            "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
            "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
              "A String",
            ],
            "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
            "question": "A String", # Required question text shown to the respondent.
            "numStars": "A String", # Number of stars to use for ratings questions.
            "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
            "videoId": "A String", # The YouTube video ID to be show in video questions.
            "answers": [ # Required list of answer options for a question.
              "A String",
            ],
            "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
            "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
            "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
            "images": [
              { # Container object for image data and alt_text.
                "url": "A String", # The read-only URL for the hosted images.
                "altText": "A String", # The alt text property used in image tags is required for all images.
                "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
              },
            ],
            "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
            "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
              "A String",
            ],
            "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
            "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
            "openTextPlaceholder": "A String", # Placeholder text for an open text question.
          },
        ],
        "wantedResponseCount": 42, # Number of responses desired for the survey.
        "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
          "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
          "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
        },
      },
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
stop(resourceId) 
Stops a running survey.

Args:
  resourceId: string, A parameter (required)

Returns:
  An object of the form:

    {
    "resource": { # Representation of an individual survey object. # Survey object containing the specification of the stopped Survey.
        "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
          "A String",
        ],
        "description": "A String", # Text description of the survey.
        "title": "A String", # Optional name that will be given to the survey.
        "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
        "state": "A String", # State that the survey is in.
        "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
          "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
          "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
          "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
          "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
            "A String",
          ],
          "populationSource": "A String", # Online population source where the respondents are sampled from.
          "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
            "A String",
          ],
          "gender": "A String", # Optional gender to target.
        },
        "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
          "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
          "currencyCode": "A String", # Currency code that the cost is given in.
          "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
          "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
        },
        "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
        "questions": [ # List of questions defining the survey.
          { # Message defining the question specifications.
            "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
            "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
            "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
              "A String",
            ],
            "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
            "question": "A String", # Required question text shown to the respondent.
            "numStars": "A String", # Number of stars to use for ratings questions.
            "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
            "videoId": "A String", # The YouTube video ID to be show in video questions.
            "answers": [ # Required list of answer options for a question.
              "A String",
            ],
            "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
            "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
            "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
            "images": [
              { # Container object for image data and alt_text.
                "url": "A String", # The read-only URL for the hosted images.
                "altText": "A String", # The alt text property used in image tags is required for all images.
                "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
              },
            ],
            "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
            "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
              "A String",
            ],
            "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
            "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
            "openTextPlaceholder": "A String", # Placeholder text for an open text question.
          },
        ],
        "wantedResponseCount": 42, # Number of responses desired for the survey.
        "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
          "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
          "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
        },
      },
    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
  }
update(surveyUrlId, body) 
Updates a survey. Currently the only property that can be updated is the owners property.

Args:
  surveyUrlId: string, External URL ID for the survey. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of an individual survey object.
    "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
      "A String",
    ],
    "description": "A String", # Text description of the survey.
    "title": "A String", # Optional name that will be given to the survey.
    "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
    "state": "A String", # State that the survey is in.
    "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
      "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
      "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
      "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
      "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
        "A String",
      ],
      "populationSource": "A String", # Online population source where the respondents are sampled from.
      "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
        "A String",
      ],
      "gender": "A String", # Optional gender to target.
    },
    "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
      "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
      "currencyCode": "A String", # Currency code that the cost is given in.
      "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
      "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
    },
    "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
    "questions": [ # List of questions defining the survey.
      { # Message defining the question specifications.
        "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
        "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
        "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
          "A String",
        ],
        "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
        "question": "A String", # Required question text shown to the respondent.
        "numStars": "A String", # Number of stars to use for ratings questions.
        "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
        "videoId": "A String", # The YouTube video ID to be show in video questions.
        "answers": [ # Required list of answer options for a question.
          "A String",
        ],
        "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
        "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
        "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
        "images": [
          { # Container object for image data and alt_text.
            "url": "A String", # The read-only URL for the hosted images.
            "altText": "A String", # The alt text property used in image tags is required for all images.
            "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
          },
        ],
        "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
        "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
          "A String",
        ],
        "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
        "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
        "openTextPlaceholder": "A String", # Placeholder text for an open text question.
      },
    ],
    "wantedResponseCount": 42, # Number of responses desired for the survey.
    "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
      "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
      "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
    },
  }


Returns:
  An object of the form:

    { # Representation of an individual survey object.
      "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
        "A String",
      ],
      "description": "A String", # Text description of the survey.
      "title": "A String", # Optional name that will be given to the survey.
      "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
      "state": "A String", # State that the survey is in.
      "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
        "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
        "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
        "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
        "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
          "A String",
        ],
        "populationSource": "A String", # Online population source where the respondents are sampled from.
        "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
          "A String",
        ],
        "gender": "A String", # Optional gender to target.
      },
      "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
        "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
        "currencyCode": "A String", # Currency code that the cost is given in.
        "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
        "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
      },
      "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
      "questions": [ # List of questions defining the survey.
        { # Message defining the question specifications.
          "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
          "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
          "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
            "A String",
          ],
          "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
          "question": "A String", # Required question text shown to the respondent.
          "numStars": "A String", # Number of stars to use for ratings questions.
          "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
          "videoId": "A String", # The YouTube video ID to be show in video questions.
          "answers": [ # Required list of answer options for a question.
            "A String",
          ],
          "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
          "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
          "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
          "images": [
            { # Container object for image data and alt_text.
              "url": "A String", # The read-only URL for the hosted images.
              "altText": "A String", # The alt text property used in image tags is required for all images.
              "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
            },
          ],
          "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
          "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
            "A String",
          ],
          "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
          "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
          "openTextPlaceholder": "A String", # Placeholder text for an open text question.
        },
      ],
      "wantedResponseCount": 42, # Number of responses desired for the survey.
      "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
        "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
        "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
      },
    }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.environments.html000066400000000000000000000351001300622755700322020ustar00rootroot00000000000000

Tag Manager API . accounts . containers . environments

Instance Methods

create(accountId, containerId, body)

Creates a GTM Environment.

delete(accountId, containerId, environmentId)

Deletes a GTM Environment.

get(accountId, containerId, environmentId)

Gets a GTM Environment.

list(accountId, containerId)

Lists all GTM Environments of a GTM Container.

patch(accountId, containerId, environmentId, body, fingerprint=None)

Updates a GTM Environment. This method supports patch semantics.

update(accountId, containerId, environmentId, body, fingerprint=None)

Updates a GTM Environment.

Method Details

create(accountId, containerId, body) 
Creates a GTM Environment.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
  "authorizationCode": "A String", # The environment authorization code.
  "containerId": "A String", # GTM Container ID.
  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
  "url": "A String", # Default preview page url for the environment.
  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
  "containerVersionId": "A String",
  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
  "accountId": "A String", # GTM Account ID.
  "type": "A String", # The type of this environment.
  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
}


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
    "authorizationCode": "A String", # The environment authorization code.
    "containerId": "A String", # GTM Container ID.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "url": "A String", # Default preview page url for the environment.
    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
    "containerVersionId": "A String",
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
    "accountId": "A String", # GTM Account ID.
    "type": "A String", # The type of this environment.
    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
  }
delete(accountId, containerId, environmentId) 
Deletes a GTM Environment.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  environmentId: string, The GTM Environment ID. (required)
get(accountId, containerId, environmentId) 
Gets a GTM Environment.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  environmentId: string, The GTM Environment ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
    "authorizationCode": "A String", # The environment authorization code.
    "containerId": "A String", # GTM Container ID.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "url": "A String", # Default preview page url for the environment.
    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
    "containerVersionId": "A String",
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
    "accountId": "A String", # GTM Account ID.
    "type": "A String", # The type of this environment.
    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
  }
list(accountId, containerId) 
Lists all GTM Environments of a GTM Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)

Returns:
  An object of the form:

    { # List Environments Response.
    "environments": [ # All Environments of a GTM Container.
      { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
        "authorizationCode": "A String", # The environment authorization code.
        "containerId": "A String", # GTM Container ID.
        "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
        "url": "A String", # Default preview page url for the environment.
        "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
        "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
        "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
        "containerVersionId": "A String",
        "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
        "accountId": "A String", # GTM Account ID.
        "type": "A String", # The type of this environment.
        "description": "A String", # The environment description. Can be set or changed only on USER type environments.
      },
    ],
  }
patch(accountId, containerId, environmentId, body, fingerprint=None) 
Updates a GTM Environment. This method supports patch semantics.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  environmentId: string, The GTM Environment ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
  "authorizationCode": "A String", # The environment authorization code.
  "containerId": "A String", # GTM Container ID.
  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
  "url": "A String", # Default preview page url for the environment.
  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
  "containerVersionId": "A String",
  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
  "accountId": "A String", # GTM Account ID.
  "type": "A String", # The type of this environment.
  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the environment in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
    "authorizationCode": "A String", # The environment authorization code.
    "containerId": "A String", # GTM Container ID.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "url": "A String", # Default preview page url for the environment.
    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
    "containerVersionId": "A String",
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
    "accountId": "A String", # GTM Account ID.
    "type": "A String", # The type of this environment.
    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
  }
update(accountId, containerId, environmentId, body, fingerprint=None) 
Updates a GTM Environment.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  environmentId: string, The GTM Environment ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
  "authorizationCode": "A String", # The environment authorization code.
  "containerId": "A String", # GTM Container ID.
  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
  "url": "A String", # Default preview page url for the environment.
  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
  "containerVersionId": "A String",
  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
  "accountId": "A String", # GTM Account ID.
  "type": "A String", # The type of this environment.
  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the environment in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
    "authorizationCode": "A String", # The environment authorization code.
    "containerId": "A String", # GTM Container ID.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "url": "A String", # Default preview page url for the environment.
    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
    "containerVersionId": "A String",
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
    "accountId": "A String", # GTM Account ID.
    "type": "A String", # The type of this environment.
    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.folders.entities.html000066400000000000000000000726541300622755700327530ustar00rootroot00000000000000

Tag Manager API . accounts . containers . folders . entities

Instance Methods

list(accountId, containerId, folderId)

List all entities in a GTM Folder.

Method Details

list(accountId, containerId, folderId) 
List all entities in a GTM Folder.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  folderId: string, The GTM Folder ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Folder's contents.
    "variable": [ # The list of variables inside the folder.
      { # Represents a Google Tag Manager Variable.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
        "name": "A String", # Variable display name.
        "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
        "type": "A String", # GTM Variable Type.
        "notes": "A String", # User notes on how to apply this variable in the container.
        "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
        "accountId": "A String", # GTM Account ID.
        "parameter": [ # The variable's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
          "A String",
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "trigger": [ # The list of triggers inside the folder.
      { # Represents a Google Tag Manager Trigger
        "filter": [ # The trigger will only fire iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # Defines the data layer event that causes this trigger.
        "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Trigger display name.
        "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "autoEventFilter": [ # Used in the case of auto event tracking.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
        "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
        "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "tag": [ # The list of tags inside the folder.
      { # Represents a Google Tag Manager Tag.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
        "type": "A String", # GTM Tag Type.
        "containerId": "A String", # GTM Container ID.
        "tagFiringOption": "A String", # Option to fire this tag.
        "notes": "A String", # User notes on how to apply this tag in the container.
        "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Tag display name.
        "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "setupTag": [ # The list of setup tags. Currently we only allow one.
          {
            "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
            "tagName": "A String", # The name of the setup tag.
          },
        ],
        "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
          "A String",
        ],
        "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
        "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
        "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
          "A String",
        ],
        "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
          "A String",
        ],
        "parameter": [ # The tag's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
          "A String",
        ],
        "teardownTag": [ # The list of teardown tags. Currently we only allow one.
          {
            "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
            "tagName": "A String", # The name of the teardown tag.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.folders.html000066400000000000000000000153161300622755700311200ustar00rootroot00000000000000

Tag Manager API . accounts . containers . folders

Instance Methods

entities()

Returns the entities Resource.

create(accountId, containerId, body)

Creates a GTM Folder.

delete(accountId, containerId, folderId)

Deletes a GTM Folder.

get(accountId, containerId, folderId)

Gets a GTM Folder.

list(accountId, containerId)

Lists all GTM Folders of a Container.

update(accountId, containerId, folderId, body, fingerprint=None)

Updates a GTM Folder.

Method Details

create(accountId, containerId, body) 
Creates a GTM Folder.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Folder.
    "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
    "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
    "containerId": "A String", # GTM Container ID.
    "name": "A String", # Folder display name.
    "accountId": "A String", # GTM Account ID.
  }


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Folder.
      "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
      "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
      "containerId": "A String", # GTM Container ID.
      "name": "A String", # Folder display name.
      "accountId": "A String", # GTM Account ID.
    }
delete(accountId, containerId, folderId) 
Deletes a GTM Folder.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  folderId: string, The GTM Folder ID. (required)
get(accountId, containerId, folderId) 
Gets a GTM Folder.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  folderId: string, The GTM Folder ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Folder.
      "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
      "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
      "containerId": "A String", # GTM Container ID.
      "name": "A String", # Folder display name.
      "accountId": "A String", # GTM Account ID.
    }
list(accountId, containerId) 
Lists all GTM Folders of a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)

Returns:
  An object of the form:

    { # List Folders Response.
    "folders": [ # All GTM Folders of a GTM Container.
      { # Represents a Google Tag Manager Folder.
          "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
          "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
          "containerId": "A String", # GTM Container ID.
          "name": "A String", # Folder display name.
          "accountId": "A String", # GTM Account ID.
        },
    ],
  }
update(accountId, containerId, folderId, body, fingerprint=None) 
Updates a GTM Folder.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  folderId: string, The GTM Folder ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Folder.
    "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
    "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
    "containerId": "A String", # GTM Container ID.
    "name": "A String", # Folder display name.
    "accountId": "A String", # GTM Account ID.
  }

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the folder in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Folder.
      "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
      "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
      "containerId": "A String", # GTM Container ID.
      "name": "A String", # Folder display name.
      "accountId": "A String", # GTM Account ID.
    }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.html000066400000000000000000000317331300622755700274640ustar00rootroot00000000000000

Tag Manager API . accounts . containers

Instance Methods

environments()

Returns the environments Resource.

folders()

Returns the folders Resource.

move_folders()

Returns the move_folders Resource.

reauthorize_environments()

Returns the reauthorize_environments Resource.

tags()

Returns the tags Resource.

triggers()

Returns the triggers Resource.

variables()

Returns the variables Resource.

versions()

Returns the versions Resource.

create(accountId, body)

Creates a Container.

delete(accountId, containerId)

Deletes a Container.

get(accountId, containerId)

Gets a Container.

list(accountId)

Lists all Containers that belongs to a GTM Account.

update(accountId, containerId, body, fingerprint=None)

Updates a Container.

Method Details

create(accountId, body) 
Creates a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Container.
    "timeZoneId": "A String", # Container Time Zone ID.
    "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
      "A String",
    ],
    "timeZoneCountryId": "A String", # Container Country ID.
    "publicId": "A String", # Container Public ID.
    "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
    "domainName": [ # Optional list of domain names associated with the Container.
      "A String",
    ],
    "notes": "A String", # Container Notes.
    "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
    "accountId": "A String", # GTM Account ID.
    "name": "A String", # Container display name.
  }


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container.
      "timeZoneId": "A String", # Container Time Zone ID.
      "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
        "A String",
      ],
      "timeZoneCountryId": "A String", # Container Country ID.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # Optional list of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    }
delete(accountId, containerId) 
Deletes a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
get(accountId, containerId) 
Gets a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container.
      "timeZoneId": "A String", # Container Time Zone ID.
      "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
        "A String",
      ],
      "timeZoneCountryId": "A String", # Container Country ID.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # Optional list of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    }
list(accountId) 
Lists all Containers that belongs to a GTM Account.

Args:
  accountId: string, The GTM Account ID. (required)

Returns:
  An object of the form:

    { # List Containers Response.
    "containers": [ # All Containers of a GTM Account.
      { # Represents a Google Tag Manager Container.
          "timeZoneId": "A String", # Container Time Zone ID.
          "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
            "A String",
          ],
          "timeZoneCountryId": "A String", # Container Country ID.
          "publicId": "A String", # Container Public ID.
          "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
          "domainName": [ # Optional list of domain names associated with the Container.
            "A String",
          ],
          "notes": "A String", # Container Notes.
          "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
          "accountId": "A String", # GTM Account ID.
          "name": "A String", # Container display name.
        },
    ],
  }
update(accountId, containerId, body, fingerprint=None) 
Updates a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Container.
    "timeZoneId": "A String", # Container Time Zone ID.
    "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
      "A String",
    ],
    "timeZoneCountryId": "A String", # Container Country ID.
    "publicId": "A String", # Container Public ID.
    "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
    "domainName": [ # Optional list of domain names associated with the Container.
      "A String",
    ],
    "notes": "A String", # Container Notes.
    "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
    "accountId": "A String", # GTM Account ID.
    "name": "A String", # Container display name.
  }

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the container in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container.
      "timeZoneId": "A String", # Container Time Zone ID.
      "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
        "A String",
      ],
      "timeZoneCountryId": "A String", # Container Country ID.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # Optional list of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.move_folders.html000066400000000000000000000050101300622755700321340ustar00rootroot00000000000000

Tag Manager API . accounts . containers . move_folders

Instance Methods

update(accountId, containerId, folderId, body, variableId=None, tagId=None, triggerId=None)

Moves entities to a GTM Folder.

Method Details

update(accountId, containerId, folderId, body, variableId=None, tagId=None, triggerId=None) 
Moves entities to a GTM Folder.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  folderId: string, The GTM Folder ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Folder.
    "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
    "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
    "containerId": "A String", # GTM Container ID.
    "name": "A String", # Folder display name.
    "accountId": "A String", # GTM Account ID.
  }

  variableId: string, The variables to be moved to the folder. (repeated)
  tagId: string, The tags to be moved to the folder. (repeated)
  triggerId: string, The triggers to be moved to the folder. (repeated)
tagmanager_v1.accounts.containers.reauthorize_environments.html000066400000000000000000000105121300622755700345440ustar00rootroot00000000000000google-api-python-client-1.5.5/docs/dyn

Tag Manager API . accounts . containers . reauthorize_environments

Instance Methods

update(accountId, containerId, environmentId, body)

Re-generates the authorization code for a GTM Environment.

Method Details

update(accountId, containerId, environmentId, body) 
Re-generates the authorization code for a GTM Environment.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  environmentId: string, The GTM Environment ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
  "authorizationCode": "A String", # The environment authorization code.
  "containerId": "A String", # GTM Container ID.
  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
  "url": "A String", # Default preview page url for the environment.
  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
  "containerVersionId": "A String",
  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
  "accountId": "A String", # GTM Account ID.
  "type": "A String", # The type of this environment.
  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
}


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
    "authorizationCode": "A String", # The environment authorization code.
    "containerId": "A String", # GTM Container ID.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "url": "A String", # Default preview page url for the environment.
    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
    "containerVersionId": "A String",
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
    "accountId": "A String", # GTM Account ID.
    "type": "A String", # The type of this environment.
    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.tags.html000066400000000000000000001015101300622755700304100ustar00rootroot00000000000000

Tag Manager API . accounts . containers . tags

Instance Methods

create(accountId, containerId, body)

Creates a GTM Tag.

delete(accountId, containerId, tagId)

Deletes a GTM Tag.

get(accountId, containerId, tagId)

Gets a GTM Tag.

list(accountId, containerId)

Lists all GTM Tags of a Container.

update(accountId, containerId, tagId, body, fingerprint=None)

Updates a GTM Tag.

Method Details

create(accountId, containerId, body) 
Creates a GTM Tag.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Tag.
  "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
  "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
  "type": "A String", # GTM Tag Type.
  "containerId": "A String", # GTM Container ID.
  "tagFiringOption": "A String", # Option to fire this tag.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
  "parentFolderId": "A String", # Parent folder id.
  "name": "A String", # Tag display name.
  "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "setupTag": [ # The list of setup tags. Currently we only allow one.
    {
      "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
      "tagName": "A String", # The name of the setup tag.
    },
  ],
  "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
    "A String",
  ],
  "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
  "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
  "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
    "A String",
  ],
  "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
    "A String",
  ],
  "parameter": [ # The tag's parameters.
    { # Represents a Google Tag Manager Parameter.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
  ],
  "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
    "A String",
  ],
  "teardownTag": [ # The list of teardown tags. Currently we only allow one.
    {
      "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
      "tagName": "A String", # The name of the teardown tag.
    },
  ],
  "accountId": "A String", # GTM Account ID.
}


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Tag.
    "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
    "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
    "type": "A String", # GTM Tag Type.
    "containerId": "A String", # GTM Container ID.
    "tagFiringOption": "A String", # Option to fire this tag.
    "notes": "A String", # User notes on how to apply this tag in the container.
    "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
    "parentFolderId": "A String", # Parent folder id.
    "name": "A String", # Tag display name.
    "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "setupTag": [ # The list of setup tags. Currently we only allow one.
      {
        "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
        "tagName": "A String", # The name of the setup tag.
      },
    ],
    "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
      "A String",
    ],
    "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
    "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
    "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
      "A String",
    ],
    "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
      "A String",
    ],
    "parameter": [ # The tag's parameters.
      { # Represents a Google Tag Manager Parameter.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
    ],
    "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
      "A String",
    ],
    "teardownTag": [ # The list of teardown tags. Currently we only allow one.
      {
        "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
        "tagName": "A String", # The name of the teardown tag.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
delete(accountId, containerId, tagId) 
Deletes a GTM Tag.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  tagId: string, The GTM Tag ID. (required)
get(accountId, containerId, tagId) 
Gets a GTM Tag.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  tagId: string, The GTM Tag ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Tag.
    "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
    "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
    "type": "A String", # GTM Tag Type.
    "containerId": "A String", # GTM Container ID.
    "tagFiringOption": "A String", # Option to fire this tag.
    "notes": "A String", # User notes on how to apply this tag in the container.
    "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
    "parentFolderId": "A String", # Parent folder id.
    "name": "A String", # Tag display name.
    "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "setupTag": [ # The list of setup tags. Currently we only allow one.
      {
        "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
        "tagName": "A String", # The name of the setup tag.
      },
    ],
    "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
      "A String",
    ],
    "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
    "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
    "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
      "A String",
    ],
    "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
      "A String",
    ],
    "parameter": [ # The tag's parameters.
      { # Represents a Google Tag Manager Parameter.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
    ],
    "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
      "A String",
    ],
    "teardownTag": [ # The list of teardown tags. Currently we only allow one.
      {
        "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
        "tagName": "A String", # The name of the teardown tag.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
list(accountId, containerId) 
Lists all GTM Tags of a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)

Returns:
  An object of the form:

    { # List Tags Response.
    "tags": [ # All GTM Tags of a GTM Container.
      { # Represents a Google Tag Manager Tag.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
        "type": "A String", # GTM Tag Type.
        "containerId": "A String", # GTM Container ID.
        "tagFiringOption": "A String", # Option to fire this tag.
        "notes": "A String", # User notes on how to apply this tag in the container.
        "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Tag display name.
        "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "setupTag": [ # The list of setup tags. Currently we only allow one.
          {
            "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
            "tagName": "A String", # The name of the setup tag.
          },
        ],
        "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
          "A String",
        ],
        "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
        "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
        "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
          "A String",
        ],
        "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
          "A String",
        ],
        "parameter": [ # The tag's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
          "A String",
        ],
        "teardownTag": [ # The list of teardown tags. Currently we only allow one.
          {
            "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
            "tagName": "A String", # The name of the teardown tag.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
  }
update(accountId, containerId, tagId, body, fingerprint=None) 
Updates a GTM Tag.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  tagId: string, The GTM Tag ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Tag.
  "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
  "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
  "type": "A String", # GTM Tag Type.
  "containerId": "A String", # GTM Container ID.
  "tagFiringOption": "A String", # Option to fire this tag.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
  "parentFolderId": "A String", # Parent folder id.
  "name": "A String", # Tag display name.
  "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "setupTag": [ # The list of setup tags. Currently we only allow one.
    {
      "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
      "tagName": "A String", # The name of the setup tag.
    },
  ],
  "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
    "A String",
  ],
  "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
  "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
  "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
    "A String",
  ],
  "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
    "A String",
  ],
  "parameter": [ # The tag's parameters.
    { # Represents a Google Tag Manager Parameter.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
  ],
  "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
    "A String",
  ],
  "teardownTag": [ # The list of teardown tags. Currently we only allow one.
    {
      "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
      "tagName": "A String", # The name of the teardown tag.
    },
  ],
  "accountId": "A String", # GTM Account ID.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the tag in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Tag.
    "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
    "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
    "type": "A String", # GTM Tag Type.
    "containerId": "A String", # GTM Container ID.
    "tagFiringOption": "A String", # Option to fire this tag.
    "notes": "A String", # User notes on how to apply this tag in the container.
    "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
    "parentFolderId": "A String", # Parent folder id.
    "name": "A String", # Tag display name.
    "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "setupTag": [ # The list of setup tags. Currently we only allow one.
      {
        "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
        "tagName": "A String", # The name of the setup tag.
      },
    ],
    "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
      "A String",
    ],
    "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
    "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
    "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
      "A String",
    ],
    "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
      "A String",
    ],
    "parameter": [ # The tag's parameters.
      { # Represents a Google Tag Manager Parameter.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
    ],
    "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
      "A String",
    ],
    "teardownTag": [ # The list of teardown tags. Currently we only allow one.
      {
        "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
        "tagName": "A String", # The name of the teardown tag.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.triggers.html000066400000000000000000003475341300622755700313220ustar00rootroot00000000000000

Tag Manager API . accounts . containers . triggers

Instance Methods

create(accountId, containerId, body)

Creates a GTM Trigger.

delete(accountId, containerId, triggerId)

Deletes a GTM Trigger.

get(accountId, containerId, triggerId)

Gets a GTM Trigger.

list(accountId, containerId)

Lists all GTM Triggers of a Container.

update(accountId, containerId, triggerId, body, fingerprint=None)

Updates a GTM Trigger.

Method Details

create(accountId, containerId, body) 
Creates a GTM Trigger.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Trigger
  "filter": [ # The trigger will only fire iff all Conditions are true.
    { # Represents a predicate.
      "type": "A String", # The type of operator for this condition.
      "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
          # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
          # - At this time, the left operand (arg0) must be a reference to a variable.
          # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
          # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
    },
  ],
  "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "containerId": "A String", # GTM Container ID.
  "type": "A String", # Defines the data layer event that causes this trigger.
  "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "parentFolderId": "A String", # Parent folder id.
  "name": "A String", # Trigger display name.
  "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "autoEventFilter": [ # Used in the case of auto event tracking.
    { # Represents a predicate.
      "type": "A String", # The type of operator for this condition.
      "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
          # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
          # - At this time, the left operand (arg0) must be a reference to a variable.
          # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
          # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
    },
  ],
  "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
  "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
    { # Represents a predicate.
      "type": "A String", # The type of operator for this condition.
      "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
          # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
          # - At this time, the left operand (arg0) must be a reference to a variable.
          # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
          # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
    },
  ],
  "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
  "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "accountId": "A String", # GTM Account ID.
}


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Trigger
    "filter": [ # The trigger will only fire iff all Conditions are true.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "containerId": "A String", # GTM Container ID.
    "type": "A String", # Defines the data layer event that causes this trigger.
    "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "parentFolderId": "A String", # Parent folder id.
    "name": "A String", # Trigger display name.
    "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "autoEventFilter": [ # Used in the case of auto event tracking.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
    "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
    "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "accountId": "A String", # GTM Account ID.
  }
delete(accountId, containerId, triggerId) 
Deletes a GTM Trigger.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  triggerId: string, The GTM Trigger ID. (required)
get(accountId, containerId, triggerId) 
Gets a GTM Trigger.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  triggerId: string, The GTM Trigger ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Trigger
    "filter": [ # The trigger will only fire iff all Conditions are true.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "containerId": "A String", # GTM Container ID.
    "type": "A String", # Defines the data layer event that causes this trigger.
    "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "parentFolderId": "A String", # Parent folder id.
    "name": "A String", # Trigger display name.
    "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "autoEventFilter": [ # Used in the case of auto event tracking.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
    "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
    "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "accountId": "A String", # GTM Account ID.
  }
list(accountId, containerId) 
Lists all GTM Triggers of a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)

Returns:
  An object of the form:

    { # List triggers response.
    "triggers": [ # All GTM Triggers of a GTM Container.
      { # Represents a Google Tag Manager Trigger
        "filter": [ # The trigger will only fire iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # Defines the data layer event that causes this trigger.
        "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Trigger display name.
        "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "autoEventFilter": [ # Used in the case of auto event tracking.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
        "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
        "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "accountId": "A String", # GTM Account ID.
      },
    ],
  }
update(accountId, containerId, triggerId, body, fingerprint=None) 
Updates a GTM Trigger.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  triggerId: string, The GTM Trigger ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Trigger
  "filter": [ # The trigger will only fire iff all Conditions are true.
    { # Represents a predicate.
      "type": "A String", # The type of operator for this condition.
      "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
          # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
          # - At this time, the left operand (arg0) must be a reference to a variable.
          # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
          # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
    },
  ],
  "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "containerId": "A String", # GTM Container ID.
  "type": "A String", # Defines the data layer event that causes this trigger.
  "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "parentFolderId": "A String", # Parent folder id.
  "name": "A String", # Trigger display name.
  "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "autoEventFilter": [ # Used in the case of auto event tracking.
    { # Represents a predicate.
      "type": "A String", # The type of operator for this condition.
      "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
          # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
          # - At this time, the left operand (arg0) must be a reference to a variable.
          # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
          # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
    },
  ],
  "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
  "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
    { # Represents a predicate.
      "type": "A String", # The type of operator for this condition.
      "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
          # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
          # - At this time, the left operand (arg0) must be a reference to a variable.
          # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
          # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
    },
  ],
  "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
  "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
      # Object with schema name: Parameter
    ],
    "list": [ # This list parameter's parameters (keys will be ignored).
      # Object with schema name: Parameter
    ],
    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
    "type": "A String", # The parameter type. Valid values are:
        # - boolean: The value represents a boolean, represented as 'true' or 'false'
        # - integer: The value represents a 64-bit signed integer value, in base 10
        # - list: A list of parameters should be specified
        # - map: A map of parameters should be specified
        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  },
  "accountId": "A String", # GTM Account ID.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the trigger in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Trigger
    "filter": [ # The trigger will only fire iff all Conditions are true.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "containerId": "A String", # GTM Container ID.
    "type": "A String", # Defines the data layer event that causes this trigger.
    "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "parentFolderId": "A String", # Parent folder id.
    "name": "A String", # Trigger display name.
    "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "autoEventFilter": [ # Used in the case of auto event tracking.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
    "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
      { # Represents a predicate.
        "type": "A String", # The type of operator for this condition.
        "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
            # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
            # - At this time, the left operand (arg0) must be a reference to a variable.
            # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
            # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
      },
    ],
    "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
    "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
    "accountId": "A String", # GTM Account ID.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.variables.html000066400000000000000000000464461300622755700314420ustar00rootroot00000000000000

Tag Manager API . accounts . containers . variables

Instance Methods

create(accountId, containerId, body)

Creates a GTM Variable.

delete(accountId, containerId, variableId)

Deletes a GTM Variable.

get(accountId, containerId, variableId)

Gets a GTM Variable.

list(accountId, containerId)

Lists all GTM Variables of a Container.

update(accountId, containerId, variableId, body, fingerprint=None)

Updates a GTM Variable.

Method Details

create(accountId, containerId, body) 
Creates a GTM Variable.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Variable.
  "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
  "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
  "name": "A String", # Variable display name.
  "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
  "type": "A String", # GTM Variable Type.
  "notes": "A String", # User notes on how to apply this variable in the container.
  "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
    "A String",
  ],
  "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
  "accountId": "A String", # GTM Account ID.
  "parameter": [ # The variable's parameters.
    { # Represents a Google Tag Manager Parameter.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
    "A String",
  ],
  "containerId": "A String", # GTM Container ID.
}


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Variable.
    "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
    "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
    "name": "A String", # Variable display name.
    "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
    "type": "A String", # GTM Variable Type.
    "notes": "A String", # User notes on how to apply this variable in the container.
    "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
    "accountId": "A String", # GTM Account ID.
    "parameter": [ # The variable's parameters.
      { # Represents a Google Tag Manager Parameter.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
    ],
    "parentFolderId": "A String", # Parent folder id.
    "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
      "A String",
    ],
    "containerId": "A String", # GTM Container ID.
  }
delete(accountId, containerId, variableId) 
Deletes a GTM Variable.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  variableId: string, The GTM Variable ID. (required)
get(accountId, containerId, variableId) 
Gets a GTM Variable.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  variableId: string, The GTM Variable ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Variable.
    "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
    "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
    "name": "A String", # Variable display name.
    "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
    "type": "A String", # GTM Variable Type.
    "notes": "A String", # User notes on how to apply this variable in the container.
    "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
    "accountId": "A String", # GTM Account ID.
    "parameter": [ # The variable's parameters.
      { # Represents a Google Tag Manager Parameter.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
    ],
    "parentFolderId": "A String", # Parent folder id.
    "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
      "A String",
    ],
    "containerId": "A String", # GTM Container ID.
  }
list(accountId, containerId) 
Lists all GTM Variables of a Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)

Returns:
  An object of the form:

    { # List Variables Response.
    "variables": [ # All GTM Variables of a GTM Container.
      { # Represents a Google Tag Manager Variable.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
        "name": "A String", # Variable display name.
        "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
        "type": "A String", # GTM Variable Type.
        "notes": "A String", # User notes on how to apply this variable in the container.
        "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
        "accountId": "A String", # GTM Account ID.
        "parameter": [ # The variable's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
          "A String",
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
  }
update(accountId, containerId, variableId, body, fingerprint=None) 
Updates a GTM Variable.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  variableId: string, The GTM Variable ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Variable.
  "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
  "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
  "name": "A String", # Variable display name.
  "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
  "type": "A String", # GTM Variable Type.
  "notes": "A String", # User notes on how to apply this variable in the container.
  "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
    "A String",
  ],
  "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
  "accountId": "A String", # GTM Account ID.
  "parameter": [ # The variable's parameters.
    { # Represents a Google Tag Manager Parameter.
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "type": "A String", # The parameter type. Valid values are:
          # - boolean: The value represents a boolean, represented as 'true' or 'false'
          # - integer: The value represents a 64-bit signed integer value, in base 10
          # - list: A list of parameters should be specified
          # - map: A map of parameters should be specified
          # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
    "A String",
  ],
  "containerId": "A String", # GTM Container ID.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the variable in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Variable.
    "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
    "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
    "name": "A String", # Variable display name.
    "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
    "type": "A String", # GTM Variable Type.
    "notes": "A String", # User notes on how to apply this variable in the container.
    "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
    "accountId": "A String", # GTM Account ID.
    "parameter": [ # The variable's parameters.
      { # Represents a Google Tag Manager Parameter.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
    ],
    "parentFolderId": "A String", # Parent folder id.
    "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
      "A String",
    ],
    "containerId": "A String", # GTM Container ID.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.containers.versions.html000066400000000000000000011220551300622755700313320ustar00rootroot00000000000000

Tag Manager API . accounts . containers . versions

Instance Methods

create(accountId, containerId, body)

Creates a Container Version.

delete(accountId, containerId, containerVersionId)

Deletes a Container Version.

get(accountId, containerId, containerVersionId)

Gets a Container Version.

list(accountId, containerId, includeDeleted=None, headers=None)

Lists all Container Versions of a GTM Container.

publish(accountId, containerId, containerVersionId, fingerprint=None)

Publishes a Container Version.

restore(accountId, containerId, containerVersionId)

Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).

undelete(accountId, containerId, containerVersionId)

Undeletes a Container Version.

update(accountId, containerId, containerVersionId, body, fingerprint=None)

Updates a Container Version.

Method Details

create(accountId, containerId, body) 
Creates a Container Version.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Options for new container versions.
    "notes": "A String", # The notes of the container version to be created.
    "name": "A String", # The name of the container version to be created.
    "quickPreview": True or False, # The creation of this version may be for quick preview and shouldn't be saved.
  }


Returns:
  An object of the form:

    { # Create container versions response.
    "containerVersion": { # Represents a Google Tag Manager Container Version. # The container version created.
      "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
          "timeZoneId": "A String", # Container Time Zone ID.
          "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
            "A String",
          ],
          "timeZoneCountryId": "A String", # Container Country ID.
          "publicId": "A String", # Container Public ID.
          "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
          "domainName": [ # Optional list of domain names associated with the Container.
            "A String",
          ],
          "notes": "A String", # Container Notes.
          "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
          "accountId": "A String", # GTM Account ID.
          "name": "A String", # Container display name.
        },
      "containerId": "A String", # GTM Container ID.
      "deleted": True or False, # A value of true indicates this container version has been deleted.
      "macro": [ # The macros in the container that this version was taken from.
        { # Represents a Google Tag Manager Macro.
          "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
          "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
          "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
          "containerId": "A String", # GTM Container ID.
          "type": "A String", # GTM Macro Type.
          "notes": "A String", # User notes on how to apply this macro in the container.
          "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
            "A String",
          ],
          "name": "A String", # Macro display name.
          "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
          "parameter": [ # The macro's parameters.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
          "parentFolderId": "A String", # Parent folder id.
          "accountId": "A String", # GTM Account ID.
        },
      ],
      "notes": "A String", # User notes on how to apply this container version in the container.
      "rule": [ # The rules in the container that this version was taken from.
        { # Represents a Google Tag Manager Rule.
          "name": "A String", # Rule display name.
          "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
          "notes": "A String", # User notes on how to apply this rule in the container.
          "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
          "accountId": "A String", # GTM Account ID.
          "condition": [ # The list of conditions that make up this rule (implicit AND between them).
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "containerId": "A String", # GTM Container ID.
        },
      ],
      "name": "A String", # Container version display name.
      "tag": [ # The tags in the container that this version was taken from.
        { # Represents a Google Tag Manager Tag.
          "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
          "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
          "type": "A String", # GTM Tag Type.
          "containerId": "A String", # GTM Container ID.
          "tagFiringOption": "A String", # Option to fire this tag.
          "notes": "A String", # User notes on how to apply this tag in the container.
          "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
          "parentFolderId": "A String", # Parent folder id.
          "name": "A String", # Tag display name.
          "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "setupTag": [ # The list of setup tags. Currently we only allow one.
            {
              "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
              "tagName": "A String", # The name of the setup tag.
            },
          ],
          "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
            "A String",
          ],
          "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
          "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
          "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
            "A String",
          ],
          "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
            "A String",
          ],
          "parameter": [ # The tag's parameters.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
          "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
            "A String",
          ],
          "teardownTag": [ # The list of teardown tags. Currently we only allow one.
            {
              "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
              "tagName": "A String", # The name of the teardown tag.
            },
          ],
          "accountId": "A String", # GTM Account ID.
        },
      ],
      "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
      "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
      "variable": [ # The variables in the container that this version was taken from.
        { # Represents a Google Tag Manager Variable.
          "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
          "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
          "name": "A String", # Variable display name.
          "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
          "type": "A String", # GTM Variable Type.
          "notes": "A String", # User notes on how to apply this variable in the container.
          "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
          "accountId": "A String", # GTM Account ID.
          "parameter": [ # The variable's parameters.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
          "parentFolderId": "A String", # Parent folder id.
          "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
            "A String",
          ],
          "containerId": "A String", # GTM Container ID.
        },
      ],
      "folder": [ # The folders in the container that this version was taken from.
        { # Represents a Google Tag Manager Folder.
            "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
            "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
            "containerId": "A String", # GTM Container ID.
            "name": "A String", # Folder display name.
            "accountId": "A String", # GTM Account ID.
          },
      ],
      "trigger": [ # The triggers in the container that this version was taken from.
        { # Represents a Google Tag Manager Trigger
          "filter": [ # The trigger will only fire iff all Conditions are true.
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "containerId": "A String", # GTM Container ID.
          "type": "A String", # Defines the data layer event that causes this trigger.
          "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "parentFolderId": "A String", # Parent folder id.
          "name": "A String", # Trigger display name.
          "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "autoEventFilter": [ # Used in the case of auto event tracking.
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
          "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
          "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "accountId": "A String", # GTM Account ID.
        },
      ],
      "accountId": "A String", # GTM Account ID.
    },
    "compilerError": True or False, # Compiler errors or not.
  }
delete(accountId, containerId, containerVersionId) 
Deletes a Container Version.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  containerVersionId: string, The GTM Container Version ID. (required)
get(accountId, containerId, containerVersionId) 
Gets a Container Version.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  containerVersionId: string, The GTM Container Version ID. Specify published to retrieve the currently published version. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container Version.
    "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
        "timeZoneId": "A String", # Container Time Zone ID.
        "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
          "A String",
        ],
        "timeZoneCountryId": "A String", # Container Country ID.
        "publicId": "A String", # Container Public ID.
        "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
        "domainName": [ # Optional list of domain names associated with the Container.
          "A String",
        ],
        "notes": "A String", # Container Notes.
        "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
        "accountId": "A String", # GTM Account ID.
        "name": "A String", # Container display name.
      },
    "containerId": "A String", # GTM Container ID.
    "deleted": True or False, # A value of true indicates this container version has been deleted.
    "macro": [ # The macros in the container that this version was taken from.
      { # Represents a Google Tag Manager Macro.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
        "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # GTM Macro Type.
        "notes": "A String", # User notes on how to apply this macro in the container.
        "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "name": "A String", # Macro display name.
        "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
        "parameter": [ # The macro's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "notes": "A String", # User notes on how to apply this container version in the container.
    "rule": [ # The rules in the container that this version was taken from.
      { # Represents a Google Tag Manager Rule.
        "name": "A String", # Rule display name.
        "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
        "notes": "A String", # User notes on how to apply this rule in the container.
        "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
        "accountId": "A String", # GTM Account ID.
        "condition": [ # The list of conditions that make up this rule (implicit AND between them).
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "name": "A String", # Container version display name.
    "tag": [ # The tags in the container that this version was taken from.
      { # Represents a Google Tag Manager Tag.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
        "type": "A String", # GTM Tag Type.
        "containerId": "A String", # GTM Container ID.
        "tagFiringOption": "A String", # Option to fire this tag.
        "notes": "A String", # User notes on how to apply this tag in the container.
        "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Tag display name.
        "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "setupTag": [ # The list of setup tags. Currently we only allow one.
          {
            "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
            "tagName": "A String", # The name of the setup tag.
          },
        ],
        "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
          "A String",
        ],
        "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
        "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
        "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
          "A String",
        ],
        "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
          "A String",
        ],
        "parameter": [ # The tag's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
          "A String",
        ],
        "teardownTag": [ # The list of teardown tags. Currently we only allow one.
          {
            "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
            "tagName": "A String", # The name of the teardown tag.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
    "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
    "variable": [ # The variables in the container that this version was taken from.
      { # Represents a Google Tag Manager Variable.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
        "name": "A String", # Variable display name.
        "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
        "type": "A String", # GTM Variable Type.
        "notes": "A String", # User notes on how to apply this variable in the container.
        "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
        "accountId": "A String", # GTM Account ID.
        "parameter": [ # The variable's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
          "A String",
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "folder": [ # The folders in the container that this version was taken from.
      { # Represents a Google Tag Manager Folder.
          "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
          "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
          "containerId": "A String", # GTM Container ID.
          "name": "A String", # Folder display name.
          "accountId": "A String", # GTM Account ID.
        },
    ],
    "trigger": [ # The triggers in the container that this version was taken from.
      { # Represents a Google Tag Manager Trigger
        "filter": [ # The trigger will only fire iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # Defines the data layer event that causes this trigger.
        "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Trigger display name.
        "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "autoEventFilter": [ # Used in the case of auto event tracking.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
        "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
        "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
list(accountId, containerId, includeDeleted=None, headers=None) 
Lists all Container Versions of a GTM Container.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  includeDeleted: boolean, Also retrieve deleted (archived) versions when true.
  headers: boolean, Retrieve headers only when true.

Returns:
  An object of the form:

    { # List container versions response.
    "containerVersionHeader": [ # All container version headers of a GTM Container.
      { # Represents a Google Tag Manager Container Version Header.
        "name": "A String", # Container version display name.
        "deleted": True or False, # A value of true indicates this container version has been deleted.
        "numMacros": "A String", # Number of macros in the container version.
        "numVariables": "A String", # Number of variables in the container version.
        "numTags": "A String", # Number of tags in the container version.
        "numRules": "A String", # Number of rules in the container version.
        "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
        "numTriggers": "A String", # Number of triggers in the container version.
        "accountId": "A String", # GTM Account ID.
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "containerVersion": [ # All versions of a GTM Container.
      { # Represents a Google Tag Manager Container Version.
        "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
            "timeZoneId": "A String", # Container Time Zone ID.
            "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
              "A String",
            ],
            "timeZoneCountryId": "A String", # Container Country ID.
            "publicId": "A String", # Container Public ID.
            "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
            "domainName": [ # Optional list of domain names associated with the Container.
              "A String",
            ],
            "notes": "A String", # Container Notes.
            "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
              "A String",
            ],
            "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
            "accountId": "A String", # GTM Account ID.
            "name": "A String", # Container display name.
          },
        "containerId": "A String", # GTM Container ID.
        "deleted": True or False, # A value of true indicates this container version has been deleted.
        "macro": [ # The macros in the container that this version was taken from.
          { # Represents a Google Tag Manager Macro.
            "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
            "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
            "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
            "containerId": "A String", # GTM Container ID.
            "type": "A String", # GTM Macro Type.
            "notes": "A String", # User notes on how to apply this macro in the container.
            "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
              "A String",
            ],
            "name": "A String", # Macro display name.
            "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
              "A String",
            ],
            "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
            "parameter": [ # The macro's parameters.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
            "parentFolderId": "A String", # Parent folder id.
            "accountId": "A String", # GTM Account ID.
          },
        ],
        "notes": "A String", # User notes on how to apply this container version in the container.
        "rule": [ # The rules in the container that this version was taken from.
          { # Represents a Google Tag Manager Rule.
            "name": "A String", # Rule display name.
            "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
            "notes": "A String", # User notes on how to apply this rule in the container.
            "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
            "accountId": "A String", # GTM Account ID.
            "condition": [ # The list of conditions that make up this rule (implicit AND between them).
              { # Represents a predicate.
                "type": "A String", # The type of operator for this condition.
                "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                    # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                    # - At this time, the left operand (arg0) must be a reference to a variable.
                    # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                    # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                  { # Represents a Google Tag Manager Parameter.
                    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                      # Object with schema name: Parameter
                    ],
                    "list": [ # This list parameter's parameters (keys will be ignored).
                      # Object with schema name: Parameter
                    ],
                    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                    "type": "A String", # The parameter type. Valid values are:
                        # - boolean: The value represents a boolean, represented as 'true' or 'false'
                        # - integer: The value represents a 64-bit signed integer value, in base 10
                        # - list: A list of parameters should be specified
                        # - map: A map of parameters should be specified
                        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                  },
                ],
              },
            ],
            "containerId": "A String", # GTM Container ID.
          },
        ],
        "name": "A String", # Container version display name.
        "tag": [ # The tags in the container that this version was taken from.
          { # Represents a Google Tag Manager Tag.
            "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
            "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
            "type": "A String", # GTM Tag Type.
            "containerId": "A String", # GTM Container ID.
            "tagFiringOption": "A String", # Option to fire this tag.
            "notes": "A String", # User notes on how to apply this tag in the container.
            "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
            "parentFolderId": "A String", # Parent folder id.
            "name": "A String", # Tag display name.
            "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "setupTag": [ # The list of setup tags. Currently we only allow one.
              {
                "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
                "tagName": "A String", # The name of the setup tag.
              },
            ],
            "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
              "A String",
            ],
            "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
            "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
            "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
              "A String",
            ],
            "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
              "A String",
            ],
            "parameter": [ # The tag's parameters.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
            "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
              "A String",
            ],
            "teardownTag": [ # The list of teardown tags. Currently we only allow one.
              {
                "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
                "tagName": "A String", # The name of the teardown tag.
              },
            ],
            "accountId": "A String", # GTM Account ID.
          },
        ],
        "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
        "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
        "variable": [ # The variables in the container that this version was taken from.
          { # Represents a Google Tag Manager Variable.
            "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
            "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
            "name": "A String", # Variable display name.
            "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
            "type": "A String", # GTM Variable Type.
            "notes": "A String", # User notes on how to apply this variable in the container.
            "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
              "A String",
            ],
            "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
            "accountId": "A String", # GTM Account ID.
            "parameter": [ # The variable's parameters.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
            "parentFolderId": "A String", # Parent folder id.
            "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
              "A String",
            ],
            "containerId": "A String", # GTM Container ID.
          },
        ],
        "folder": [ # The folders in the container that this version was taken from.
          { # Represents a Google Tag Manager Folder.
              "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
              "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
              "containerId": "A String", # GTM Container ID.
              "name": "A String", # Folder display name.
              "accountId": "A String", # GTM Account ID.
            },
        ],
        "trigger": [ # The triggers in the container that this version was taken from.
          { # Represents a Google Tag Manager Trigger
            "filter": [ # The trigger will only fire iff all Conditions are true.
              { # Represents a predicate.
                "type": "A String", # The type of operator for this condition.
                "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                    # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                    # - At this time, the left operand (arg0) must be a reference to a variable.
                    # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                    # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                  { # Represents a Google Tag Manager Parameter.
                    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                      # Object with schema name: Parameter
                    ],
                    "list": [ # This list parameter's parameters (keys will be ignored).
                      # Object with schema name: Parameter
                    ],
                    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                    "type": "A String", # The parameter type. Valid values are:
                        # - boolean: The value represents a boolean, represented as 'true' or 'false'
                        # - integer: The value represents a 64-bit signed integer value, in base 10
                        # - list: A list of parameters should be specified
                        # - map: A map of parameters should be specified
                        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                  },
                ],
              },
            ],
            "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "containerId": "A String", # GTM Container ID.
            "type": "A String", # Defines the data layer event that causes this trigger.
            "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "parentFolderId": "A String", # Parent folder id.
            "name": "A String", # Trigger display name.
            "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "autoEventFilter": [ # Used in the case of auto event tracking.
              { # Represents a predicate.
                "type": "A String", # The type of operator for this condition.
                "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                    # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                    # - At this time, the left operand (arg0) must be a reference to a variable.
                    # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                    # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                  { # Represents a Google Tag Manager Parameter.
                    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                      # Object with schema name: Parameter
                    ],
                    "list": [ # This list parameter's parameters (keys will be ignored).
                      # Object with schema name: Parameter
                    ],
                    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                    "type": "A String", # The parameter type. Valid values are:
                        # - boolean: The value represents a boolean, represented as 'true' or 'false'
                        # - integer: The value represents a 64-bit signed integer value, in base 10
                        # - list: A list of parameters should be specified
                        # - map: A map of parameters should be specified
                        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                  },
                ],
              },
            ],
            "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
            "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
              { # Represents a predicate.
                "type": "A String", # The type of operator for this condition.
                "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                    # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                    # - At this time, the left operand (arg0) must be a reference to a variable.
                    # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                    # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                  { # Represents a Google Tag Manager Parameter.
                    "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                      # Object with schema name: Parameter
                    ],
                    "list": [ # This list parameter's parameters (keys will be ignored).
                      # Object with schema name: Parameter
                    ],
                    "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                    "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                    "type": "A String", # The parameter type. Valid values are:
                        # - boolean: The value represents a boolean, represented as 'true' or 'false'
                        # - integer: The value represents a 64-bit signed integer value, in base 10
                        # - list: A list of parameters should be specified
                        # - map: A map of parameters should be specified
                        # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                  },
                ],
              },
            ],
            "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
            "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
            "accountId": "A String", # GTM Account ID.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
  }
publish(accountId, containerId, containerVersionId, fingerprint=None) 
Publishes a Container Version.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  containerVersionId: string, The GTM Container Version ID. (required)
  fingerprint: string, When provided, this fingerprint must match the fingerprint of the container version in storage.

Returns:
  An object of the form:

    { # Publish container version response.
    "containerVersion": { # Represents a Google Tag Manager Container Version. # The container version created.
      "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
          "timeZoneId": "A String", # Container Time Zone ID.
          "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
            "A String",
          ],
          "timeZoneCountryId": "A String", # Container Country ID.
          "publicId": "A String", # Container Public ID.
          "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
          "domainName": [ # Optional list of domain names associated with the Container.
            "A String",
          ],
          "notes": "A String", # Container Notes.
          "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
          "accountId": "A String", # GTM Account ID.
          "name": "A String", # Container display name.
        },
      "containerId": "A String", # GTM Container ID.
      "deleted": True or False, # A value of true indicates this container version has been deleted.
      "macro": [ # The macros in the container that this version was taken from.
        { # Represents a Google Tag Manager Macro.
          "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
          "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
          "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
          "containerId": "A String", # GTM Container ID.
          "type": "A String", # GTM Macro Type.
          "notes": "A String", # User notes on how to apply this macro in the container.
          "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
            "A String",
          ],
          "name": "A String", # Macro display name.
          "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
          "parameter": [ # The macro's parameters.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
          "parentFolderId": "A String", # Parent folder id.
          "accountId": "A String", # GTM Account ID.
        },
      ],
      "notes": "A String", # User notes on how to apply this container version in the container.
      "rule": [ # The rules in the container that this version was taken from.
        { # Represents a Google Tag Manager Rule.
          "name": "A String", # Rule display name.
          "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
          "notes": "A String", # User notes on how to apply this rule in the container.
          "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
          "accountId": "A String", # GTM Account ID.
          "condition": [ # The list of conditions that make up this rule (implicit AND between them).
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "containerId": "A String", # GTM Container ID.
        },
      ],
      "name": "A String", # Container version display name.
      "tag": [ # The tags in the container that this version was taken from.
        { # Represents a Google Tag Manager Tag.
          "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
          "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
          "type": "A String", # GTM Tag Type.
          "containerId": "A String", # GTM Container ID.
          "tagFiringOption": "A String", # Option to fire this tag.
          "notes": "A String", # User notes on how to apply this tag in the container.
          "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
          "parentFolderId": "A String", # Parent folder id.
          "name": "A String", # Tag display name.
          "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "setupTag": [ # The list of setup tags. Currently we only allow one.
            {
              "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
              "tagName": "A String", # The name of the setup tag.
            },
          ],
          "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
            "A String",
          ],
          "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
          "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
          "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
            "A String",
          ],
          "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
            "A String",
          ],
          "parameter": [ # The tag's parameters.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
          "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
            "A String",
          ],
          "teardownTag": [ # The list of teardown tags. Currently we only allow one.
            {
              "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
              "tagName": "A String", # The name of the teardown tag.
            },
          ],
          "accountId": "A String", # GTM Account ID.
        },
      ],
      "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
      "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
      "variable": [ # The variables in the container that this version was taken from.
        { # Represents a Google Tag Manager Variable.
          "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
          "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
          "name": "A String", # Variable display name.
          "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
          "type": "A String", # GTM Variable Type.
          "notes": "A String", # User notes on how to apply this variable in the container.
          "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
          "accountId": "A String", # GTM Account ID.
          "parameter": [ # The variable's parameters.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
          "parentFolderId": "A String", # Parent folder id.
          "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
            "A String",
          ],
          "containerId": "A String", # GTM Container ID.
        },
      ],
      "folder": [ # The folders in the container that this version was taken from.
        { # Represents a Google Tag Manager Folder.
            "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
            "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
            "containerId": "A String", # GTM Container ID.
            "name": "A String", # Folder display name.
            "accountId": "A String", # GTM Account ID.
          },
      ],
      "trigger": [ # The triggers in the container that this version was taken from.
        { # Represents a Google Tag Manager Trigger
          "filter": [ # The trigger will only fire iff all Conditions are true.
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "containerId": "A String", # GTM Container ID.
          "type": "A String", # Defines the data layer event that causes this trigger.
          "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "parentFolderId": "A String", # Parent folder id.
          "name": "A String", # Trigger display name.
          "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "autoEventFilter": [ # Used in the case of auto event tracking.
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
          "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
            { # Represents a predicate.
              "type": "A String", # The type of operator for this condition.
              "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                  # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                  # - At this time, the left operand (arg0) must be a reference to a variable.
                  # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                  # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
                { # Represents a Google Tag Manager Parameter.
                  "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                    # Object with schema name: Parameter
                  ],
                  "list": [ # This list parameter's parameters (keys will be ignored).
                    # Object with schema name: Parameter
                  ],
                  "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                  "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                  "type": "A String", # The parameter type. Valid values are:
                      # - boolean: The value represents a boolean, represented as 'true' or 'false'
                      # - integer: The value represents a 64-bit signed integer value, in base 10
                      # - list: A list of parameters should be specified
                      # - map: A map of parameters should be specified
                      # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
                },
              ],
            },
          ],
          "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
          "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
          "accountId": "A String", # GTM Account ID.
        },
      ],
      "accountId": "A String", # GTM Account ID.
    },
    "compilerError": True or False, # Compiler errors or not.
  }
restore(accountId, containerId, containerVersionId) 
Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  containerVersionId: string, The GTM Container Version ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container Version.
    "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
        "timeZoneId": "A String", # Container Time Zone ID.
        "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
          "A String",
        ],
        "timeZoneCountryId": "A String", # Container Country ID.
        "publicId": "A String", # Container Public ID.
        "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
        "domainName": [ # Optional list of domain names associated with the Container.
          "A String",
        ],
        "notes": "A String", # Container Notes.
        "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
        "accountId": "A String", # GTM Account ID.
        "name": "A String", # Container display name.
      },
    "containerId": "A String", # GTM Container ID.
    "deleted": True or False, # A value of true indicates this container version has been deleted.
    "macro": [ # The macros in the container that this version was taken from.
      { # Represents a Google Tag Manager Macro.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
        "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # GTM Macro Type.
        "notes": "A String", # User notes on how to apply this macro in the container.
        "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "name": "A String", # Macro display name.
        "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
        "parameter": [ # The macro's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "notes": "A String", # User notes on how to apply this container version in the container.
    "rule": [ # The rules in the container that this version was taken from.
      { # Represents a Google Tag Manager Rule.
        "name": "A String", # Rule display name.
        "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
        "notes": "A String", # User notes on how to apply this rule in the container.
        "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
        "accountId": "A String", # GTM Account ID.
        "condition": [ # The list of conditions that make up this rule (implicit AND between them).
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "name": "A String", # Container version display name.
    "tag": [ # The tags in the container that this version was taken from.
      { # Represents a Google Tag Manager Tag.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
        "type": "A String", # GTM Tag Type.
        "containerId": "A String", # GTM Container ID.
        "tagFiringOption": "A String", # Option to fire this tag.
        "notes": "A String", # User notes on how to apply this tag in the container.
        "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Tag display name.
        "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "setupTag": [ # The list of setup tags. Currently we only allow one.
          {
            "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
            "tagName": "A String", # The name of the setup tag.
          },
        ],
        "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
          "A String",
        ],
        "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
        "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
        "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
          "A String",
        ],
        "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
          "A String",
        ],
        "parameter": [ # The tag's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
          "A String",
        ],
        "teardownTag": [ # The list of teardown tags. Currently we only allow one.
          {
            "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
            "tagName": "A String", # The name of the teardown tag.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
    "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
    "variable": [ # The variables in the container that this version was taken from.
      { # Represents a Google Tag Manager Variable.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
        "name": "A String", # Variable display name.
        "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
        "type": "A String", # GTM Variable Type.
        "notes": "A String", # User notes on how to apply this variable in the container.
        "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
        "accountId": "A String", # GTM Account ID.
        "parameter": [ # The variable's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
          "A String",
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "folder": [ # The folders in the container that this version was taken from.
      { # Represents a Google Tag Manager Folder.
          "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
          "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
          "containerId": "A String", # GTM Container ID.
          "name": "A String", # Folder display name.
          "accountId": "A String", # GTM Account ID.
        },
    ],
    "trigger": [ # The triggers in the container that this version was taken from.
      { # Represents a Google Tag Manager Trigger
        "filter": [ # The trigger will only fire iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # Defines the data layer event that causes this trigger.
        "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Trigger display name.
        "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "autoEventFilter": [ # Used in the case of auto event tracking.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
        "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
        "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
undelete(accountId, containerId, containerVersionId) 
Undeletes a Container Version.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  containerVersionId: string, The GTM Container Version ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container Version.
    "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
        "timeZoneId": "A String", # Container Time Zone ID.
        "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
          "A String",
        ],
        "timeZoneCountryId": "A String", # Container Country ID.
        "publicId": "A String", # Container Public ID.
        "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
        "domainName": [ # Optional list of domain names associated with the Container.
          "A String",
        ],
        "notes": "A String", # Container Notes.
        "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
        "accountId": "A String", # GTM Account ID.
        "name": "A String", # Container display name.
      },
    "containerId": "A String", # GTM Container ID.
    "deleted": True or False, # A value of true indicates this container version has been deleted.
    "macro": [ # The macros in the container that this version was taken from.
      { # Represents a Google Tag Manager Macro.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
        "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # GTM Macro Type.
        "notes": "A String", # User notes on how to apply this macro in the container.
        "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "name": "A String", # Macro display name.
        "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
        "parameter": [ # The macro's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "notes": "A String", # User notes on how to apply this container version in the container.
    "rule": [ # The rules in the container that this version was taken from.
      { # Represents a Google Tag Manager Rule.
        "name": "A String", # Rule display name.
        "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
        "notes": "A String", # User notes on how to apply this rule in the container.
        "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
        "accountId": "A String", # GTM Account ID.
        "condition": [ # The list of conditions that make up this rule (implicit AND between them).
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "name": "A String", # Container version display name.
    "tag": [ # The tags in the container that this version was taken from.
      { # Represents a Google Tag Manager Tag.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
        "type": "A String", # GTM Tag Type.
        "containerId": "A String", # GTM Container ID.
        "tagFiringOption": "A String", # Option to fire this tag.
        "notes": "A String", # User notes on how to apply this tag in the container.
        "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Tag display name.
        "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "setupTag": [ # The list of setup tags. Currently we only allow one.
          {
            "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
            "tagName": "A String", # The name of the setup tag.
          },
        ],
        "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
          "A String",
        ],
        "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
        "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
        "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
          "A String",
        ],
        "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
          "A String",
        ],
        "parameter": [ # The tag's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
          "A String",
        ],
        "teardownTag": [ # The list of teardown tags. Currently we only allow one.
          {
            "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
            "tagName": "A String", # The name of the teardown tag.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
    "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
    "variable": [ # The variables in the container that this version was taken from.
      { # Represents a Google Tag Manager Variable.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
        "name": "A String", # Variable display name.
        "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
        "type": "A String", # GTM Variable Type.
        "notes": "A String", # User notes on how to apply this variable in the container.
        "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
        "accountId": "A String", # GTM Account ID.
        "parameter": [ # The variable's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
          "A String",
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "folder": [ # The folders in the container that this version was taken from.
      { # Represents a Google Tag Manager Folder.
          "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
          "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
          "containerId": "A String", # GTM Container ID.
          "name": "A String", # Folder display name.
          "accountId": "A String", # GTM Account ID.
        },
    ],
    "trigger": [ # The triggers in the container that this version was taken from.
      { # Represents a Google Tag Manager Trigger
        "filter": [ # The trigger will only fire iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # Defines the data layer event that causes this trigger.
        "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Trigger display name.
        "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "autoEventFilter": [ # Used in the case of auto event tracking.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
        "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
        "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
update(accountId, containerId, containerVersionId, body, fingerprint=None) 
Updates a Container Version.

Args:
  accountId: string, The GTM Account ID. (required)
  containerId: string, The GTM Container ID. (required)
  containerVersionId: string, The GTM Container Version ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Container Version.
  "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
      "timeZoneId": "A String", # Container Time Zone ID.
      "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
        "A String",
      ],
      "timeZoneCountryId": "A String", # Container Country ID.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # Optional list of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    },
  "containerId": "A String", # GTM Container ID.
  "deleted": True or False, # A value of true indicates this container version has been deleted.
  "macro": [ # The macros in the container that this version was taken from.
    { # Represents a Google Tag Manager Macro.
      "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
      "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
      "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
      "containerId": "A String", # GTM Container ID.
      "type": "A String", # GTM Macro Type.
      "notes": "A String", # User notes on how to apply this macro in the container.
      "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
        "A String",
      ],
      "name": "A String", # Macro display name.
      "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
      "parameter": [ # The macro's parameters.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
      "parentFolderId": "A String", # Parent folder id.
      "accountId": "A String", # GTM Account ID.
    },
  ],
  "notes": "A String", # User notes on how to apply this container version in the container.
  "rule": [ # The rules in the container that this version was taken from.
    { # Represents a Google Tag Manager Rule.
      "name": "A String", # Rule display name.
      "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
      "notes": "A String", # User notes on how to apply this rule in the container.
      "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
      "accountId": "A String", # GTM Account ID.
      "condition": [ # The list of conditions that make up this rule (implicit AND between them).
        { # Represents a predicate.
          "type": "A String", # The type of operator for this condition.
          "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
              # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
              # - At this time, the left operand (arg0) must be a reference to a variable.
              # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
              # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
        },
      ],
      "containerId": "A String", # GTM Container ID.
    },
  ],
  "name": "A String", # Container version display name.
  "tag": [ # The tags in the container that this version was taken from.
    { # Represents a Google Tag Manager Tag.
      "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
      "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
      "type": "A String", # GTM Tag Type.
      "containerId": "A String", # GTM Container ID.
      "tagFiringOption": "A String", # Option to fire this tag.
      "notes": "A String", # User notes on how to apply this tag in the container.
      "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
      "parentFolderId": "A String", # Parent folder id.
      "name": "A String", # Tag display name.
      "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "setupTag": [ # The list of setup tags. Currently we only allow one.
        {
          "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
          "tagName": "A String", # The name of the setup tag.
        },
      ],
      "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
        "A String",
      ],
      "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
      "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
      "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
        "A String",
      ],
      "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
        "A String",
      ],
      "parameter": [ # The tag's parameters.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
      "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
        "A String",
      ],
      "teardownTag": [ # The list of teardown tags. Currently we only allow one.
        {
          "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
          "tagName": "A String", # The name of the teardown tag.
        },
      ],
      "accountId": "A String", # GTM Account ID.
    },
  ],
  "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
  "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
  "variable": [ # The variables in the container that this version was taken from.
    { # Represents a Google Tag Manager Variable.
      "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
      "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
      "name": "A String", # Variable display name.
      "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
      "type": "A String", # GTM Variable Type.
      "notes": "A String", # User notes on how to apply this variable in the container.
      "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
      "accountId": "A String", # GTM Account ID.
      "parameter": [ # The variable's parameters.
        { # Represents a Google Tag Manager Parameter.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
      ],
      "parentFolderId": "A String", # Parent folder id.
      "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
        "A String",
      ],
      "containerId": "A String", # GTM Container ID.
    },
  ],
  "folder": [ # The folders in the container that this version was taken from.
    { # Represents a Google Tag Manager Folder.
        "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
        "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
        "containerId": "A String", # GTM Container ID.
        "name": "A String", # Folder display name.
        "accountId": "A String", # GTM Account ID.
      },
  ],
  "trigger": [ # The triggers in the container that this version was taken from.
    { # Represents a Google Tag Manager Trigger
      "filter": [ # The trigger will only fire iff all Conditions are true.
        { # Represents a predicate.
          "type": "A String", # The type of operator for this condition.
          "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
              # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
              # - At this time, the left operand (arg0) must be a reference to a variable.
              # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
              # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
        },
      ],
      "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "containerId": "A String", # GTM Container ID.
      "type": "A String", # Defines the data layer event that causes this trigger.
      "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "parentFolderId": "A String", # Parent folder id.
      "name": "A String", # Trigger display name.
      "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "autoEventFilter": [ # Used in the case of auto event tracking.
        { # Represents a predicate.
          "type": "A String", # The type of operator for this condition.
          "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
              # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
              # - At this time, the left operand (arg0) must be a reference to a variable.
              # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
              # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
        },
      ],
      "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
      "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
        { # Represents a predicate.
          "type": "A String", # The type of operator for this condition.
          "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
              # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
              # - At this time, the left operand (arg0) must be a reference to a variable.
              # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
              # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
            { # Represents a Google Tag Manager Parameter.
              "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                # Object with schema name: Parameter
              ],
              "list": [ # This list parameter's parameters (keys will be ignored).
                # Object with schema name: Parameter
              ],
              "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
              "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
              "type": "A String", # The parameter type. Valid values are:
                  # - boolean: The value represents a boolean, represented as 'true' or 'false'
                  # - integer: The value represents a 64-bit signed integer value, in base 10
                  # - list: A list of parameters should be specified
                  # - map: A map of parameters should be specified
                  # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
            },
          ],
        },
      ],
      "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
      "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "type": "A String", # The parameter type. Valid values are:
            # - boolean: The value represents a boolean, represented as 'true' or 'false'
            # - integer: The value represents a 64-bit signed integer value, in base 10
            # - list: A list of parameters should be specified
            # - map: A map of parameters should be specified
            # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
      },
      "accountId": "A String", # GTM Account ID.
    },
  ],
  "accountId": "A String", # GTM Account ID.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the container version in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container Version.
    "container": { # Represents a Google Tag Manager Container. # The container that this version was taken from.
        "timeZoneId": "A String", # Container Time Zone ID.
        "enabledBuiltInVariable": [ # List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.
          "A String",
        ],
        "timeZoneCountryId": "A String", # Container Country ID.
        "publicId": "A String", # Container Public ID.
        "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
        "domainName": [ # Optional list of domain names associated with the Container.
          "A String",
        ],
        "notes": "A String", # Container Notes.
        "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, ios.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
        "accountId": "A String", # GTM Account ID.
        "name": "A String", # Container display name.
      },
    "containerId": "A String", # GTM Container ID.
    "deleted": True or False, # A value of true indicates this container version has been deleted.
    "macro": [ # The macros in the container that this version was taken from.
      { # Represents a Google Tag Manager Macro.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
        "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # GTM Macro Type.
        "notes": "A String", # User notes on how to apply this macro in the container.
        "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "name": "A String", # Macro display name.
        "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
        "parameter": [ # The macro's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "notes": "A String", # User notes on how to apply this container version in the container.
    "rule": [ # The rules in the container that this version was taken from.
      { # Represents a Google Tag Manager Rule.
        "name": "A String", # Rule display name.
        "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
        "notes": "A String", # User notes on how to apply this rule in the container.
        "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
        "accountId": "A String", # GTM Account ID.
        "condition": [ # The list of conditions that make up this rule (implicit AND between them).
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "name": "A String", # Container version display name.
    "tag": [ # The tags in the container that this version was taken from.
      { # Represents a Google Tag Manager Tag.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
        "type": "A String", # GTM Tag Type.
        "containerId": "A String", # GTM Container ID.
        "tagFiringOption": "A String", # Option to fire this tag.
        "notes": "A String", # User notes on how to apply this tag in the container.
        "tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Tag display name.
        "priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "setupTag": [ # The list of setup tags. Currently we only allow one.
          {
            "stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
            "tagName": "A String", # The name of the setup tag.
          },
        ],
        "blockingRuleId": [ # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.
          "A String",
        ],
        "liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
        "fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
        "firingRuleId": [ # Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.
          "A String",
        ],
        "firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
          "A String",
        ],
        "parameter": [ # The tag's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
          "A String",
        ],
        "teardownTag": [ # The list of teardown tags. Currently we only allow one.
          {
            "stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
            "tagName": "A String", # The name of the teardown tag.
          },
        ],
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "containerVersionId": "A String", # The Container Version ID uniquely identifies the GTM Container Version.
    "fingerprint": "A String", # The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
    "variable": [ # The variables in the container that this version was taken from.
      { # Represents a Google Tag Manager Variable.
        "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
        "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
        "name": "A String", # Variable display name.
        "variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
        "type": "A String", # GTM Variable Type.
        "notes": "A String", # User notes on how to apply this variable in the container.
        "enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
          "A String",
        ],
        "fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
        "accountId": "A String", # GTM Account ID.
        "parameter": [ # The variable's parameters.
          { # Represents a Google Tag Manager Parameter.
            "map": [ # This map parameter's parameters (must have keys; keys must be unique).
              # Object with schema name: Parameter
            ],
            "list": [ # This list parameter's parameters (keys will be ignored).
              # Object with schema name: Parameter
            ],
            "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
            "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
            "type": "A String", # The parameter type. Valid values are:
                # - boolean: The value represents a boolean, represented as 'true' or 'false'
                # - integer: The value represents a 64-bit signed integer value, in base 10
                # - list: A list of parameters should be specified
                # - map: A map of parameters should be specified
                # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
          },
        ],
        "parentFolderId": "A String", # Parent folder id.
        "disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
          "A String",
        ],
        "containerId": "A String", # GTM Container ID.
      },
    ],
    "folder": [ # The folders in the container that this version was taken from.
      { # Represents a Google Tag Manager Folder.
          "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
          "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
          "containerId": "A String", # GTM Container ID.
          "name": "A String", # Folder display name.
          "accountId": "A String", # GTM Account ID.
        },
    ],
    "trigger": [ # The triggers in the container that this version was taken from.
      { # Represents a Google Tag Manager Trigger
        "filter": [ # The trigger will only fire iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "videoPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values. The trigger will fire as each percentage is reached in any instrumented videos. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "containerId": "A String", # GTM Container ID.
        "type": "A String", # Defines the data layer event that causes this trigger.
        "interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "parentFolderId": "A String", # Parent folder id.
        "name": "A String", # Trigger display name.
        "eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "autoEventFilter": [ # Used in the case of auto event tracking.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
        "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
          { # Represents a predicate.
            "type": "A String", # The type of operator for this condition.
            "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
                # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
                # - At this time, the left operand (arg0) must be a reference to a variable.
                # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
                # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
              { # Represents a Google Tag Manager Parameter.
                "map": [ # This map parameter's parameters (must have keys; keys must be unique).
                  # Object with schema name: Parameter
                ],
                "list": [ # This list parameter's parameters (keys will be ignored).
                  # Object with schema name: Parameter
                ],
                "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
                "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
                "type": "A String", # The parameter type. Valid values are:
                    # - boolean: The value represents a boolean, represented as 'true' or 'false'
                    # - integer: The value represents a 64-bit signed integer value, in base 10
                    # - list: A list of parameters should be specified
                    # - map: A map of parameters should be specified
                    # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
              },
            ],
          },
        ],
        "triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
        "enableAllVideos": { # Represents a Google Tag Manager Parameter. # Reloads the videos in the page that don't already have the YT API enabled. If false, only capture events from videos that already have the API enabled. Only valid for YouTube triggers.
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "type": "A String", # The parameter type. Valid values are:
              # - boolean: The value represents a boolean, represented as 'true' or 'false'
              # - integer: The value represents a 64-bit signed integer value, in base 10
              # - list: A list of parameters should be specified
              # - map: A map of parameters should be specified
              # - template: The value represents any text; this can include variable references (even variable references that might return non-string types)
        },
        "accountId": "A String", # GTM Account ID.
      },
    ],
    "accountId": "A String", # GTM Account ID.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.html000066400000000000000000000107671300622755700253240ustar00rootroot00000000000000

Tag Manager API . accounts

Instance Methods

containers()

Returns the containers Resource.

permissions()

Returns the permissions Resource.

get(accountId)

Gets a GTM Account.

list()

Lists all GTM Accounts that a user has access to.

update(accountId, body, fingerprint=None)

Updates a GTM Account.

Method Details

get(accountId) 
Gets a GTM Account.

Args:
  accountId: string, The GTM Account ID. (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Account.
    "shareData": True or False, # Whether the account shares data anonymously with Google and others.
    "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
    "name": "A String", # Account display name.
    "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
  }
list() 
Lists all GTM Accounts that a user has access to.

Args:

Returns:
  An object of the form:

    { # List Accounts Response.
    "accounts": [ # List of GTM Accounts that a user has access to.
      { # Represents a Google Tag Manager Account.
        "shareData": True or False, # Whether the account shares data anonymously with Google and others.
        "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
        "name": "A String", # Account display name.
        "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
      },
    ],
  }
update(accountId, body, fingerprint=None) 
Updates a GTM Account.

Args:
  accountId: string, The GTM Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Account.
  "shareData": True or False, # Whether the account shares data anonymously with Google and others.
  "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
  "name": "A String", # Account display name.
  "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the account in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Account.
    "shareData": True or False, # Whether the account shares data anonymously with Google and others.
    "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
    "name": "A String", # Account display name.
    "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
  }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.accounts.permissions.html000066400000000000000000000217751300622755700276770ustar00rootroot00000000000000

Tag Manager API . accounts . permissions

Instance Methods

create(accountId, body)

Creates a user's Account & Container Permissions.

delete(accountId, permissionId)

Removes a user from the account, revoking access to it and all of its containers.

get(accountId, permissionId)

Gets a user's Account & Container Permissions.

list(accountId)

List all users that have access to the account along with Account and Container Permissions granted to each of them.

update(accountId, permissionId, body)

Updates a user's Account & Container Permissions.

Method Details

create(accountId, body) 
Creates a user's Account & Container Permissions.

Args:
  accountId: string, The GTM Account ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a user's permissions to an account and its container.
    "containerAccess": [ # GTM Container access permissions.
      { # Defines the Google Tag Manager Container access permissions.
        "containerId": "A String", # GTM Container ID.
        "permission": [ # List of Container permissions. Valid container permissions are: read, edit, delete, publish.
          "A String",
        ],
      },
    ],
    "accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions.
      "permission": [ # List of Account permissions. Valid account permissions are read and manage.
        "A String",
      ],
    },
    "emailAddress": "A String", # User's email address.
    "permissionId": "A String", # Account Permission ID.
    "accountId": "A String", # GTM Account ID.
  }


Returns:
  An object of the form:

    { # Represents a user's permissions to an account and its container.
      "containerAccess": [ # GTM Container access permissions.
        { # Defines the Google Tag Manager Container access permissions.
          "containerId": "A String", # GTM Container ID.
          "permission": [ # List of Container permissions. Valid container permissions are: read, edit, delete, publish.
            "A String",
          ],
        },
      ],
      "accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions.
        "permission": [ # List of Account permissions. Valid account permissions are read and manage.
          "A String",
        ],
      },
      "emailAddress": "A String", # User's email address.
      "permissionId": "A String", # Account Permission ID.
      "accountId": "A String", # GTM Account ID.
    }
delete(accountId, permissionId) 
Removes a user from the account, revoking access to it and all of its containers.

Args:
  accountId: string, The GTM Account ID. (required)
  permissionId: string, The GTM User ID. (required)
get(accountId, permissionId) 
Gets a user's Account & Container Permissions.

Args:
  accountId: string, The GTM Account ID. (required)
  permissionId: string, The GTM User ID. (required)

Returns:
  An object of the form:

    { # Represents a user's permissions to an account and its container.
      "containerAccess": [ # GTM Container access permissions.
        { # Defines the Google Tag Manager Container access permissions.
          "containerId": "A String", # GTM Container ID.
          "permission": [ # List of Container permissions. Valid container permissions are: read, edit, delete, publish.
            "A String",
          ],
        },
      ],
      "accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions.
        "permission": [ # List of Account permissions. Valid account permissions are read and manage.
          "A String",
        ],
      },
      "emailAddress": "A String", # User's email address.
      "permissionId": "A String", # Account Permission ID.
      "accountId": "A String", # GTM Account ID.
    }
list(accountId) 
List all users that have access to the account along with Account and Container Permissions granted to each of them.

Args:
  accountId: string, The GTM Account ID. @required tagmanager.accounts.permissions.list (required)

Returns:
  An object of the form:

    { # List AccountUsers Response.
    "userAccess": [ # All GTM AccountUsers of a GTM Account.
      { # Represents a user's permissions to an account and its container.
          "containerAccess": [ # GTM Container access permissions.
            { # Defines the Google Tag Manager Container access permissions.
              "containerId": "A String", # GTM Container ID.
              "permission": [ # List of Container permissions. Valid container permissions are: read, edit, delete, publish.
                "A String",
              ],
            },
          ],
          "accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions.
            "permission": [ # List of Account permissions. Valid account permissions are read and manage.
              "A String",
            ],
          },
          "emailAddress": "A String", # User's email address.
          "permissionId": "A String", # Account Permission ID.
          "accountId": "A String", # GTM Account ID.
        },
    ],
  }
update(accountId, permissionId, body) 
Updates a user's Account & Container Permissions.

Args:
  accountId: string, The GTM Account ID. (required)
  permissionId: string, The GTM User ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a user's permissions to an account and its container.
    "containerAccess": [ # GTM Container access permissions.
      { # Defines the Google Tag Manager Container access permissions.
        "containerId": "A String", # GTM Container ID.
        "permission": [ # List of Container permissions. Valid container permissions are: read, edit, delete, publish.
          "A String",
        ],
      },
    ],
    "accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions.
      "permission": [ # List of Account permissions. Valid account permissions are read and manage.
        "A String",
      ],
    },
    "emailAddress": "A String", # User's email address.
    "permissionId": "A String", # Account Permission ID.
    "accountId": "A String", # GTM Account ID.
  }


Returns:
  An object of the form:

    { # Represents a user's permissions to an account and its container.
      "containerAccess": [ # GTM Container access permissions.
        { # Defines the Google Tag Manager Container access permissions.
          "containerId": "A String", # GTM Container ID.
          "permission": [ # List of Container permissions. Valid container permissions are: read, edit, delete, publish.
            "A String",
          ],
        },
      ],
      "accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions.
        "permission": [ # List of Account permissions. Valid account permissions are read and manage.
          "A String",
        ],
      },
      "emailAddress": "A String", # User's email address.
      "permissionId": "A String", # Account Permission ID.
      "accountId": "A String", # GTM Account ID.
    }
google-api-python-client-1.5.5/docs/dyn/tagmanager_v1.html000066400000000000000000000041241300622755700234740ustar00rootroot00000000000000

Tag Manager API

Instance Methods

accounts()

Returns the accounts Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/taskqueue_v1beta1.html000066400000000000000000000043651300622755700243210ustar00rootroot00000000000000

TaskQueue API

Instance Methods

taskqueues()

Returns the taskqueues Resource.

tasks()

Returns the tasks Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/taskqueue_v1beta1.taskqueues.html000066400000000000000000000057351300622755700265140ustar00rootroot00000000000000

TaskQueue API . taskqueues

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",
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/taskqueue_v1beta1.tasks.html000066400000000000000000000127001300622755700254350ustar00rootroot00000000000000

TaskQueue API . tasks

Instance Methods

delete(project, taskqueue, task)

Delete a task from a TaskQueue.

get(project, taskqueue, task)

Get a particular task from a TaskQueue.

lease(project, taskqueue, numTasks, leaseSecs)

Lease 1 or more tasks from a TaskQueue.

list(project, taskqueue)

List Tasks in 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.
    "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) 
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)

Returns:
  An object of the form:

    {
    "items": [ # The actual list of tasks returned as a result of the lease operation.
      {
        "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
        "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
        "id": "A String", # Name of the task.
        "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
        "queueName": "A String", # Name of the queue that the task is in.
        "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
      },
    ],
    "kind": "taskqueue#tasks", # The kind of object returned, a list of tasks.
  }
list(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.
        "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.
  }
google-api-python-client-1.5.5/docs/dyn/taskqueue_v1beta2.html000066400000000000000000000043651300622755700243220ustar00rootroot00000000000000

TaskQueue API

Instance Methods

taskqueues()

Returns the taskqueues Resource.

tasks()

Returns the tasks Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/taskqueue_v1beta2.taskqueues.html000066400000000000000000000057351300622755700265150ustar00rootroot00000000000000

TaskQueue API . taskqueues

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",
      ],
    },
  }
google-api-python-client-1.5.5/docs/dyn/taskqueue_v1beta2.tasks.html000066400000000000000000000321551300622755700254440ustar00rootroot00000000000000

TaskQueue API . tasks

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.
    }
google-api-python-client-1.5.5/docs/dyn/tasks_v1.html000066400000000000000000000043231300622755700225140ustar00rootroot00000000000000

Tasks API

Instance Methods

tasklists()

Returns the tasklists Resource.

tasks()

Returns the tasks Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/tasks_v1.tasklists.html000066400000000000000000000207461300622755700245430ustar00rootroot00000000000000

Tasks API . tasklists

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.
    }
google-api-python-client-1.5.5/docs/dyn/tasks_v1.tasks.html000066400000000000000000000655411300622755700236510ustar00rootroot00000000000000

Tasks API . tasks

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.
    }
google-api-python-client-1.5.5/docs/dyn/toolresults_v1beta3.html000066400000000000000000000041471300622755700247110ustar00rootroot00000000000000

Cloud Tool Results API

Instance Methods

projects()

Returns the projects Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/toolresults_v1beta3.projects.histories.executions.html000066400000000000000000002044111300622755700327320ustar00rootroot00000000000000

Cloud Tool Results API . projects . histories . executions

Instance Methods

steps()

Returns the steps Resource.

create(projectId=None, historyId=None, body, requestId=None)

Creates an Execution.

get(projectId=None, historyId=None, executionId=None)

Gets an Execution.

list(projectId=None, historyId=None, pageToken=None, pageSize=None)

Lists Histories for a given Project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId, historyId, executionId, body, requestId=None)

Updates an existing Execution with the supplied partial entity.

Method Details

create(projectId=None, historyId=None, body, requestId=None) 
Creates an Execution.

The returned Execution will have the id set.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step
      # 
      # The maximum size of an execution message is 1 MiB.
      # 
      # An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.
    "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the Test Service uses.
        # 
        # - In response: present if set by create - In create: optional - In update: never set
    "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution was created.
        # 
        # This value will be set automatically when CreateExecution is called.
        # 
        # - In response: always set - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "state": "A String", # The initial state is IN_PROGRESS.
        # 
        # The only legal state transitions is from IN_PROGRESS to COMPLETE.
        # 
        # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
        # 
        # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.
        # 
        # If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.
        # 
        # - In response always set - In create/update request: optional
    "executionId": "A String", # A unique identifier within a History for this Execution.
        # 
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        # 
        # - In response always set - In create/update request: never set
    "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution status transitioned to COMPLETE.
        # 
        # This value will be set automatically when state transitions to COMPLETE.
        # 
        # - In response: set if the execution state is COMPLETE. - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE
        # 
        # - In response: present if set by create/update request - In create/update request: optional
      "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
          #
          # Optional
        "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
            #
            # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
        "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
      },
      "skippedDetail": { # More information about a SKIPPED outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
          #
          # Optional
        "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
        "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
        "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
      },
      "successDetail": { # More information about a SUCCESS outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
      },
      "failureDetail": { # More information about a FAILURE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
        "crashed": True or False, # If the failure was severe because the system under test crashed.
        "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
        "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
        "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
      },
      "summary": "A String", # The simplest way to interpret a result.
          #
          # Required
    },
  }

  requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID.

Optional, but strongly recommended.

Returns:
  An object of the form:

    { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step
        #
        # The maximum size of an execution message is 1 MiB.
        #
        # An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.
      "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the Test Service uses.
          #
          # - In response: present if set by create - In create: optional - In update: never set
      "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution was created.
          #
          # This value will be set automatically when CreateExecution is called.
          #
          # - In response: always set - In create/update request: never set
          #
          # Example 1: Compute Timestamp from POSIX `time()`.
          #
          # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
          #
          # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
          #
          # struct timeval tv; gettimeofday(&tv, NULL);
          #
          # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
          #
          # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
          #
          # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
          #
          # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
          #
          # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
          #
          # long millis = System.currentTimeMillis();
          #
          # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
          #
          #
          #
          # Example 5: Compute Timestamp from current time in Python.
          #
          # timestamp = Timestamp() timestamp.GetCurrentTime()
        "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
        "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      },
      "state": "A String", # The initial state is IN_PROGRESS.
          #
          # The only legal state transitions is from IN_PROGRESS to COMPLETE.
          #
          # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
          #
          # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.
          #
          # If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.
          #
          # - In response always set - In create/update request: optional
      "executionId": "A String", # A unique identifier within a History for this Execution.
          #
          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
          #
          # - In response always set - In create/update request: never set
      "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution status transitioned to COMPLETE.
          #
          # This value will be set automatically when state transitions to COMPLETE.
          #
          # - In response: set if the execution state is COMPLETE. - In create/update request: never set
          #
          # Example 1: Compute Timestamp from POSIX `time()`.
          #
          # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
          #
          # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
          #
          # struct timeval tv; gettimeofday(&tv, NULL);
          #
          # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
          #
          # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
          #
          # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
          #
          # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
          #
          # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
          #
          # long millis = System.currentTimeMillis();
          #
          # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
          #
          #
          #
          # Example 5: Compute Timestamp from current time in Python.
          #
          # timestamp = Timestamp() timestamp.GetCurrentTime()
        "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
        "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      },
      "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
            #
            # Optional
          "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
              #
              # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
          "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
        },
        "skippedDetail": { # More information about a SKIPPED outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
            #
            # Optional
          "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
          "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
          "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
        },
        "successDetail": { # More information about a SUCCESS outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
            #
            # Optional
          "otherNativeCrash": True or False, # If a native process other than the app crashed.
        },
        "failureDetail": { # More information about a FAILURE outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
            #
            # Optional
          "otherNativeCrash": True or False, # If a native process other than the app crashed.
          "crashed": True or False, # If the failure was severe because the system under test crashed.
          "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
          "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
          "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
        },
        "summary": "A String", # The simplest way to interpret a result.
            #
            # Required
      },
    }
get(projectId=None, historyId=None, executionId=None) 
Gets an Execution.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, An Execution id.

Required. (required)

Returns:
  An object of the form:

    { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step
        #
        # The maximum size of an execution message is 1 MiB.
        #
        # An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.
      "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the Test Service uses.
          #
          # - In response: present if set by create - In create: optional - In update: never set
      "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution was created.
          #
          # This value will be set automatically when CreateExecution is called.
          #
          # - In response: always set - In create/update request: never set
          #
          # Example 1: Compute Timestamp from POSIX `time()`.
          #
          # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
          #
          # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
          #
          # struct timeval tv; gettimeofday(&tv, NULL);
          #
          # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
          #
          # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
          #
          # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
          #
          # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
          #
          # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
          #
          # long millis = System.currentTimeMillis();
          #
          # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
          #
          #
          #
          # Example 5: Compute Timestamp from current time in Python.
          #
          # timestamp = Timestamp() timestamp.GetCurrentTime()
        "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
        "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      },
      "state": "A String", # The initial state is IN_PROGRESS.
          #
          # The only legal state transitions is from IN_PROGRESS to COMPLETE.
          #
          # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
          #
          # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.
          #
          # If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.
          #
          # - In response always set - In create/update request: optional
      "executionId": "A String", # A unique identifier within a History for this Execution.
          #
          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
          #
          # - In response always set - In create/update request: never set
      "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution status transitioned to COMPLETE.
          #
          # This value will be set automatically when state transitions to COMPLETE.
          #
          # - In response: set if the execution state is COMPLETE. - In create/update request: never set
          #
          # Example 1: Compute Timestamp from POSIX `time()`.
          #
          # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
          #
          # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
          #
          # struct timeval tv; gettimeofday(&tv, NULL);
          #
          # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
          #
          # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
          #
          # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
          #
          # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
          #
          # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
          #
          # long millis = System.currentTimeMillis();
          #
          # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
          #
          #
          #
          # Example 5: Compute Timestamp from current time in Python.
          #
          # timestamp = Timestamp() timestamp.GetCurrentTime()
        "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
        "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      },
      "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
            #
            # Optional
          "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
              #
              # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
          "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
        },
        "skippedDetail": { # More information about a SKIPPED outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
            #
            # Optional
          "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
          "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
          "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
        },
        "successDetail": { # More information about a SUCCESS outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
            #
            # Optional
          "otherNativeCrash": True or False, # If a native process other than the app crashed.
        },
        "failureDetail": { # More information about a FAILURE outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
            #
            # Optional
          "otherNativeCrash": True or False, # If a native process other than the app crashed.
          "crashed": True or False, # If the failure was severe because the system under test crashed.
          "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
          "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
          "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
        },
        "summary": "A String", # The simplest way to interpret a result.
            #
            # Required
      },
    }
list(projectId=None, historyId=None, pageToken=None, pageSize=None) 
Lists Histories for a given Project.

The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  pageToken: string, A continuation token to resume the query at the next item.

Optional.
  pageSize: integer, The maximum number of Executions to fetch.

Default value: 25. The server will use this default if the field is not set or has a value of 0.

Optional.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A continuation token to resume the query at the next item.
        #
        # Will only be set if there are more Executions to fetch.
    "executions": [ # Executions.
        #
        # Always set.
      { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step
            #
            # The maximum size of an execution message is 1 MiB.
            #
            # An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.
          "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the Test Service uses.
              #
              # - In response: present if set by create - In create: optional - In update: never set
          "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution was created.
              #
              # This value will be set automatically when CreateExecution is called.
              #
              # - In response: always set - In create/update request: never set
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
          "state": "A String", # The initial state is IN_PROGRESS.
              #
              # The only legal state transitions is from IN_PROGRESS to COMPLETE.
              #
              # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
              #
              # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.
              #
              # If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.
              #
              # - In response always set - In create/update request: optional
          "executionId": "A String", # A unique identifier within a History for this Execution.
              #
              # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
              #
              # - In response always set - In create/update request: never set
          "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution status transitioned to COMPLETE.
              #
              # This value will be set automatically when state transitions to COMPLETE.
              #
              # - In response: set if the execution state is COMPLETE. - In create/update request: never set
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
          "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE
              #
              # - In response: present if set by create/update request - In create/update request: optional
            "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
                #
                # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
                #
                # Optional
              "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
                  #
                  # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
              "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
            },
            "skippedDetail": { # More information about a SKIPPED outcome.
                #
                # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
                #
                # Optional
              "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
              "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
              "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
            },
            "successDetail": { # More information about a SUCCESS outcome.
                #
                # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
                #
                # Optional
              "otherNativeCrash": True or False, # If a native process other than the app crashed.
            },
            "failureDetail": { # More information about a FAILURE outcome.
                #
                # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
                #
                # Optional
              "otherNativeCrash": True or False, # If a native process other than the app crashed.
              "crashed": True or False, # If the failure was severe because the system under test crashed.
              "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
              "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
              "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
            },
            "summary": "A String", # The simplest way to interpret a result.
                #
                # Required
          },
        },
    ],
  }
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, historyId, executionId, body, requestId=None) 
Updates an existing Execution with the supplied partial entity.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist

Args:
  projectId: string, A Project id. Required. (required)
  historyId: string, Required. (required)
  executionId: string, Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step
      # 
      # The maximum size of an execution message is 1 MiB.
      # 
      # An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.
    "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the Test Service uses.
        # 
        # - In response: present if set by create - In create: optional - In update: never set
    "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution was created.
        # 
        # This value will be set automatically when CreateExecution is called.
        # 
        # - In response: always set - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "state": "A String", # The initial state is IN_PROGRESS.
        # 
        # The only legal state transitions is from IN_PROGRESS to COMPLETE.
        # 
        # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
        # 
        # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.
        # 
        # If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.
        # 
        # - In response always set - In create/update request: optional
    "executionId": "A String", # A unique identifier within a History for this Execution.
        # 
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        # 
        # - In response always set - In create/update request: never set
    "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution status transitioned to COMPLETE.
        # 
        # This value will be set automatically when state transitions to COMPLETE.
        # 
        # - In response: set if the execution state is COMPLETE. - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE
        # 
        # - In response: present if set by create/update request - In create/update request: optional
      "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
          #
          # Optional
        "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
            #
            # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
        "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
      },
      "skippedDetail": { # More information about a SKIPPED outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
          #
          # Optional
        "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
        "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
        "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
      },
      "successDetail": { # More information about a SUCCESS outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
      },
      "failureDetail": { # More information about a FAILURE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
        "crashed": True or False, # If the failure was severe because the system under test crashed.
        "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
        "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
        "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
      },
      "summary": "A String", # The simplest way to interpret a result.
          #
          # Required
    },
  }

  requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID.

Optional, but strongly recommended.

Returns:
  An object of the form:

    { # An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step
        #
        # The maximum size of an execution message is 1 MiB.
        #
        # An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.
      "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the Test Service uses.
          #
          # - In response: present if set by create - In create: optional - In update: never set
      "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution was created.
          #
          # This value will be set automatically when CreateExecution is called.
          #
          # - In response: always set - In create/update request: never set
          #
          # Example 1: Compute Timestamp from POSIX `time()`.
          #
          # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
          #
          # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
          #
          # struct timeval tv; gettimeofday(&tv, NULL);
          #
          # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
          #
          # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
          #
          # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
          #
          # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
          #
          # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
          #
          # long millis = System.currentTimeMillis();
          #
          # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
          #
          #
          #
          # Example 5: Compute Timestamp from current time in Python.
          #
          # timestamp = Timestamp() timestamp.GetCurrentTime()
        "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
        "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      },
      "state": "A String", # The initial state is IN_PROGRESS.
          #
          # The only legal state transitions is from IN_PROGRESS to COMPLETE.
          #
          # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
          #
          # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.
          #
          # If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.
          #
          # - In response always set - In create/update request: optional
      "executionId": "A String", # A unique identifier within a History for this Execution.
          #
          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
          #
          # - In response always set - In create/update request: never set
      "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the Execution status transitioned to COMPLETE.
          #
          # This value will be set automatically when state transitions to COMPLETE.
          #
          # - In response: set if the execution state is COMPLETE. - In create/update request: never set
          #
          # Example 1: Compute Timestamp from POSIX `time()`.
          #
          # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
          #
          # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
          #
          # struct timeval tv; gettimeofday(&tv, NULL);
          #
          # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
          #
          # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
          #
          # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
          #
          # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
          #
          # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
          #
          # long millis = System.currentTimeMillis();
          #
          # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
          #
          #
          #
          # Example 5: Compute Timestamp from current time in Python.
          #
          # timestamp = Timestamp() timestamp.GetCurrentTime()
        "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
        "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      },
      "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
            #
            # Optional
          "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
              #
              # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
          "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
        },
        "skippedDetail": { # More information about a SKIPPED outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
            #
            # Optional
          "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
          "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
          "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
        },
        "successDetail": { # More information about a SUCCESS outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
            #
            # Optional
          "otherNativeCrash": True or False, # If a native process other than the app crashed.
        },
        "failureDetail": { # More information about a FAILURE outcome.
            #
            # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
            #
            # Optional
          "otherNativeCrash": True or False, # If a native process other than the app crashed.
          "crashed": True or False, # If the failure was severe because the system under test crashed.
          "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
          "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
          "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
        },
        "summary": "A String", # The simplest way to interpret a result.
            #
            # Required
      },
    }
google-api-python-client-1.5.5/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html000066400000000000000000010627101300622755700340740ustar00rootroot00000000000000

Cloud Tool Results API . projects . histories . executions . steps

Instance Methods

thumbnails()

Returns the thumbnails Resource.

create(projectId=None, historyId=None, executionId=None, body, requestId=None)

Creates a Step.

get(projectId=None, historyId=None, executionId=None, stepId=None)

Gets a Step.

list(projectId=None, historyId=None, executionId=None, pageToken=None, pageSize=None)

Lists Steps for a given Execution.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(projectId=None, historyId=None, executionId=None, stepId=None, body, requestId=None)

Updates an existing Step with the supplied partial entity.

publishXunitXmlFiles(projectId=None, historyId=None, executionId=None, stepId=None, body)

Publish xml files to an existing Step.

Method Details

create(projectId=None, historyId=None, executionId=None, body, requestId=None) 
Creates a Step.

The returned Step will have the id set.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, A Execution id.

Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
    # 
    # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
    # 
    # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
    # 
    # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
  "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
      #
      # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
      #
      # Users can also add test results manually by using the test_result field.
    "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
        #
        # - In response: present if set by create or update - In create/update request: optional
      "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
          #
          # - In response: present if previously set. - In create/update request: optional
          #
          # Example 1: Compute Duration from two Timestamps in pseudo code.
          #
          # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
          #
          # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
          #
          # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
          #
          # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
          #
          # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
          #
          # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
          #
          # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
          #
          # Example 3: Compute Duration from datetime.timedelta in Python.
          #
          # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
        "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
        "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
      },
    },
    "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
        #
        # The maximum allowed number of test suite overviews per step is 1000.
        #
        # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
      { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
          #
          # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
        "name": "A String", # The name of the test suite.
            #
            # - In create/response: always set - In update request: never
        "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
            #
            # - In create/response: always set - In update request: never
        "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
            #
            # - In create/response: always set - In update request: never
        "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
            #
            # Note: Multiple test suites can share the same xml_source
            #
            # Returns INVALID_ARGUMENT if the uri format is not supported.
            #
            # - In create/response: optional - In update request: never
          "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
              #
              # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
              #
              # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
              #
              # - In response: always set - In create/update request: always set
        },
        "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
            #
            # - In create/response: always set - In update request: never
        "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
            #
            # - In create/response: always set - In update request: never
      },
    ],
    "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
        #
        # The exit code of this tool will be used to determine if the test passed.
        #
        # - In response: always set - In create/update request: optional
      "toolLogs": [ # References to any plain text logs output the tool execution.
          #
          # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
          #
          # The maximum allowed number of tool logs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a file.
          "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
              #
              # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
              #
              # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
              #
              # - In response: always set - In create/update request: always set
        },
      ],
      "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
        "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
            #
            # - In response: always set - In create/update request: always set
      },
      "toolOutputs": [ # References to opaque files of any format output by the tool execution.
          #
          # The maximum allowed number of tool outputs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a ToolExecution output file.
          "testCase": { # A reference to a test case. # The test case to which this output file belongs.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
            "className": "A String", # The name of the class.
            "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
            "name": "A String", # The name of the test case.
                #
                # Required.
          },
          "output": { # A reference to a file. # A FileReference to an output file.
              #
              # - In response: always set - In create/update request: always set
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
        },
      ],
      "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
          #
          # - In response: present if set by create request - In create request: optional - In update request: never set
        "A String",
      ],
    },
    "testIssues": [ # Issues observed during the test execution.
        #
        # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
        #
        # - In response: present if set by create or update - In create/update request: optional
      { # An abnormal event observed during the test execution.
        "stackTrace": { # A stacktrace. # Optional.
          "exception": "A String", # The stack trace message.
              #
              # Required
        },
        "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
            #
            # Required.
      },
    ],
  },
  "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
    "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
        #
        # - In response: present if set by create/update request - In create/update request: optional
      "toolLogs": [ # References to any plain text logs output the tool execution.
          #
          # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
          #
          # The maximum allowed number of tool logs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a file.
          "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
              #
              # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
              #
              # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
              #
              # - In response: always set - In create/update request: always set
        },
      ],
      "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
        "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
            #
            # - In response: always set - In create/update request: always set
      },
      "toolOutputs": [ # References to opaque files of any format output by the tool execution.
          #
          # The maximum allowed number of tool outputs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a ToolExecution output file.
          "testCase": { # A reference to a test case. # The test case to which this output file belongs.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
            "className": "A String", # The name of the class.
            "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
            "name": "A String", # The name of the test case.
                #
                # Required.
          },
          "output": { # A reference to a file. # A FileReference to an output file.
              #
              # - In response: always set - In create/update request: always set
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
        },
      ],
      "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
          #
          # - In response: present if set by create request - In create request: optional - In update request: never set
        "A String",
      ],
    },
  },
  "stepId": "A String", # A unique identifier within a Execution for this Step.
      # 
      # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
      # 
      # - In response: always set - In create/update request: never set
  "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
      # 
      # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
      # 
      # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
      # 
      # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
      #
      # Example 1: Compute Duration from two Timestamps in pseudo code.
      #
      # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
      #
      # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
      #
      # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
      #
      # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
      #
      # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
      #
      # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
      #
      # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
      #
      # Example 3: Compute Duration from datetime.timedelta in Python.
      #
      # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
    "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
    "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
  },
  "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
      # 
      # - In response: present if set by create/update request - In create/update request: optional
  "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
      # 
      # Users are responsible for managing the key namespace such that keys don't accidentally collide.
      # 
      # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
      # 
      # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
    {
      "value": "A String",
      "key": "A String",
    },
  ],
  "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
      # 
      # - In response: always set - In create/update request: never set
      #
      # Example 1: Compute Timestamp from POSIX `time()`.
      #
      # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
      #
      # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
      #
      # struct timeval tv; gettimeofday(&tv, NULL);
      #
      # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
      #
      # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
      #
      # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
      #
      # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
      #
      # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
      #
      # long millis = System.currentTimeMillis();
      #
      # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
      #
      #
      #
      # Example 5: Compute Timestamp from current time in Python.
      #
      # timestamp = Timestamp() timestamp.GetCurrentTime()
    "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
    "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
  },
  "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
      # 
      # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
      # 
      # - In response: always set - In create request: always set - In update request: never set
  "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
      # 
      # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
      # 
      # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
      # 
      # - In response: always set - In create/update request: optional
  "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
      # 
      # This value will be set automatically when state transitions to COMPLETE.
      # 
      # - In response: set if the execution state is COMPLETE. - In create/update request: never set
      #
      # Example 1: Compute Timestamp from POSIX `time()`.
      #
      # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
      #
      # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
      #
      # struct timeval tv; gettimeofday(&tv, NULL);
      #
      # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
      #
      # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
      #
      # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
      #
      # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
      #
      # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
      #
      # long millis = System.currentTimeMillis();
      #
      # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
      #
      #
      #
      # Example 5: Compute Timestamp from current time in Python.
      #
      # timestamp = Timestamp() timestamp.GetCurrentTime()
    "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
    "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
  },
  "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
      # 
      # The keys must exactly match the dimension_definition of the execution.
      # 
      # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
      # 
      # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
      # 
      # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
      # 
      # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
      # 
      # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
      # 
      # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
      # 
      # - In response: present if set by create - In create request: optional - In update request: never set
    {
      "value": "A String",
      "key": "A String",
    },
  ],
  "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
      # 
      # - In response: present if set by create/update request - In create/update request: optional
    "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
        #
        # Optional
      "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
          #
          # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
      "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
    },
    "skippedDetail": { # More information about a SKIPPED outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
        #
        # Optional
      "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
      "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
      "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
    },
    "successDetail": { # More information about a SUCCESS outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
        #
        # Optional
      "otherNativeCrash": True or False, # If a native process other than the app crashed.
    },
    "failureDetail": { # More information about a FAILURE outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
        #
        # Optional
      "otherNativeCrash": True or False, # If a native process other than the app crashed.
      "crashed": True or False, # If the failure was severe because the system under test crashed.
      "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
      "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
      "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
    },
    "summary": "A String", # The simplest way to interpret a result.
        #
        # Required
  },
  "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
      # 
      # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
      # 
      # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
      # 
      # - In response: present if previously set. - In create request: optional - In update request: optional
      #
      # Example 1: Compute Duration from two Timestamps in pseudo code.
      #
      # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
      #
      # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
      #
      # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
      #
      # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
      #
      # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
      #
      # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
      #
      # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
      #
      # Example 3: Compute Duration from datetime.timedelta in Python.
      #
      # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
    "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
    "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
  },
  "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
      # 
      # - In response: always set - In create/update request: never set
}

  requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID.

Optional, but strongly recommended.

Returns:
  An object of the form:

    { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
      #
      # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
      #
      # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
      #
      # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
    "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
        #
        # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
        #
        # Users can also add test results manually by using the test_result field.
      "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
          #
          # - In response: present if set by create or update - In create/update request: optional
        "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
            #
            # - In response: present if previously set. - In create/update request: optional
            #
            # Example 1: Compute Duration from two Timestamps in pseudo code.
            #
            # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
            #
            # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
            #
            # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
            #
            # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
            #
            # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
            #
            # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
            #
            # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
            #
            # Example 3: Compute Duration from datetime.timedelta in Python.
            #
            # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
          "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
          "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
        },
      },
      "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
          #
          # The maximum allowed number of test suite overviews per step is 1000.
          #
          # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
        { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
            #
            # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
          "name": "A String", # The name of the test suite.
              #
              # - In create/response: always set - In update request: never
          "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
              #
              # Note: Multiple test suites can share the same xml_source
              #
              # Returns INVALID_ARGUMENT if the uri format is not supported.
              #
              # - In create/response: optional - In update request: never
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
              #
              # - In create/response: always set - In update request: never
          "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
        },
      ],
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
          #
          # The exit code of this tool will be used to determine if the test passed.
          #
          # - In response: always set - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
      "testIssues": [ # Issues observed during the test execution.
          #
          # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
          #
          # - In response: present if set by create or update - In create/update request: optional
        { # An abnormal event observed during the test execution.
          "stackTrace": { # A stacktrace. # Optional.
            "exception": "A String", # The stack trace message.
                #
                # Required
          },
          "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
              #
              # Required.
        },
      ],
    },
    "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
    },
    "stepId": "A String", # A unique identifier within a Execution for this Step.
        #
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        #
        # - In response: always set - In create/update request: never set
    "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
        #
        # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
        #
        # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
        #
        # - In response: present if set by create/update request - In create/update request: optional
    "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
        #
        # Users are responsible for managing the key namespace such that keys don't accidentally collide.
        #
        # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
        #
        # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
        #
        # - In response: always set - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
        #
        # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
        #
        # - In response: always set - In create request: always set - In update request: never set
    "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
        #
        # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
        #
        # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
        #
        # - In response: always set - In create/update request: optional
    "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
        #
        # This value will be set automatically when state transitions to COMPLETE.
        #
        # - In response: set if the execution state is COMPLETE. - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
        #
        # The keys must exactly match the dimension_definition of the execution.
        #
        # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
        #
        # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
        #
        # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
        #
        # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
        #
        # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
        #
        # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
        #
        # - In response: present if set by create - In create request: optional - In update request: never set
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
        #
        # - In response: present if set by create/update request - In create/update request: optional
      "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
          #
          # Optional
        "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
            #
            # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
        "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
      },
      "skippedDetail": { # More information about a SKIPPED outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
          #
          # Optional
        "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
        "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
        "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
      },
      "successDetail": { # More information about a SUCCESS outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
      },
      "failureDetail": { # More information about a FAILURE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
        "crashed": True or False, # If the failure was severe because the system under test crashed.
        "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
        "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
        "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
      },
      "summary": "A String", # The simplest way to interpret a result.
          #
          # Required
    },
    "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
        #
        # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
        #
        # - In response: present if previously set. - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
        #
        # - In response: always set - In create/update request: never set
  }
get(projectId=None, historyId=None, executionId=None, stepId=None) 
Gets a Step.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, A Execution id.

Required. (required)
  stepId: string, A Step id.

Required. (required)

Returns:
  An object of the form:

    { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
      #
      # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
      #
      # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
      #
      # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
    "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
        #
        # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
        #
        # Users can also add test results manually by using the test_result field.
      "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
          #
          # - In response: present if set by create or update - In create/update request: optional
        "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
            #
            # - In response: present if previously set. - In create/update request: optional
            #
            # Example 1: Compute Duration from two Timestamps in pseudo code.
            #
            # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
            #
            # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
            #
            # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
            #
            # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
            #
            # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
            #
            # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
            #
            # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
            #
            # Example 3: Compute Duration from datetime.timedelta in Python.
            #
            # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
          "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
          "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
        },
      },
      "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
          #
          # The maximum allowed number of test suite overviews per step is 1000.
          #
          # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
        { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
            #
            # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
          "name": "A String", # The name of the test suite.
              #
              # - In create/response: always set - In update request: never
          "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
              #
              # Note: Multiple test suites can share the same xml_source
              #
              # Returns INVALID_ARGUMENT if the uri format is not supported.
              #
              # - In create/response: optional - In update request: never
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
              #
              # - In create/response: always set - In update request: never
          "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
        },
      ],
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
          #
          # The exit code of this tool will be used to determine if the test passed.
          #
          # - In response: always set - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
      "testIssues": [ # Issues observed during the test execution.
          #
          # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
          #
          # - In response: present if set by create or update - In create/update request: optional
        { # An abnormal event observed during the test execution.
          "stackTrace": { # A stacktrace. # Optional.
            "exception": "A String", # The stack trace message.
                #
                # Required
          },
          "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
              #
              # Required.
        },
      ],
    },
    "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
    },
    "stepId": "A String", # A unique identifier within a Execution for this Step.
        #
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        #
        # - In response: always set - In create/update request: never set
    "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
        #
        # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
        #
        # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
        #
        # - In response: present if set by create/update request - In create/update request: optional
    "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
        #
        # Users are responsible for managing the key namespace such that keys don't accidentally collide.
        #
        # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
        #
        # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
        #
        # - In response: always set - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
        #
        # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
        #
        # - In response: always set - In create request: always set - In update request: never set
    "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
        #
        # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
        #
        # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
        #
        # - In response: always set - In create/update request: optional
    "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
        #
        # This value will be set automatically when state transitions to COMPLETE.
        #
        # - In response: set if the execution state is COMPLETE. - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
        #
        # The keys must exactly match the dimension_definition of the execution.
        #
        # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
        #
        # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
        #
        # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
        #
        # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
        #
        # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
        #
        # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
        #
        # - In response: present if set by create - In create request: optional - In update request: never set
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
        #
        # - In response: present if set by create/update request - In create/update request: optional
      "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
          #
          # Optional
        "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
            #
            # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
        "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
      },
      "skippedDetail": { # More information about a SKIPPED outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
          #
          # Optional
        "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
        "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
        "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
      },
      "successDetail": { # More information about a SUCCESS outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
      },
      "failureDetail": { # More information about a FAILURE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
        "crashed": True or False, # If the failure was severe because the system under test crashed.
        "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
        "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
        "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
      },
      "summary": "A String", # The simplest way to interpret a result.
          #
          # Required
    },
    "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
        #
        # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
        #
        # - In response: present if previously set. - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
        #
        # - In response: always set - In create/update request: never set
  }
list(projectId=None, historyId=None, executionId=None, pageToken=None, pageSize=None) 
Lists Steps for a given Execution.

The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, A Execution id.

Required. (required)
  pageToken: string, A continuation token to resume the query at the next item.

Optional.
  pageSize: integer, The maximum number of Steps to fetch.

Default value: 25. The server will use this default if the field is not set or has a value of 0.

Optional.

Returns:
  An object of the form:

    { # Response message for StepService.List.
    "nextPageToken": "A String", # A continuation token to resume the query at the next item.
        #
        # If set, indicates that there are more steps to read, by calling list again with this value in the page_token field.
    "steps": [ # Steps.
      { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
          #
          # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
          #
          # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
          #
          # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
        "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
            #
            # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
            #
            # Users can also add test results manually by using the test_result field.
          "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
              #
              # - In response: present if set by create or update - In create/update request: optional
            "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
                #
                # - In response: present if previously set. - In create/update request: optional
                #
                # Example 1: Compute Duration from two Timestamps in pseudo code.
                #
                # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
                #
                # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
                #
                # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
                #
                # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
                #
                # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
                #
                # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
                #
                # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
                #
                # Example 3: Compute Duration from datetime.timedelta in Python.
                #
                # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
              "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
              "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
            },
          },
          "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
              #
              # The maximum allowed number of test suite overviews per step is 1000.
              #
              # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
            { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
                #
                # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
              "name": "A String", # The name of the test suite.
                  #
                  # - In create/response: always set - In update request: never
              "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
                  #
                  # - In create/response: always set - In update request: never
              "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
                  #
                  # - In create/response: always set - In update request: never
              "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
                  #
                  # Note: Multiple test suites can share the same xml_source
                  #
                  # Returns INVALID_ARGUMENT if the uri format is not supported.
                  #
                  # - In create/response: optional - In update request: never
                "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                    #
                    # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                    #
                    # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                    #
                    # - In response: always set - In create/update request: always set
              },
              "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
                  #
                  # - In create/response: always set - In update request: never
              "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
                  #
                  # - In create/response: always set - In update request: never
            },
          ],
          "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
              #
              # The exit code of this tool will be used to determine if the test passed.
              #
              # - In response: always set - In create/update request: optional
            "toolLogs": [ # References to any plain text logs output the tool execution.
                #
                # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
                #
                # The maximum allowed number of tool logs per step is 1000.
                #
                # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
              { # A reference to a file.
                "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                    #
                    # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                    #
                    # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                    #
                    # - In response: always set - In create/update request: always set
              },
            ],
            "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
                #
                # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
              "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "toolOutputs": [ # References to opaque files of any format output by the tool execution.
                #
                # The maximum allowed number of tool outputs per step is 1000.
                #
                # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
              { # A reference to a ToolExecution output file.
                "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                    #
                    # - In response: present if set by create/update request - In create/update request: optional
                    #
                    # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
                  "className": "A String", # The name of the class.
                  "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
                  "name": "A String", # The name of the test case.
                      #
                      # Required.
                },
                "output": { # A reference to a file. # A FileReference to an output file.
                    #
                    # - In response: always set - In create/update request: always set
                  "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                      #
                      # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                      #
                      # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                      #
                      # - In response: always set - In create/update request: always set
                },
                "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                    #
                    # - In response: present if set by create/update request - In create/update request: optional
                    #
                    # Example 1: Compute Timestamp from POSIX `time()`.
                    #
                    # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                    #
                    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                    #
                    # struct timeval tv; gettimeofday(&tv, NULL);
                    #
                    # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                    #
                    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                    #
                    # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                    #
                    # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                    #
                    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                    #
                    # long millis = System.currentTimeMillis();
                    #
                    # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                    #
                    #
                    #
                    # Example 5: Compute Timestamp from current time in Python.
                    #
                    # timestamp = Timestamp() timestamp.GetCurrentTime()
                  "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
                  "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
                },
              },
            ],
            "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
                #
                # - In response: present if set by create request - In create request: optional - In update request: never set
              "A String",
            ],
          },
          "testIssues": [ # Issues observed during the test execution.
              #
              # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
              #
              # - In response: present if set by create or update - In create/update request: optional
            { # An abnormal event observed during the test execution.
              "stackTrace": { # A stacktrace. # Optional.
                "exception": "A String", # The stack trace message.
                    #
                    # Required
              },
              "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
                  #
                  # Required.
            },
          ],
        },
        "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
          "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
              #
              # - In response: present if set by create/update request - In create/update request: optional
            "toolLogs": [ # References to any plain text logs output the tool execution.
                #
                # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
                #
                # The maximum allowed number of tool logs per step is 1000.
                #
                # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
              { # A reference to a file.
                "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                    #
                    # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                    #
                    # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                    #
                    # - In response: always set - In create/update request: always set
              },
            ],
            "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
                #
                # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
              "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "toolOutputs": [ # References to opaque files of any format output by the tool execution.
                #
                # The maximum allowed number of tool outputs per step is 1000.
                #
                # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
              { # A reference to a ToolExecution output file.
                "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                    #
                    # - In response: present if set by create/update request - In create/update request: optional
                    #
                    # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
                  "className": "A String", # The name of the class.
                  "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
                  "name": "A String", # The name of the test case.
                      #
                      # Required.
                },
                "output": { # A reference to a file. # A FileReference to an output file.
                    #
                    # - In response: always set - In create/update request: always set
                  "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                      #
                      # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                      #
                      # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                      #
                      # - In response: always set - In create/update request: always set
                },
                "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                    #
                    # - In response: present if set by create/update request - In create/update request: optional
                    #
                    # Example 1: Compute Timestamp from POSIX `time()`.
                    #
                    # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                    #
                    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                    #
                    # struct timeval tv; gettimeofday(&tv, NULL);
                    #
                    # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                    #
                    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                    #
                    # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                    #
                    # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                    #
                    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                    #
                    # long millis = System.currentTimeMillis();
                    #
                    # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                    #
                    #
                    #
                    # Example 5: Compute Timestamp from current time in Python.
                    #
                    # timestamp = Timestamp() timestamp.GetCurrentTime()
                  "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
                  "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
                },
              },
            ],
            "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
                #
                # - In response: present if set by create request - In create request: optional - In update request: never set
              "A String",
            ],
          },
        },
        "stepId": "A String", # A unique identifier within a Execution for this Step.
            #
            # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
            #
            # - In response: always set - In create/update request: never set
        "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
            #
            # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
            #
            # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
            #
            # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
            #
            # Example 1: Compute Duration from two Timestamps in pseudo code.
            #
            # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
            #
            # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
            #
            # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
            #
            # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
            #
            # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
            #
            # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
            #
            # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
            #
            # Example 3: Compute Duration from datetime.timedelta in Python.
            #
            # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
          "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
          "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
        },
        "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
            #
            # - In response: present if set by create/update request - In create/update request: optional
        "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
            #
            # Users are responsible for managing the key namespace such that keys don't accidentally collide.
            #
            # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
            #
            # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
          {
            "value": "A String",
            "key": "A String",
          },
        ],
        "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
            #
            # - In response: always set - In create/update request: never set
            #
            # Example 1: Compute Timestamp from POSIX `time()`.
            #
            # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
            #
            # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
            #
            # struct timeval tv; gettimeofday(&tv, NULL);
            #
            # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
            #
            # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
            #
            # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
            #
            # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
            #
            # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
            #
            # long millis = System.currentTimeMillis();
            #
            # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
            #
            #
            #
            # Example 5: Compute Timestamp from current time in Python.
            #
            # timestamp = Timestamp() timestamp.GetCurrentTime()
          "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
          "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
        },
        "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
            #
            # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
            #
            # - In response: always set - In create request: always set - In update request: never set
        "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
            #
            # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
            #
            # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
            #
            # - In response: always set - In create/update request: optional
        "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
            #
            # This value will be set automatically when state transitions to COMPLETE.
            #
            # - In response: set if the execution state is COMPLETE. - In create/update request: never set
            #
            # Example 1: Compute Timestamp from POSIX `time()`.
            #
            # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
            #
            # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
            #
            # struct timeval tv; gettimeofday(&tv, NULL);
            #
            # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
            #
            # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
            #
            # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
            #
            # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
            #
            # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
            #
            # long millis = System.currentTimeMillis();
            #
            # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
            #
            #
            #
            # Example 5: Compute Timestamp from current time in Python.
            #
            # timestamp = Timestamp() timestamp.GetCurrentTime()
          "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
          "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
        },
        "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
            #
            # The keys must exactly match the dimension_definition of the execution.
            #
            # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
            #
            # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
            #
            # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
            #
            # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
            #
            # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
            #
            # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
            #
            # - In response: present if set by create - In create request: optional - In update request: never set
          {
            "value": "A String",
            "key": "A String",
          },
        ],
        "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
            #
            # - In response: present if set by create/update request - In create/update request: optional
          "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
              #
              # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
              #
              # Optional
            "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
                #
                # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
            "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
          },
          "skippedDetail": { # More information about a SKIPPED outcome.
              #
              # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
              #
              # Optional
            "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
            "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
            "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
          },
          "successDetail": { # More information about a SUCCESS outcome.
              #
              # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
              #
              # Optional
            "otherNativeCrash": True or False, # If a native process other than the app crashed.
          },
          "failureDetail": { # More information about a FAILURE outcome.
              #
              # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
              #
              # Optional
            "otherNativeCrash": True or False, # If a native process other than the app crashed.
            "crashed": True or False, # If the failure was severe because the system under test crashed.
            "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
            "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
            "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
          },
          "summary": "A String", # The simplest way to interpret a result.
              #
              # Required
        },
        "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
            #
            # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
            #
            # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
            #
            # - In response: present if previously set. - In create request: optional - In update request: optional
            #
            # Example 1: Compute Duration from two Timestamps in pseudo code.
            #
            # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
            #
            # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
            #
            # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
            #
            # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
            #
            # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
            #
            # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
            #
            # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
            #
            # Example 3: Compute Duration from datetime.timedelta in Python.
            #
            # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
          "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
          "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
        },
        "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
            #
            # - In response: always set - In create/update request: never set
      },
    ],
  }
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=None, historyId=None, executionId=None, stepId=None, body, requestId=None) 
Updates an existing Step with the supplied partial entity.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, A Execution id.

Required. (required)
  stepId: string, A Step id.

Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
    # 
    # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
    # 
    # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
    # 
    # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
  "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
      #
      # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
      #
      # Users can also add test results manually by using the test_result field.
    "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
        #
        # - In response: present if set by create or update - In create/update request: optional
      "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
          #
          # - In response: present if previously set. - In create/update request: optional
          #
          # Example 1: Compute Duration from two Timestamps in pseudo code.
          #
          # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
          #
          # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
          #
          # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
          #
          # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
          #
          # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
          #
          # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
          #
          # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
          #
          # Example 3: Compute Duration from datetime.timedelta in Python.
          #
          # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
        "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
        "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
      },
    },
    "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
        #
        # The maximum allowed number of test suite overviews per step is 1000.
        #
        # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
      { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
          #
          # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
        "name": "A String", # The name of the test suite.
            #
            # - In create/response: always set - In update request: never
        "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
            #
            # - In create/response: always set - In update request: never
        "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
            #
            # - In create/response: always set - In update request: never
        "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
            #
            # Note: Multiple test suites can share the same xml_source
            #
            # Returns INVALID_ARGUMENT if the uri format is not supported.
            #
            # - In create/response: optional - In update request: never
          "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
              #
              # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
              #
              # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
              #
              # - In response: always set - In create/update request: always set
        },
        "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
            #
            # - In create/response: always set - In update request: never
        "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
            #
            # - In create/response: always set - In update request: never
      },
    ],
    "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
        #
        # The exit code of this tool will be used to determine if the test passed.
        #
        # - In response: always set - In create/update request: optional
      "toolLogs": [ # References to any plain text logs output the tool execution.
          #
          # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
          #
          # The maximum allowed number of tool logs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a file.
          "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
              #
              # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
              #
              # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
              #
              # - In response: always set - In create/update request: always set
        },
      ],
      "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
        "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
            #
            # - In response: always set - In create/update request: always set
      },
      "toolOutputs": [ # References to opaque files of any format output by the tool execution.
          #
          # The maximum allowed number of tool outputs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a ToolExecution output file.
          "testCase": { # A reference to a test case. # The test case to which this output file belongs.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
            "className": "A String", # The name of the class.
            "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
            "name": "A String", # The name of the test case.
                #
                # Required.
          },
          "output": { # A reference to a file. # A FileReference to an output file.
              #
              # - In response: always set - In create/update request: always set
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
        },
      ],
      "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
          #
          # - In response: present if set by create request - In create request: optional - In update request: never set
        "A String",
      ],
    },
    "testIssues": [ # Issues observed during the test execution.
        #
        # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
        #
        # - In response: present if set by create or update - In create/update request: optional
      { # An abnormal event observed during the test execution.
        "stackTrace": { # A stacktrace. # Optional.
          "exception": "A String", # The stack trace message.
              #
              # Required
        },
        "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
            #
            # Required.
      },
    ],
  },
  "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
    "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
        #
        # - In response: present if set by create/update request - In create/update request: optional
      "toolLogs": [ # References to any plain text logs output the tool execution.
          #
          # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
          #
          # The maximum allowed number of tool logs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a file.
          "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
              #
              # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
              #
              # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
              #
              # - In response: always set - In create/update request: always set
        },
      ],
      "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
        "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
            #
            # - In response: always set - In create/update request: always set
      },
      "toolOutputs": [ # References to opaque files of any format output by the tool execution.
          #
          # The maximum allowed number of tool outputs per step is 1000.
          #
          # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
        { # A reference to a ToolExecution output file.
          "testCase": { # A reference to a test case. # The test case to which this output file belongs.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
            "className": "A String", # The name of the class.
            "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
            "name": "A String", # The name of the test case.
                #
                # Required.
          },
          "output": { # A reference to a file. # A FileReference to an output file.
              #
              # - In response: always set - In create/update request: always set
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
        },
      ],
      "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
          #
          # - In response: present if set by create request - In create request: optional - In update request: never set
        "A String",
      ],
    },
  },
  "stepId": "A String", # A unique identifier within a Execution for this Step.
      # 
      # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
      # 
      # - In response: always set - In create/update request: never set
  "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
      # 
      # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
      # 
      # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
      # 
      # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
      #
      # Example 1: Compute Duration from two Timestamps in pseudo code.
      #
      # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
      #
      # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
      #
      # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
      #
      # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
      #
      # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
      #
      # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
      #
      # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
      #
      # Example 3: Compute Duration from datetime.timedelta in Python.
      #
      # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
    "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
    "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
  },
  "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
      # 
      # - In response: present if set by create/update request - In create/update request: optional
  "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
      # 
      # Users are responsible for managing the key namespace such that keys don't accidentally collide.
      # 
      # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
      # 
      # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
    {
      "value": "A String",
      "key": "A String",
    },
  ],
  "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
      # 
      # - In response: always set - In create/update request: never set
      #
      # Example 1: Compute Timestamp from POSIX `time()`.
      #
      # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
      #
      # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
      #
      # struct timeval tv; gettimeofday(&tv, NULL);
      #
      # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
      #
      # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
      #
      # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
      #
      # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
      #
      # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
      #
      # long millis = System.currentTimeMillis();
      #
      # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
      #
      #
      #
      # Example 5: Compute Timestamp from current time in Python.
      #
      # timestamp = Timestamp() timestamp.GetCurrentTime()
    "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
    "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
  },
  "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
      # 
      # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
      # 
      # - In response: always set - In create request: always set - In update request: never set
  "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
      # 
      # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
      # 
      # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
      # 
      # - In response: always set - In create/update request: optional
  "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
      # 
      # This value will be set automatically when state transitions to COMPLETE.
      # 
      # - In response: set if the execution state is COMPLETE. - In create/update request: never set
      #
      # Example 1: Compute Timestamp from POSIX `time()`.
      #
      # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
      #
      # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
      #
      # struct timeval tv; gettimeofday(&tv, NULL);
      #
      # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
      #
      # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
      #
      # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
      #
      # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
      #
      # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
      #
      # long millis = System.currentTimeMillis();
      #
      # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
      #
      #
      #
      # Example 5: Compute Timestamp from current time in Python.
      #
      # timestamp = Timestamp() timestamp.GetCurrentTime()
    "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
    "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
  },
  "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
      # 
      # The keys must exactly match the dimension_definition of the execution.
      # 
      # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
      # 
      # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
      # 
      # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
      # 
      # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
      # 
      # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
      # 
      # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
      # 
      # - In response: present if set by create - In create request: optional - In update request: never set
    {
      "value": "A String",
      "key": "A String",
    },
  ],
  "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
      # 
      # - In response: present if set by create/update request - In create/update request: optional
    "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
        #
        # Optional
      "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
          #
          # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
      "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
    },
    "skippedDetail": { # More information about a SKIPPED outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
        #
        # Optional
      "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
      "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
      "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
    },
    "successDetail": { # More information about a SUCCESS outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
        #
        # Optional
      "otherNativeCrash": True or False, # If a native process other than the app crashed.
    },
    "failureDetail": { # More information about a FAILURE outcome.
        #
        # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
        #
        # Optional
      "otherNativeCrash": True or False, # If a native process other than the app crashed.
      "crashed": True or False, # If the failure was severe because the system under test crashed.
      "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
      "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
      "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
    },
    "summary": "A String", # The simplest way to interpret a result.
        #
        # Required
  },
  "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
      # 
      # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
      # 
      # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
      # 
      # - In response: present if previously set. - In create request: optional - In update request: optional
      #
      # Example 1: Compute Duration from two Timestamps in pseudo code.
      #
      # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
      #
      # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
      #
      # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
      #
      # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
      #
      # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
      #
      # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
      #
      # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
      #
      # Example 3: Compute Duration from datetime.timedelta in Python.
      #
      # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
    "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
    "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
  },
  "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
      # 
      # - In response: always set - In create/update request: never set
}

  requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID.

Optional, but strongly recommended.

Returns:
  An object of the form:

    { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
      #
      # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
      #
      # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
      #
      # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
    "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
        #
        # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
        #
        # Users can also add test results manually by using the test_result field.
      "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
          #
          # - In response: present if set by create or update - In create/update request: optional
        "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
            #
            # - In response: present if previously set. - In create/update request: optional
            #
            # Example 1: Compute Duration from two Timestamps in pseudo code.
            #
            # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
            #
            # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
            #
            # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
            #
            # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
            #
            # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
            #
            # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
            #
            # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
            #
            # Example 3: Compute Duration from datetime.timedelta in Python.
            #
            # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
          "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
          "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
        },
      },
      "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
          #
          # The maximum allowed number of test suite overviews per step is 1000.
          #
          # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
        { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
            #
            # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
          "name": "A String", # The name of the test suite.
              #
              # - In create/response: always set - In update request: never
          "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
              #
              # Note: Multiple test suites can share the same xml_source
              #
              # Returns INVALID_ARGUMENT if the uri format is not supported.
              #
              # - In create/response: optional - In update request: never
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
              #
              # - In create/response: always set - In update request: never
          "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
        },
      ],
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
          #
          # The exit code of this tool will be used to determine if the test passed.
          #
          # - In response: always set - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
      "testIssues": [ # Issues observed during the test execution.
          #
          # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
          #
          # - In response: present if set by create or update - In create/update request: optional
        { # An abnormal event observed during the test execution.
          "stackTrace": { # A stacktrace. # Optional.
            "exception": "A String", # The stack trace message.
                #
                # Required
          },
          "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
              #
              # Required.
        },
      ],
    },
    "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
    },
    "stepId": "A String", # A unique identifier within a Execution for this Step.
        #
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        #
        # - In response: always set - In create/update request: never set
    "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
        #
        # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
        #
        # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
        #
        # - In response: present if set by create/update request - In create/update request: optional
    "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
        #
        # Users are responsible for managing the key namespace such that keys don't accidentally collide.
        #
        # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
        #
        # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
        #
        # - In response: always set - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
        #
        # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
        #
        # - In response: always set - In create request: always set - In update request: never set
    "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
        #
        # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
        #
        # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
        #
        # - In response: always set - In create/update request: optional
    "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
        #
        # This value will be set automatically when state transitions to COMPLETE.
        #
        # - In response: set if the execution state is COMPLETE. - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
        #
        # The keys must exactly match the dimension_definition of the execution.
        #
        # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
        #
        # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
        #
        # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
        #
        # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
        #
        # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
        #
        # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
        #
        # - In response: present if set by create - In create request: optional - In update request: never set
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
        #
        # - In response: present if set by create/update request - In create/update request: optional
      "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
          #
          # Optional
        "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
            #
            # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
        "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
      },
      "skippedDetail": { # More information about a SKIPPED outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
          #
          # Optional
        "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
        "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
        "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
      },
      "successDetail": { # More information about a SUCCESS outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
      },
      "failureDetail": { # More information about a FAILURE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
        "crashed": True or False, # If the failure was severe because the system under test crashed.
        "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
        "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
        "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
      },
      "summary": "A String", # The simplest way to interpret a result.
          #
          # Required
    },
    "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
        #
        # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
        #
        # - In response: present if previously set. - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
        #
        # - In response: always set - In create/update request: never set
  }
publishXunitXmlFiles(projectId=None, historyId=None, executionId=None, stepId=None, body) 
Publish xml files to an existing Step.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, A Execution id.

Required. (required)
  stepId: string, A Step id. Note: This step must include a TestExecutionStep.

Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for StepService.PublishXunitXmlFiles.
    "xunitXmlFiles": [ # URI of the Xunit XML files to publish.
        # 
        # The maximum size of the file this reference is pointing to is 50MB.
        # 
        # Required.
      { # A reference to a file.
        "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
            #
            # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
            #
            # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
            #
            # - In response: always set - In create/update request: always set
      },
    ],
  }


Returns:
  An object of the form:

    { # A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).
      #
      # Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel).
      #
      # Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE
      #
      # A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.
    "testExecutionStep": { # A step that represents running tests. # An execution of a test runner.
        #
        # It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.
        #
        # Users can also add test results manually by using the test_result field.
      "testTiming": { # Testing timing break down to know phases. # The timing break down of the test execution.
          #
          # - In response: present if set by create or update - In create/update request: optional
        "testProcessDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took to run the test process.
            #
            # - In response: present if previously set. - In create/update request: optional
            #
            # Example 1: Compute Duration from two Timestamps in pseudo code.
            #
            # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
            #
            # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
            #
            # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
            #
            # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
            #
            # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
            #
            # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
            #
            # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
            #
            # Example 3: Compute Duration from datetime.timedelta in Python.
            #
            # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
          "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
          "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
        },
      },
      "testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
          #
          # The maximum allowed number of test suite overviews per step is 1000.
          #
          # - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)
        { # A summary of a test suite result either parsed from XML or uploaded directly by a user.
            #
            # Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.
          "name": "A String", # The name of the test suite.
              #
              # - In create/response: always set - In update request: never
          "errorCount": 42, # Number of test cases in error, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "totalCount": 42, # Number of test cases, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
          "xmlSource": { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original XML file is stored.
              #
              # Note: Multiple test suites can share the same xml_source
              #
              # Returns INVALID_ARGUMENT if the uri format is not supported.
              #
              # - In create/response: optional - In update request: never
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "failureCount": 42, # Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.
              #
              # - In create/response: always set - In update request: never
          "skippedCount": 42, # Number of test cases not run, typically set by the service by parsing the xml_source.
              #
              # - In create/response: always set - In update request: never
        },
      ],
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # Represents the execution of the test runner.
          #
          # The exit code of this tool will be used to determine if the test passed.
          #
          # - In response: always set - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
      "testIssues": [ # Issues observed during the test execution.
          #
          # For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.
          #
          # - In response: present if set by create or update - In create/update request: optional
        { # An abnormal event observed during the test execution.
          "stackTrace": { # A stacktrace. # Optional.
            "exception": "A String", # The stack trace message.
                #
                # Required
          },
          "errorMessage": "A String", # A brief human-readable message describing the abnormal event.
              #
              # Required.
        },
      ],
    },
    "toolExecutionStep": { # Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. # An execution of a tool (used for steps we don't explicitly support).
      "toolExecution": { # An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. # A Tool execution.
          #
          # - In response: present if set by create/update request - In create/update request: optional
        "toolLogs": [ # References to any plain text logs output the tool execution.
            #
            # This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.
            #
            # The maximum allowed number of tool logs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a file.
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
        ],
        "exitCode": { # Exit code from a tool execution. # Tool execution exit code. This field will be set once the tool has exited.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.
          "number": 42, # Tool execution exit code. A value of 0 means that the execution was successful.
              #
              # - In response: always set - In create/update request: always set
        },
        "toolOutputs": [ # References to opaque files of any format output by the tool execution.
            #
            # The maximum allowed number of tool outputs per step is 1000.
            #
            # - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list
          { # A reference to a ToolExecution output file.
            "testCase": { # A reference to a test case. # The test case to which this output file belongs.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
              "className": "A String", # The name of the class.
              "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
              "name": "A String", # The name of the test case.
                  #
                  # Required.
            },
            "output": { # A reference to a file. # A FileReference to an output file.
                #
                # - In response: always set - In create/update request: always set
              "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                  #
                  # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                  #
                  # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                  #
                  # - In response: always set - In create/update request: always set
            },
            "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
                #
                # - In response: present if set by create/update request - In create/update request: optional
                #
                # Example 1: Compute Timestamp from POSIX `time()`.
                #
                # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
                #
                # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
                #
                # struct timeval tv; gettimeofday(&tv, NULL);
                #
                # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
                #
                # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
                #
                # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
                #
                # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
                #
                # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
                #
                # long millis = System.currentTimeMillis();
                #
                # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
                #
                #
                #
                # Example 5: Compute Timestamp from current time in Python.
                #
                # timestamp = Timestamp() timestamp.GetCurrentTime()
              "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
              "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
            },
          },
        ],
        "commandLineArguments": [ # The full tokenized command line including the program name (equivalent to argv in a C program).
            #
            # - In response: present if set by create request - In create request: optional - In update request: never set
          "A String",
        ],
      },
    },
    "stepId": "A String", # A unique identifier within a Execution for this Step.
        #
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        #
        # - In response: always set - In create/update request: never set
    "runDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How long it took for this step to run.
        #
        # If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.
        #
        # - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
        #
        # - In response: present if set by create/update request - In create/update request: optional
    "labels": [ # Arbitrary user-supplied key/value pairs that are associated with the step.
        #
        # Users are responsible for managing the key namespace such that keys don't accidentally collide.
        #
        # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.
        #
        # - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step was created.
        #
        # - In response: always set - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "name": "A String", # A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build
        #
        # A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.
        #
        # - In response: always set - In create request: always set - In update request: never set
    "state": "A String", # The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE
        #
        # A PRECONDITION_FAILED will be returned if an invalid transition is requested.
        #
        # It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.
        #
        # - In response: always set - In create/update request: optional
    "completionTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The time when the step status was set to complete.
        #
        # This value will be set automatically when state transitions to COMPLETE.
        #
        # - In response: set if the execution state is COMPLETE. - In create/update request: never set
        #
        # Example 1: Compute Timestamp from POSIX `time()`.
        #
        # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
        #
        # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
        #
        # struct timeval tv; gettimeofday(&tv, NULL);
        #
        # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
        #
        # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
        #
        # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
        #
        # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
        #
        # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
        #
        # long millis = System.currentTimeMillis();
        #
        # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
        #
        #
        #
        # Example 5: Compute Timestamp from current time in Python.
        #
        # timestamp = Timestamp() timestamp.GetCurrentTime()
      "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
      "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
    },
    "dimensionValue": [ # If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.
        #
        # The keys must exactly match the dimension_definition of the execution.
        #
        # For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`
        #
        # If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`
        #
        # If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.
        #
        # A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.
        #
        # A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.
        #
        # A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.
        #
        # - In response: present if set by create - In create request: optional - In update request: never set
      {
        "value": "A String",
        "key": "A String",
      },
    ],
    "outcome": { # Interprets a result so that humans and machines can act on it. # Classification of the result, for example into SUCCESS or FAILURE
        #
        # - In response: present if set by create/update request - In create/update request: optional
      "inconclusiveDetail": { # More information about an INCONCLUSIVE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
          #
          # Optional
        "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.
            #
            # For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.
        "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.
      },
      "skippedDetail": { # More information about a SKIPPED outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
          #
          # Optional
        "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level.
        "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86.
        "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model.
      },
      "successDetail": { # More information about a SUCCESS outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
      },
      "failureDetail": { # More information about a FAILURE outcome.
          #
          # Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
          #
          # Optional
        "otherNativeCrash": True or False, # If a native process other than the app crashed.
        "crashed": True or False, # If the failure was severe because the system under test crashed.
        "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not start.
        "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.
        "timedOut": True or False, # If the test overran some time limit, and that is why it failed.
      },
      "summary": "A String", # The simplest way to interpret a result.
          #
          # Required
    },
    "deviceUsageDuration": { # A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # How much the device resource is used to perform the test.
        #
        # This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.
        #
        # PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.
        #
        # - In response: present if previously set. - In create request: optional - In update request: optional
        #
        # Example 1: Compute Duration from two Timestamps in pseudo code.
        #
        # Timestamp start = ...; Timestamp end = ...; Duration duration = ...;
        #
        # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;
        #
        # if (duration.seconds  0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }
        #
        # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
        #
        # Timestamp start = ...; Duration duration = ...; Timestamp end = ...;
        #
        # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;
        #
        # if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }
        #
        # Example 3: Compute Duration from datetime.timedelta in Python.
        #
        # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)
      "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
      "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
    },
    "hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
        #
        # - In response: always set - In create/update request: never set
  }
toolresults_v1beta3.projects.histories.executions.steps.thumbnails.html000066400000000000000000000401101300622755700361470ustar00rootroot00000000000000google-api-python-client-1.5.5/docs/dyn

Cloud Tool Results API . projects . histories . executions . steps . thumbnails

Instance Methods

list(projectId=None, historyId=None, executionId=None, stepId=None, pageSize=None, pageToken=None)

Lists thumbnails of images attached to a step.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(projectId=None, historyId=None, executionId=None, stepId=None, pageSize=None, pageToken=None) 
Lists thumbnails of images attached to a step.

May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, An Execution id.

Required. (required)
  stepId: string, A Step id.

Required. (required)
  pageSize: integer, The maximum number of thumbnails to fetch.

Default value: 50. The server will use this default if the field is not set or has a value of 0.

Optional.
  pageToken: string, A continuation token to resume the query at the next item.

Optional.

Returns:
  An object of the form:

    { # A response containing the thumbnails in a step.
    "nextPageToken": "A String", # A continuation token to resume the query at the next item.
        #
        # If set, indicates that there are more thumbnails to read, by calling list again with this value in the page_token field.
    "thumbnails": [ # A list of image data.
        #
        # Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep).
      { # An image, with a link to the main image and a thumbnail.
        "thumbnail": { # A single thumbnail, with its size and format. # The thumbnail.
          "data": "A String", # The thumbnail file itself.
              #
              # That is, the bytes here are precisely the bytes that make up the thumbnail file; they can be served as an image as-is (with the appropriate content type.)
              #
              # Always set.
          "widthPx": 42, # The width of the thumbnail, in pixels.
              #
              # Always set.
          "contentType": "A String", # The thumbnail's content type, i.e. "image/png".
              #
              # Always set.
          "heightPx": 42, # The height of the thumbnail, in pixels.
              #
              # Always set.
        },
        "stepId": "A String", # The step to which the image is attached.
            #
            # Always set.
        "sourceImage": { # A reference to a ToolExecution output file. # A reference to the full-size, original image.
            #
            # This is the same as the tool_outputs entry for the image under its Step.
            #
            # Always set.
          "testCase": { # A reference to a test case. # The test case to which this output file belongs.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.
            "className": "A String", # The name of the class.
            "testSuiteName": "A String", # The name of the test suite to which this test case belongs.
            "name": "A String", # The name of the test case.
                #
                # Required.
          },
          "output": { # A reference to a file. # A FileReference to an output file.
              #
              # - In response: always set - In create/update request: always set
            "fileUri": "A String", # The URI of a file stored in Google Cloud Storage.
                #
                # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000
                #
                # An INVALID_ARGUMENT error will be returned if the URI format is not supported.
                #
                # - In response: always set - In create/update request: always set
          },
          "creationTime": { # A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). # The creation time of the file.
              #
              # - In response: present if set by create/update request - In create/update request: optional
              #
              # Example 1: Compute Timestamp from POSIX `time()`.
              #
              # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);
              #
              # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
              #
              # struct timeval tv; gettimeofday(&tv, NULL);
              #
              # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);
              #
              # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
              #
              # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
              #
              # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
              #
              # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
              #
              # long millis = System.currentTimeMillis();
              #
              # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();
              #
              #
              #
              # Example 5: Compute Timestamp from current time in Python.
              #
              # timestamp = Timestamp() timestamp.GetCurrentTime()
            "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
            "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
          },
        },
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: # An error explaining why the thumbnail could not be rendered.
            #
            # - Simple to use and understand for most users - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][] field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
            { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
                #
                # Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
                #
                # Example 1: Pack and unpack a message in C++.
                #
                # Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
                #
                # Example 2: Pack and unpack a message in Java.
                #
                # Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
                #
                # Example 3: Pack and unpack a message in Python.
                #
                # foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
                #
                # The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
                #
                #
                #
                # JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
                #
                # package google.profile; message Person { string first_name = 1; string last_name = 2; }
                #
                # { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName":  }
                #
                # If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
                #
                # { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
              "typeUrl": "A String", # A URL/resource name whose content describes the type of the serialized protocol buffer message.
                  #
                  # For URLs which use the scheme `http`, `https`, or no scheme, the following restrictions and interpretations apply:
                  #
                  # * If no scheme is provided, `https` is assumed. * The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
                  #
                  # Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
              "value": "A String", # Must be a valid serialized protocol buffer of the above specified 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.
google-api-python-client-1.5.5/docs/dyn/toolresults_v1beta3.projects.histories.html000066400000000000000000000230271300622755700305470ustar00rootroot00000000000000

Cloud Tool Results API . projects . histories

Instance Methods

executions()

Returns the executions Resource.

create(projectId=None, body, requestId=None)

Creates a History.

get(projectId=None, historyId=None)

Gets a History.

list(projectId=None, pageToken=None, pageSize=None, filterByName=None)

Lists Histories for a given Project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(projectId=None, body, requestId=None) 
Creates a History.

The returned History will have the id set.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
      # 
      # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
    "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
        # 
        # - In response: present if set during create. - In create request: optional
    "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
        # 
        # - In response always set - In create request: always set
    "historyId": "A String", # A unique identifier within a project for this History.
        # 
        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
        # 
        # - In response always set - In create request: never set
  }

  requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID.

Optional, but strongly recommended.

Returns:
  An object of the form:

    { # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
        #
        # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
      "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
          #
          # - In response: present if set during create. - In create request: optional
      "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
          #
          # - In response always set - In create request: always set
      "historyId": "A String", # A unique identifier within a project for this History.
          #
          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
          #
          # - In response always set - In create request: never set
    }
get(projectId=None, historyId=None) 
Gets a History.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)

Returns:
  An object of the form:

    { # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
        #
        # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
      "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
          #
          # - In response: present if set during create. - In create request: optional
      "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
          #
          # - In response always set - In create request: always set
      "historyId": "A String", # A unique identifier within a project for this History.
          #
          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
          #
          # - In response always set - In create request: never set
    }
list(projectId=None, pageToken=None, pageSize=None, filterByName=None) 
Lists Histories for a given Project.

The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist

Args:
  projectId: string, A Project id.

Required. (required)
  pageToken: string, A continuation token to resume the query at the next item.

Optional.
  pageSize: integer, The maximum number of Histories to fetch.

Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100.

Optional.
  filterByName: string, If set, only return histories with the given name.

Optional.

Returns:
  An object of the form:

    { # Response message for HistoryService.List
    "nextPageToken": "A String", # A continuation token to resume the query at the next item.
        #
        # Will only be set if there are more histories to fetch.
        #
        # Tokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes.
    "histories": [ # Histories.
      { # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
            #
            # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
          "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
              #
              # - In response: present if set during create. - In create request: optional
          "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
              #
              # - In response always set - In create request: always set
          "historyId": "A String", # A unique identifier within a project for this History.
              #
              # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
              #
              # - In response always set - In create request: never set
        },
    ],
  }
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.
google-api-python-client-1.5.5/docs/dyn/toolresults_v1beta3.projects.html000066400000000000000000000106671300622755700265450ustar00rootroot00000000000000

Cloud Tool Results API . projects

Instance Methods

histories()

Returns the histories Resource.

getSettings(projectId=None)

Gets the Tool Results settings for a project.

initializeSettings(projectId=None)

Creates resources for settings which have not yet been set.

Method Details

getSettings(projectId=None) 
Gets the Tool Results settings for a project.

May return any of the following canonical error codes:

- PERMISSION_DENIED - if the user is not authorized to read from project

Args:
  projectId: string, A Project id.

Required. (required)

Returns:
  An object of the form:

    { # Per-project settings for the Tool Results service.
    "defaultBucket": "A String", # The name of the Google Cloud Storage bucket to which results are written.
        #
        # By default, this is unset.
        #
        # In update request: optional In response: optional
    "name": "A String", # The name of the project's settings.
        #
        # Always of the form: projects/{project-id}/settings
        #
        # In update request: never set In response: always set
  }
initializeSettings(projectId=None) 
Creates resources for settings which have not yet been set.

Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.

The bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.

If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.

May return any canonical error codes, including the following:

- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage

Args:
  projectId: string, A Project id.

Required. (required)

Returns:
  An object of the form:

    { # Per-project settings for the Tool Results service.
    "defaultBucket": "A String", # The name of the Google Cloud Storage bucket to which results are written.
        #
        # By default, this is unset.
        #
        # In update request: optional In response: optional
    "name": "A String", # The name of the project's settings.
        #
        # Always of the form: projects/{project-id}/settings
        #
        # In update request: never set In response: always set
  }
google-api-python-client-1.5.5/docs/dyn/translate_v2.detections.html000066400000000000000000000036221300622755700255260ustar00rootroot00000000000000

Translate API . detections

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
        },
      ],
    ],
  }
google-api-python-client-1.5.5/docs/dyn/translate_v2.html000066400000000000000000000046271300622755700233740ustar00rootroot00000000000000

Translate API

Instance Methods

detections()

Returns the detections Resource.

languages()

Returns the languages Resource.

translations()

Returns the translations Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/translate_v2.languages.html000066400000000000000000000040161300622755700253310ustar00rootroot00000000000000

Translate API . languages

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.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/translate_v2.translations.html000066400000000000000000000043221300622755700261040ustar00rootroot00000000000000

Translate API . translations

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.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/urlshortener_v1.html000066400000000000000000000041131300622755700241200ustar00rootroot00000000000000

URL Shortener API

Instance Methods

url()

Returns the url Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/urlshortener_v1.url.html000066400000000000000000001255311300622755700247310ustar00rootroot00000000000000

URL Shortener API . url

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).
  }
google-api-python-client-1.5.5/docs/dyn/vision_v1.html000066400000000000000000000041161300622755700226760ustar00rootroot00000000000000

Google Cloud Vision API

Instance Methods

images()

Returns the images Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/vision_v1.images.html000066400000000000000000001436111300622755700241460ustar00rootroot00000000000000

Google Cloud Vision API . images

Instance Methods

annotate(body, x__xgafv=None)

Run image detection and annotation for a batch of images.

Method Details

annotate(body, x__xgafv=None) 
Run image detection and annotation for a batch of images.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Multiple image annotation requests are batched into a single service call.
    "requests": [ # Individual image annotation requests for this batch.
      { # Request for performing Google Cloud Vision API tasks over a user-provided
          # image, with user-requested features.
        "imageContext": { # Image context. # Additional context that may accompany the image.
          "latLongRect": { # Rectangle determined by min and max LatLng pairs. # Lat/long rectangle that specifies the location of the image.
            "minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min lat/long pair.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
            "maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max lat/long pair.
                # of doubles representing degrees latitude and degrees longitude. Unless
                # specified otherwise, this must conform to the
                # WGS84
                # standard. Values must be within normalized ranges.
                #
                # Example of normalization code in Python:
                #
                #     def NormalizeLongitude(longitude):
                #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                #       q, r = divmod(longitude, 360.0)
                #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                #         return r - 360.0
                #       return r
                #
                #     def NormalizeLatLng(latitude, longitude):
                #       """Wraps decimal degrees latitude and longitude to
                #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                #       r = latitude % 360.0
                #       if r <= 90.0:
                #         return r, NormalizeLongitude(longitude)
                #       elif r >= 270.0:
                #         return r - 360, NormalizeLongitude(longitude)
                #       else:
                #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                #
                #     assert 180.0 == NormalizeLongitude(180.0)
                #     assert -180.0 == NormalizeLongitude(-180.0)
                #     assert -179.0 == NormalizeLongitude(181.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
              "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
          "languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value
              # yields the best results since it enables automatic language detection. For
              # languages based on the Latin alphabet, setting `language_hints` is not
              # needed. In rare cases, when the language of the text in the image is known,
              # setting a hint will help get better results (although it will be a
              # significant hindrance if the hint is wrong). Text detection returns an
              # error if one or more of the specified languages is not one of the
              # [supported
              # languages](/translate/v2/translate-reference#supported_languages).
            "A String",
          ],
        },
        "image": { # Client image to perform Google Cloud Vision API tasks over. # The image to be processed.
          "content": "A String", # Image content, represented as a stream of bytes.
              # Note: as with all `bytes` fields, protobuffers use a pure binary
              # representation, whereas JSON representations use base64.
          "source": { # External image source (Google Cloud Storage image location). # Google Cloud Storage image location. If both 'content' and 'source'
              # are filled for an image, 'content' takes precedence and it will be
              # used for performing the image annotation request.
            "gcsImageUri": "A String", # Google Cloud Storage image URI. It must be in the following form:
                # `gs://bucket_name/object_name`. For more
                # details, please see: https://cloud.google.com/storage/docs/reference-uris.
                # NOTE: Cloud Storage object versioning is not supported!
          },
        },
        "features": [ # Requested features.
          { # The Feature indicates what type of image detection task to perform.
              # Users describe the type of Google Cloud Vision API tasks to perform over
              # images by using Features. Features encode the Cloud Vision API
              # vertical to operate on and the number of top-scoring results to return.
            "type": "A String", # The feature type.
            "maxResults": 42, # Maximum number of results of this type.
          },
        ],
      },
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to a batch image annotation request.
    "responses": [ # Individual responses to image annotation requests within the batch.
      { # Response to an image annotation request.
        "safeSearchAnnotation": { # Set of features pertaining to the image, computed by various computer vision # If present, safe-search annotation completed successfully.
            # methods over safe-search verticals (for example, adult, spoof, medical,
            # violence).
          "medical": "A String", # Likelihood this is a medical image.
          "violence": "A String", # Violence likelihood.
          "spoof": "A String", # Spoof likelihood. The likelihood that an obvious modification
              # was made to the image's canonical version to make it appear
              # funny or offensive.
          "adult": "A String", # Represents the adult contents likelihood for the image.
        },
        "textAnnotations": [ # If present, text (OCR) detection completed successfully.
          { # Set of detected entity features.
            "confidence": 3.14, # The accuracy of the entity detection in an image.
                # For example, for an image containing 'Eiffel Tower,' this field represents
                # the confidence that there is a tower in the query image. Range [0, 1].
            "description": "A String", # Entity textual description, expressed in its locale language.
            "locale": "A String", # The language code for the locale in which the entity textual
                # description (next field) is expressed.
            "topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the
                # image. For example, the relevancy of 'tower' to an image containing
                # 'Eiffel Tower' is likely higher than an image containing a distant towering
                # building, though the confidence that there is a tower may be the same.
                # Range [0, 1].
            "mid": "A String", # Opaque entity ID. Some IDs might be available in Knowledge Graph(KG).
                # For more details on KG please see:
                # https://developers.google.com/knowledge-graph/
            "locations": [ # The location information for the detected entity. Multiple
                # LocationInfo elements can be present since one location may
                # indicate the location of the scene in the query image, and another the
                # location of the place where the query image was taken. Location information
                # is usually present for landmarks.
              { # Detected entity location information.
                "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Lat - long location coordinates.
                    # of doubles representing degrees latitude and degrees longitude. Unless
                    # specified otherwise, this must conform to the
                    # WGS84
                    # standard. Values must be within normalized ranges.
                    #
                    # Example of normalization code in Python:
                    #
                    #     def NormalizeLongitude(longitude):
                    #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                    #       q, r = divmod(longitude, 360.0)
                    #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                    #         return r - 360.0
                    #       return r
                    #
                    #     def NormalizeLatLng(latitude, longitude):
                    #       """Wraps decimal degrees latitude and longitude to
                    #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                    #       r = latitude % 360.0
                    #       if r <= 90.0:
                    #         return r, NormalizeLongitude(longitude)
                    #       elif r >= 270.0:
                    #         return r - 360, NormalizeLongitude(longitude)
                    #       else:
                    #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                    #
                    #     assert 180.0 == NormalizeLongitude(180.0)
                    #     assert -180.0 == NormalizeLongitude(-180.0)
                    #     assert -179.0 == NormalizeLongitude(181.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                    #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                    #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                    #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                    #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                  "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                  "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
                },
              },
            ],
            "score": 3.14, # Overall score of the result. Range [0, 1].
            "boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not filled currently
                # for `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR), `boundingPoly`s
                # are produced for the entire text detected in an image region, followed by
                # `boundingPoly`s for each word within the detected text.
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
            "properties": [ # Some entities can have additional optional Property fields.
                # For example a different kind of score or string that qualifies the entity.
              { # Arbitrary name/value pair.
                "name": "A String", # Name of the property.
                "value": "A String", # Value of the property.
              },
            ],
          },
        ],
        "labelAnnotations": [ # If present, label detection completed successfully.
          { # Set of detected entity features.
            "confidence": 3.14, # The accuracy of the entity detection in an image.
                # For example, for an image containing 'Eiffel Tower,' this field represents
                # the confidence that there is a tower in the query image. Range [0, 1].
            "description": "A String", # Entity textual description, expressed in its locale language.
            "locale": "A String", # The language code for the locale in which the entity textual
                # description (next field) is expressed.
            "topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the
                # image. For example, the relevancy of 'tower' to an image containing
                # 'Eiffel Tower' is likely higher than an image containing a distant towering
                # building, though the confidence that there is a tower may be the same.
                # Range [0, 1].
            "mid": "A String", # Opaque entity ID. Some IDs might be available in Knowledge Graph(KG).
                # For more details on KG please see:
                # https://developers.google.com/knowledge-graph/
            "locations": [ # The location information for the detected entity. Multiple
                # LocationInfo elements can be present since one location may
                # indicate the location of the scene in the query image, and another the
                # location of the place where the query image was taken. Location information
                # is usually present for landmarks.
              { # Detected entity location information.
                "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Lat - long location coordinates.
                    # of doubles representing degrees latitude and degrees longitude. Unless
                    # specified otherwise, this must conform to the
                    # WGS84
                    # standard. Values must be within normalized ranges.
                    #
                    # Example of normalization code in Python:
                    #
                    #     def NormalizeLongitude(longitude):
                    #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                    #       q, r = divmod(longitude, 360.0)
                    #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                    #         return r - 360.0
                    #       return r
                    #
                    #     def NormalizeLatLng(latitude, longitude):
                    #       """Wraps decimal degrees latitude and longitude to
                    #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                    #       r = latitude % 360.0
                    #       if r <= 90.0:
                    #         return r, NormalizeLongitude(longitude)
                    #       elif r >= 270.0:
                    #         return r - 360, NormalizeLongitude(longitude)
                    #       else:
                    #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                    #
                    #     assert 180.0 == NormalizeLongitude(180.0)
                    #     assert -180.0 == NormalizeLongitude(-180.0)
                    #     assert -179.0 == NormalizeLongitude(181.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                    #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                    #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                    #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                    #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                  "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                  "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
                },
              },
            ],
            "score": 3.14, # Overall score of the result. Range [0, 1].
            "boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not filled currently
                # for `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR), `boundingPoly`s
                # are produced for the entire text detected in an image region, followed by
                # `boundingPoly`s for each word within the detected text.
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
            "properties": [ # Some entities can have additional optional Property fields.
                # For example a different kind of score or string that qualifies the entity.
              { # Arbitrary name/value pair.
                "name": "A String", # Name of the property.
                "value": "A String", # Value of the property.
              },
            ],
          },
        ],
        "imagePropertiesAnnotation": { # Stores image properties (e.g. dominant colors). # If present, image properties were extracted successfully.
          "dominantColors": { # Set of dominant colors and their corresponding scores. # If present, dominant colors completed successfully.
            "colors": [ # RGB color values, with their score and pixel fraction.
              { # Color information consists of RGB channels, score and fraction of
                  # image the color occupies in the image.
                "color": { # Represents a color in the RGBA color space. This representation is designed # RGB components of the color.
                    # for simplicity of conversion to/from color representations in various
                    # languages over compactness; for example, the fields of this representation
                    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
                    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
                    # method in iOS; and, with just a little work, it can be easily formatted into
                    # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
                    #
                    # Example (Java):
                    #
                    #      import com.google.type.Color;
                    #
                    #      // ...
                    #      public static java.awt.Color fromProto(Color protocolor) {
                    #        float alpha = protocolor.hasAlpha()
                    #            ? protocolor.getAlpha().getValue()
                    #            : 1.0;
                    #
                    #        return new java.awt.Color(
                    #            protocolor.getRed(),
                    #            protocolor.getGreen(),
                    #            protocolor.getBlue(),
                    #            alpha);
                    #      }
                    #
                    #      public static Color toProto(java.awt.Color color) {
                    #        float red = (float) color.getRed();
                    #        float green = (float) color.getGreen();
                    #        float blue = (float) color.getBlue();
                    #        float denominator = 255.0;
                    #        Color.Builder resultBuilder =
                    #            Color
                    #                .newBuilder()
                    #                .setRed(red / denominator)
                    #                .setGreen(green / denominator)
                    #                .setBlue(blue / denominator);
                    #        int alpha = color.getAlpha();
                    #        if (alpha != 255) {
                    #          result.setAlpha(
                    #              FloatValue
                    #                  .newBuilder()
                    #                  .setValue(((float) alpha) / denominator)
                    #                  .build());
                    #        }
                    #        return resultBuilder.build();
                    #      }
                    #      // ...
                    #
                    # Example (iOS / Obj-C):
                    #
                    #      // ...
                    #      static UIColor* fromProto(Color* protocolor) {
                    #         float red = [protocolor red];
                    #         float green = [protocolor green];
                    #         float blue = [protocolor blue];
                    #         FloatValue* alpha_wrapper = [protocolor alpha];
                    #         float alpha = 1.0;
                    #         if (alpha_wrapper != nil) {
                    #           alpha = [alpha_wrapper value];
                    #         }
                    #         return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
                    #      }
                    #
                    #      static Color* toProto(UIColor* color) {
                    #          CGFloat red, green, blue, alpha;
                    #          if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
                    #            return nil;
                    #          }
                    #          Color* result = [Color alloc] init];
                    #          [result setRed:red];
                    #          [result setGreen:green];
                    #          [result setBlue:blue];
                    #          if (alpha <= 0.9999) {
                    #            [result setAlpha:floatWrapperWithValue(alpha)];
                    #          }
                    #          [result autorelease];
                    #          return result;
                    #     }
                    #     // ...
                    #
                    #  Example (JavaScript):
                    #
                    #     // ...
                    #
                    #     var protoToCssColor = function(rgb_color) {
                    #        var redFrac = rgb_color.red || 0.0;
                    #        var greenFrac = rgb_color.green || 0.0;
                    #        var blueFrac = rgb_color.blue || 0.0;
                    #        var red = Math.floor(redFrac * 255);
                    #        var green = Math.floor(greenFrac * 255);
                    #        var blue = Math.floor(blueFrac * 255);
                    #
                    #        if (!('alpha' in rgb_color)) {
                    #           return rgbToCssColor_(red, green, blue);
                    #        }
                    #
                    #        var alphaFrac = rgb_color.alpha.value || 0.0;
                    #        var rgbParams = [red, green, blue].join(',');
                    #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
                    #     };
                    #
                    #     var rgbToCssColor_ = function(red, green, blue) {
                    #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
                    #       var hexString = rgbNumber.toString(16);
                    #       var missingZeros = 6 - hexString.length;
                    #       var resultBuilder = ['#'];
                    #       for (var i = 0; i < missingZeros; i++) {
                    #          resultBuilder.push('0');
                    #       }
                    #       resultBuilder.push(hexString);
                    #       return resultBuilder.join('');
                    #     };
                    #
                    #     // ...
                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
                      # the final pixel color is defined by the equation:
                      #
                      #   pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
                      #
                      # This means that a value of 1.0 corresponds to a solid color, whereas
                      # a value of 0.0 corresponds to a completely transparent color. This
                      # uses a wrapper message rather than a simple float scalar so that it is
                      # possible to distinguish between a default value and the value being unset.
                      # If omitted, this color object is to be rendered as a solid color
                      # (as if the alpha value had been explicitly given with a value of 1.0).
                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                },
                "pixelFraction": 3.14, # Stores the fraction of pixels the color occupies in the image.
                    # Value in range [0, 1].
                "score": 3.14, # Image-specific score for this color. Value in range [0, 1].
              },
            ],
          },
        },
        "faceAnnotations": [ # If present, face detection completed successfully.
          { # A face annotation object contains the results of face detection.
            "panAngle": 3.14, # Yaw angle. Indicates the leftward/rightward angle that the face is
                # pointing, relative to the vertical plane perpendicular to the image. Range
                # [-180,180].
            "sorrowLikelihood": "A String", # Sorrow likelihood.
            "underExposedLikelihood": "A String", # Under-exposed likelihood.
            "detectionConfidence": 3.14, # Detection confidence. Range [0, 1].
            "joyLikelihood": "A String", # Joy likelihood.
            "landmarks": [ # Detected face landmarks.
              { # A face-specific landmark (for example, a face feature).
                  # Landmark positions may fall outside the bounds of the image
                  # when the face is near one or more edges of the image.
                  # Therefore it is NOT guaranteed that 0 <= x < width or 0 <= y < height.
                "position": { # A 3D position in the image, used primarily for Face detection landmarks. # Face landmark position.
                    # A valid Position must have both x and y coordinates.
                    # The position coordinates are in the same scale as the original image.
                  "y": 3.14, # Y coordinate.
                  "x": 3.14, # X coordinate.
                  "z": 3.14, # Z coordinate (or depth).
                },
                "type": "A String", # Face landmark type.
              },
            ],
            "surpriseLikelihood": "A String", # Surprise likelihood.
            "blurredLikelihood": "A String", # Blurred likelihood.
            "tiltAngle": 3.14, # Pitch angle. Indicates the upwards/downwards angle that the face is
                # pointing
                # relative to the image's horizontal plane. Range [-180,180].
            "angerLikelihood": "A String", # Anger likelihood.
            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the face. The coordinates of the bounding box
                # are in the original image's scale, as returned in ImageParams.
                # The bounding box is computed to "frame" the face in accordance with human
                # expectations. It is based on the landmarker results.
                # Note that one or more x and/or y coordinates may not be generated in the
                # BoundingPoly (the polygon will be unbounded) if only a partial face appears in
                # the image to be annotated.
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
            "rollAngle": 3.14, # Roll angle. Indicates the amount of clockwise/anti-clockwise rotation of
                # the
                # face relative to the image vertical, about the axis perpendicular to the
                # face. Range [-180,180].
            "headwearLikelihood": "A String", # Headwear likelihood.
            "fdBoundingPoly": { # A bounding polygon for the detected image annotation. # This bounding polygon is tighter than the previous
                # boundingPoly, and
                # encloses only the skin part of the face. Typically, it is used to
                # eliminate the face from any image analysis that detects the
                # "amount of skin" visible in an image. It is not based on the
                # landmarker results, only on the initial face detection, hence
                # the fd (face detection) prefix.
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
            "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].
          },
        ],
        "logoAnnotations": [ # If present, logo detection completed successfully.
          { # Set of detected entity features.
            "confidence": 3.14, # The accuracy of the entity detection in an image.
                # For example, for an image containing 'Eiffel Tower,' this field represents
                # the confidence that there is a tower in the query image. Range [0, 1].
            "description": "A String", # Entity textual description, expressed in its locale language.
            "locale": "A String", # The language code for the locale in which the entity textual
                # description (next field) is expressed.
            "topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the
                # image. For example, the relevancy of 'tower' to an image containing
                # 'Eiffel Tower' is likely higher than an image containing a distant towering
                # building, though the confidence that there is a tower may be the same.
                # Range [0, 1].
            "mid": "A String", # Opaque entity ID. Some IDs might be available in Knowledge Graph(KG).
                # For more details on KG please see:
                # https://developers.google.com/knowledge-graph/
            "locations": [ # The location information for the detected entity. Multiple
                # LocationInfo elements can be present since one location may
                # indicate the location of the scene in the query image, and another the
                # location of the place where the query image was taken. Location information
                # is usually present for landmarks.
              { # Detected entity location information.
                "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Lat - long location coordinates.
                    # of doubles representing degrees latitude and degrees longitude. Unless
                    # specified otherwise, this must conform to the
                    # WGS84
                    # standard. Values must be within normalized ranges.
                    #
                    # Example of normalization code in Python:
                    #
                    #     def NormalizeLongitude(longitude):
                    #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                    #       q, r = divmod(longitude, 360.0)
                    #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                    #         return r - 360.0
                    #       return r
                    #
                    #     def NormalizeLatLng(latitude, longitude):
                    #       """Wraps decimal degrees latitude and longitude to
                    #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                    #       r = latitude % 360.0
                    #       if r <= 90.0:
                    #         return r, NormalizeLongitude(longitude)
                    #       elif r >= 270.0:
                    #         return r - 360, NormalizeLongitude(longitude)
                    #       else:
                    #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                    #
                    #     assert 180.0 == NormalizeLongitude(180.0)
                    #     assert -180.0 == NormalizeLongitude(-180.0)
                    #     assert -179.0 == NormalizeLongitude(181.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                    #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                    #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                    #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                    #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                  "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                  "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
                },
              },
            ],
            "score": 3.14, # Overall score of the result. Range [0, 1].
            "boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not filled currently
                # for `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR), `boundingPoly`s
                # are produced for the entire text detected in an image region, followed by
                # `boundingPoly`s for each word within the detected text.
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
            "properties": [ # Some entities can have additional optional Property fields.
                # For example a different kind of score or string that qualifies the entity.
              { # Arbitrary name/value pair.
                "name": "A String", # Name of the property.
                "value": "A String", # Value of the property.
              },
            ],
          },
        ],
        "landmarkAnnotations": [ # If present, landmark detection completed successfully.
          { # Set of detected entity features.
            "confidence": 3.14, # The accuracy of the entity detection in an image.
                # For example, for an image containing 'Eiffel Tower,' this field represents
                # the confidence that there is a tower in the query image. Range [0, 1].
            "description": "A String", # Entity textual description, expressed in its locale language.
            "locale": "A String", # The language code for the locale in which the entity textual
                # description (next field) is expressed.
            "topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the
                # image. For example, the relevancy of 'tower' to an image containing
                # 'Eiffel Tower' is likely higher than an image containing a distant towering
                # building, though the confidence that there is a tower may be the same.
                # Range [0, 1].
            "mid": "A String", # Opaque entity ID. Some IDs might be available in Knowledge Graph(KG).
                # For more details on KG please see:
                # https://developers.google.com/knowledge-graph/
            "locations": [ # The location information for the detected entity. Multiple
                # LocationInfo elements can be present since one location may
                # indicate the location of the scene in the query image, and another the
                # location of the place where the query image was taken. Location information
                # is usually present for landmarks.
              { # Detected entity location information.
                "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Lat - long location coordinates.
                    # of doubles representing degrees latitude and degrees longitude. Unless
                    # specified otherwise, this must conform to the
                    # WGS84
                    # standard. Values must be within normalized ranges.
                    #
                    # Example of normalization code in Python:
                    #
                    #     def NormalizeLongitude(longitude):
                    #       """Wraps decimal degrees longitude to [-180.0, 180.0]."""
                    #       q, r = divmod(longitude, 360.0)
                    #       if r > 180.0 or (r == 180.0 and q <= -1.0):
                    #         return r - 360.0
                    #       return r
                    #
                    #     def NormalizeLatLng(latitude, longitude):
                    #       """Wraps decimal degrees latitude and longitude to
                    #       [-90.0, 90.0] and [-180.0, 180.0], respectively."""
                    #       r = latitude % 360.0
                    #       if r <= 90.0:
                    #         return r, NormalizeLongitude(longitude)
                    #       elif r >= 270.0:
                    #         return r - 360, NormalizeLongitude(longitude)
                    #       else:
                    #         return 180 - r, NormalizeLongitude(longitude + 180.0)
                    #
                    #     assert 180.0 == NormalizeLongitude(180.0)
                    #     assert -180.0 == NormalizeLongitude(-180.0)
                    #     assert -179.0 == NormalizeLongitude(181.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
                    #     assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
                    #     assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
                    #     assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
                    #     assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
                    #     assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
                    #     assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
                    #     assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
                  "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
                  "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
                },
              },
            ],
            "score": 3.14, # Overall score of the result. Range [0, 1].
            "boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not filled currently
                # for `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR), `boundingPoly`s
                # are produced for the entire text detected in an image region, followed by
                # `boundingPoly`s for each word within the detected text.
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
            "properties": [ # Some entities can have additional optional Property fields.
                # For example a different kind of score or string that qualifies the entity.
              { # Arbitrary name/value pair.
                "name": "A String", # Name of the property.
                "value": "A String", # Value of the property.
              },
            ],
          },
        ],
        "error": { # The `Status` type defines a logical error model that is suitable for different # If set, represents the error message for the operation.
            # Note that filled-in mage annotations are guaranteed to be
            # correct, even when error is non-empty.
            # programming environments, including REST APIs and RPC APIs. It is used by
            # [gRPC](https://github.com/grpc). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error message,
            # and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` which can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting purpose.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There will be a
              # common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/webfonts_v1.html000066400000000000000000000041331300622755700232150ustar00rootroot00000000000000

Google Fonts Developer API

Instance Methods

webfonts()

Returns the webfonts Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/webfonts_v1.webfonts.html000066400000000000000000000053271300622755700250510ustar00rootroot00000000000000

Google Fonts Developer API . webfonts

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.
      {
        "category": "A String", # The category of the font.
        "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.
  }
google-api-python-client-1.5.5/docs/dyn/webmasters_v3.html000066400000000000000000000054261300622755700235520ustar00rootroot00000000000000

Search Console API

Instance Methods

searchanalytics()

Returns the searchanalytics Resource.

sitemaps()

Returns the sitemaps Resource.

sites()

Returns the sites Resource.

urlcrawlerrorscounts()

Returns the urlcrawlerrorscounts Resource.

urlcrawlerrorssamples()

Returns the urlcrawlerrorssamples Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/webmasters_v3.searchanalytics.html000066400000000000000000000120331300622755700267160ustar00rootroot00000000000000

Search Console API . searchanalytics

Instance Methods

query(siteUrl, body)

Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days.

Method Details

query(siteUrl, body) 
Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days.

When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "startDate": "A String", # [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.
    "endDate": "A String", # [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.
    "dimensions": [ # [Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.
      "A String",
    ],
    "searchType": "A String", # [Optional; Default is "web"] The search type to filter for.
    "dimensionFilterGroups": [ # [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case-sensitive). You can filter by a dimension without grouping by it.
      {
        "groupType": "A String",
        "filters": [
          {
            "operator": "A String",
            "expression": "A String",
            "dimension": "A String",
          },
        ],
      },
    ],
    "startRow": 42, # [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.
    "rowLimit": 42, # [Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).
    "aggregationType": "A String", # [Optional; Default is "auto"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see  the help documentation to learn how data is calculated differently by site versus by page.
        # 
        # Note: If you group or filter by page, you cannot aggregate by property.
        # 
        # If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.
  }


Returns:
  An object of the form:

    { # A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.
    "rows": [ # A list of rows grouped by the key values in the order given in the query.
      {
        "keys": [
          "A String",
        ],
        "impressions": 3.14,
        "clicks": 3.14,
        "ctr": 3.14,
        "position": 3.14,
      },
    ],
    "responseAggregationType": "A String", # How the results were aggregated.
  }
google-api-python-client-1.5.5/docs/dyn/webmasters_v3.sitemaps.html000066400000000000000000000144711300622755700253760ustar00rootroot00000000000000

Search Console API . sitemaps

Instance Methods

delete(siteUrl, feedpath)

Deletes a sitemap from this site.

get(siteUrl, feedpath)

Retrieves information about a specific sitemap.

list(siteUrl, sitemapIndex=None)

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

submit(siteUrl, feedpath)

Submits a sitemap for a site.

Method Details

delete(siteUrl, feedpath) 
Deletes a sitemap from this site.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
get(siteUrl, feedpath) 
Retrieves information about a specific sitemap.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)

Returns:
  An object of the form:

    { # Contains detailed information about a specific URL submitted as a sitemap.
    "errors": "A String", # Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
    "warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
    "isPending": True or False, # If true, the sitemap has not been processed.
    "lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
    "isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
    "lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
    "path": "A String", # The url of the sitemap.
    "type": "A String", # The type of the sitemap. For example: rssFeed.
    "contents": [ # The various content types in the sitemap.
      { # Information about the various content types in the sitemap.
        "indexed": "A String", # The number of URLs from the sitemap that were indexed (of the content type).
        "type": "A String", # The specific type of content in this sitemap. For example: web.
        "submitted": "A String", # The number of URLs in the sitemap (of the content type).
      },
    ],
  }
list(siteUrl, sitemapIndex=None) 
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  sitemapIndex: string, A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml

Returns:
  An object of the form:

    { # List of sitemaps.
    "sitemap": [ # Contains detailed information about a specific URL submitted as a sitemap.
      { # Contains detailed information about a specific URL submitted as a sitemap.
        "errors": "A String", # Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
        "warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
        "isPending": True or False, # If true, the sitemap has not been processed.
        "lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
        "isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
        "lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
        "path": "A String", # The url of the sitemap.
        "type": "A String", # The type of the sitemap. For example: rssFeed.
        "contents": [ # The various content types in the sitemap.
          { # Information about the various content types in the sitemap.
            "indexed": "A String", # The number of URLs from the sitemap that were indexed (of the content type).
            "type": "A String", # The specific type of content in this sitemap. For example: web.
            "submitted": "A String", # The number of URLs in the sitemap (of the content type).
          },
        ],
      },
    ],
  }
submit(siteUrl, feedpath) 
Submits a sitemap for a site.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  feedpath: string, The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml (required)
google-api-python-client-1.5.5/docs/dyn/webmasters_v3.sites.html000066400000000000000000000067071300622755700247030ustar00rootroot00000000000000

Search Console API . sites

Instance Methods

add(siteUrl)

Adds a site to the set of the user's sites in Search Console.

delete(siteUrl)

Removes a site from the set of the user's Search Console sites.

get(siteUrl)

Retrieves information about specific site.

list()

Lists the user's Search Console sites.

Method Details

add(siteUrl) 
Adds a site to the set of the user's sites in Search Console.

Args:
  siteUrl: string, The URL of the site to add. (required)
delete(siteUrl) 
Removes a site from the set of the user's Search Console sites.

Args:
  siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)
get(siteUrl) 
Retrieves information about specific site.

Args:
  siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)

Returns:
  An object of the form:

    { # Contains permission level information about a Search Console site. For more information, see  Permissions in Search Console.
    "permissionLevel": "A String", # The user's permission level for the site.
    "siteUrl": "A String", # The URL of the site.
  }
list() 
Lists the user's Search Console sites.

Args:

Returns:
  An object of the form:

    { # List of sites with access level information.
    "siteEntry": [ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
      { # Contains permission level information about a Search Console site. For more information, see  Permissions in Search Console.
        "permissionLevel": "A String", # The user's permission level for the site.
        "siteUrl": "A String", # The URL of the site.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/webmasters_v3.urlcrawlerrorscounts.html000066400000000000000000000062641300622755700300760ustar00rootroot00000000000000

Search Console API . urlcrawlerrorscounts

Instance Methods

query(siteUrl, category=None, platform=None, latestCountsOnly=None)

Retrieves a time series of the number of URL crawl errors per error category and platform.

Method Details

query(siteUrl, category=None, platform=None, latestCountsOnly=None) 
Retrieves a time series of the number of URL crawl errors per error category and platform.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  category: string, The crawl error category. For example: serverError. If not specified, returns results for all categories.
    Allowed values
      authPermissions - 
      flashContent - 
      manyToOneRedirect - 
      notFollowed - 
      notFound - 
      other - 
      roboted - 
      serverError - 
      soft404 - 
  platform: string, The user agent type (platform) that made the request. For example: web. If not specified, returns results for all platforms.
    Allowed values
      mobile - 
      smartphoneOnly - 
      web - 
  latestCountsOnly: boolean, If true, returns only the latest crawl error counts.

Returns:
  An object of the form:

    { # A time series of the number of URL crawl errors per error category and platform.
    "countPerTypes": [ # The time series of the number of URL crawl errors per error category and platform.
      { # Number of errors per day for a specific error type (defined by platform and category).
        "category": "A String", # The crawl error type.
        "platform": "A String", # The general type of Googlebot that made the request (see list of Googlebot user-agents for the user-agents used).
        "entries": [ # The error count entries time series.
          { # An entry in a URL crawl errors time series.
            "count": "A String", # The error count at the given timestamp.
            "timestamp": "A String", # The date and time when the crawl attempt took place, in RFC 3339 format.
          },
        ],
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/webmasters_v3.urlcrawlerrorssamples.html000066400000000000000000000142571300622755700302300ustar00rootroot00000000000000

Search Console API . urlcrawlerrorssamples

Instance Methods

get(siteUrl, url, category, platform)

Retrieves details about crawl errors for a site's sample URL.

list(siteUrl, category, platform)

Lists a site's sample URLs for the specified crawl error category and platform.

markAsFixed(siteUrl, url, category, platform)

Marks the provided site's sample URL as fixed, and removes it from the samples list.

Method Details

get(siteUrl, url, category, platform) 
Retrieves details about crawl errors for a site's sample URL.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  url: string, The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename (required)
  category: string, The crawl error category. For example: authPermissions (required)
    Allowed values
      authPermissions - 
      flashContent - 
      manyToOneRedirect - 
      notFollowed - 
      notFound - 
      other - 
      roboted - 
      serverError - 
      soft404 - 
  platform: string, The user agent type (platform) that made the request. For example: web (required)
    Allowed values
      mobile - 
      smartphoneOnly - 
      web - 

Returns:
  An object of the form:

    { # Contains information about specific crawl errors.
    "urlDetails": { # Additional details about the URL, set only when calling get(). # Additional details about the URL, set only when calling get().
      "containingSitemaps": [ # List of sitemaps pointing at this URL.
        "A String",
      ],
      "linkedFromUrls": [ # A sample set of URLs linking to this URL.
        "A String",
      ],
    },
    "first_detected": "A String", # The time the error was first detected, in RFC 3339 format.
    "pageUrl": "A String", # The URL of an error, relative to the site.
    "responseCode": 42, # The HTTP response code, if any.
    "last_crawled": "A String", # The time when the URL was last crawled, in RFC 3339 format.
  }
list(siteUrl, category, platform) 
Lists a site's sample URLs for the specified crawl error category and platform.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  category: string, The crawl error category. For example: authPermissions (required)
    Allowed values
      authPermissions - 
      flashContent - 
      manyToOneRedirect - 
      notFollowed - 
      notFound - 
      other - 
      roboted - 
      serverError - 
      soft404 - 
  platform: string, The user agent type (platform) that made the request. For example: web (required)
    Allowed values
      mobile - 
      smartphoneOnly - 
      web - 

Returns:
  An object of the form:

    { # List of crawl error samples.
    "urlCrawlErrorSample": [ # Information about the sample URL and its crawl error.
      { # Contains information about specific crawl errors.
        "urlDetails": { # Additional details about the URL, set only when calling get(). # Additional details about the URL, set only when calling get().
          "containingSitemaps": [ # List of sitemaps pointing at this URL.
            "A String",
          ],
          "linkedFromUrls": [ # A sample set of URLs linking to this URL.
            "A String",
          ],
        },
        "first_detected": "A String", # The time the error was first detected, in RFC 3339 format.
        "pageUrl": "A String", # The URL of an error, relative to the site.
        "responseCode": 42, # The HTTP response code, if any.
        "last_crawled": "A String", # The time when the URL was last crawled, in RFC 3339 format.
      },
    ],
  }
markAsFixed(siteUrl, url, category, platform) 
Marks the provided site's sample URL as fixed, and removes it from the samples list.

Args:
  siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
  url: string, The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename (required)
  category: string, The crawl error category. For example: authPermissions (required)
    Allowed values
      authPermissions - 
      flashContent - 
      manyToOneRedirect - 
      notFollowed - 
      notFound - 
      other - 
      roboted - 
      serverError - 
      soft404 - 
  platform: string, The user agent type (platform) that made the request. For example: web (required)
    Allowed values
      mobile - 
      smartphoneOnly - 
      web -
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1.batchReportDefinitions.html000066400000000000000000000052461300622755700314100ustar00rootroot00000000000000

YouTube Analytics API . batchReportDefinitions

Instance Methods

list(onBehalfOfContentOwner)

Retrieves a list of available batch report definitions.

Method Details

list(onBehalfOfContentOwner) 
Retrieves a list of available batch report definitions.

Args:
  onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)

Returns:
  An object of the form:

    { # A paginated list of batchReportDefinition resources returned in response to a youtubeAnalytics.batchReportDefinitions.list request.
    "items": [ # A list of batchReportDefinition resources that match the request criteria.
      { # Contains single batchReportDefinition resource.
        "status": "A String", # Status of the report definition.
        "kind": "youtubeAnalytics#batchReportDefinition", # This value specifies the type of data of this item. For batch report definition the kind property value is youtubeAnalytics#batchReportDefinition.
        "type": "A String", # Type of the report definition.
        "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report definition.
        "name": "A String", # Name of the report definition.
      },
    ],
    "kind": "youtubeAnalytics#batchReportDefinitionList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportDefinitionList.
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1.batchReports.html000066400000000000000000000066261300622755700274020ustar00rootroot00000000000000

YouTube Analytics API . batchReports

Instance Methods

list(batchReportDefinitionId, onBehalfOfContentOwner)

Retrieves a list of processed batch reports.

Method Details

list(batchReportDefinitionId, onBehalfOfContentOwner) 
Retrieves a list of processed batch reports.

Args:
  batchReportDefinitionId: string, The batchReportDefinitionId parameter specifies the ID of the batch reportort definition for which you are retrieving reports. (required)
  onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)

Returns:
  An object of the form:

    { # A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.
    "items": [ # A list of batchReport resources that match the request criteria.
      { # Contains single batchReport resource.
        "kind": "youtubeAnalytics#batchReport", # This value specifies the type of data of this item. For batch report the kind property value is youtubeAnalytics#batchReport.
        "timeSpan": { # Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.
          "endTime": "A String", # End of the period included in the report. Inclusive. For reports containing all entities endTime is not set.
          "startTime": "A String", # Start of the period included in the report. Inclusive.
        },
        "outputs": [ # Report outputs.
          {
            "downloadUrl": "A String", # Cloud storage URL to download this report. This URL is valid for 30 minutes.
            "type": "cloudStorageOutput", # Type of the output.
            "format": "A String", # Format of the output.
          },
        ],
        "reportId": "A String", # The ID of the the report definition.
        "timeUpdated": "A String", # The time when the report was updated.
        "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report.
      },
    ],
    "kind": "youtubeAnalytics#batchReportList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportList.
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1.groupItems.html000066400000000000000000000126451300622755700270760ustar00rootroot00000000000000

YouTube Analytics API . groupItems

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Removes an item from a group.

insert(body, onBehalfOfContentOwner=None)

Creates a group item.

list(groupId, onBehalfOfContentOwner=None)

Returns a collection of group items that match the API request parameters.

Method Details

delete(id, onBehalfOfContentOwner=None) 
Removes an item from a group.

Args:
  id: string, The id parameter specifies the YouTube group item ID for the group that is being deleted. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
insert(body, onBehalfOfContentOwner=None) 
Creates a group item.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "kind": "youtube#groupItem",
    "etag": "A String",
    "resource": {
      "kind": "A String",
      "id": "A String",
    },
    "groupId": "A String",
    "id": "A String",
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "kind": "youtube#groupItem",
      "etag": "A String",
      "resource": {
        "kind": "A String",
        "id": "A String",
      },
      "groupId": "A String",
      "id": "A String",
    }
list(groupId, onBehalfOfContentOwner=None) 
Returns a collection of group items that match the API request parameters.

Args:
  groupId: string, The id parameter specifies the unique ID of the group for which you want to retrieve group items. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
    "items": [
      {
          "kind": "youtube#groupItem",
          "etag": "A String",
          "resource": {
            "kind": "A String",
            "id": "A String",
          },
          "groupId": "A String",
          "id": "A String",
        },
    ],
    "kind": "youtube#groupItemListResponse",
    "etag": "A String",
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1.groups.html000066400000000000000000000213201300622755700262450ustar00rootroot00000000000000

YouTube Analytics API . groups

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Deletes a group.

insert(body, onBehalfOfContentOwner=None)

Creates a group.

list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(body, onBehalfOfContentOwner=None)

Modifies a group. For example, you could change a group's title.

Method Details

delete(id, onBehalfOfContentOwner=None) 
Deletes a group.

Args:
  id: string, The id parameter specifies the YouTube group ID for the group that is being deleted. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
insert(body, onBehalfOfContentOwner=None) 
Creates a group.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "snippet": {
      "publishedAt": "A String",
      "title": "A String",
    },
    "contentDetails": {
      "itemCount": "A String",
      "itemType": "A String",
    },
    "kind": "youtube#group",
    "etag": "A String",
    "id": "A String",
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "snippet": {
        "publishedAt": "A String",
        "title": "A String",
      },
      "contentDetails": {
        "itemCount": "A String",
        "itemType": "A String",
      },
      "kind": "youtube#group",
      "etag": "A String",
      "id": "A String",
    }
list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None) 
Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

Args:
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.
  mine: boolean, Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
  id: string, The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.

Returns:
  An object of the form:

    { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
    "nextPageToken": "A String",
    "items": [
      {
          "snippet": {
            "publishedAt": "A String",
            "title": "A String",
          },
          "contentDetails": {
            "itemCount": "A String",
            "itemType": "A String",
          },
          "kind": "youtube#group",
          "etag": "A String",
          "id": "A String",
        },
    ],
    "kind": "youtube#groupListResponse",
    "etag": "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.
update(body, onBehalfOfContentOwner=None) 
Modifies a group. For example, you could change a group's title.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "snippet": {
      "publishedAt": "A String",
      "title": "A String",
    },
    "contentDetails": {
      "itemCount": "A String",
      "itemType": "A String",
    },
    "kind": "youtube#group",
    "etag": "A String",
    "id": "A String",
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "snippet": {
        "publishedAt": "A String",
        "title": "A String",
      },
      "contentDetails": {
        "itemCount": "A String",
        "itemType": "A String",
      },
      "kind": "youtube#group",
      "etag": "A String",
      "id": "A String",
    }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1.html000066400000000000000000000054311300622755700247340ustar00rootroot00000000000000

YouTube Analytics API

Instance Methods

batchReportDefinitions()

Returns the batchReportDefinitions Resource.

batchReports()

Returns the batchReports Resource.

groupItems()

Returns the groupItems Resource.

groups()

Returns the groups Resource.

reports()

Returns the reports Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1.reports.html000066400000000000000000000140461300622755700264330ustar00rootroot00000000000000

YouTube Analytics API . reports

Instance Methods

query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, currency=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, currency=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.
  currency: string, The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.
  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.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1beta1.batchReportDefinitions.html000066400000000000000000000052601300622755700323210ustar00rootroot00000000000000

YouTube Analytics API . batchReportDefinitions

Instance Methods

list(onBehalfOfContentOwner)

Retrieves a list of available batch report definitions.

Method Details

list(onBehalfOfContentOwner) 
Retrieves a list of available batch report definitions.

Args:
  onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)

Returns:
  An object of the form:

    { # A paginated list of batchReportDefinition resources returned in response to a youtubeAnalytics.batchReportDefinitions.list request.
    "items": [ # A list of batchReportDefinition resources that match the request criteria.
      { # Contains single batchReportDefinition resource.
        "status": "A String", # Status of the report definition.
        "kind": "youtubeAnalytics#batchReportDefinition", # This value specifies the type of data of this item. For batch report definition the kind property value is youtubeAnalytics#batchReportDefinition.
        "type": "A String", # Type of the report definition.
        "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report definition.
        "name": "A String", # Name of the report definition.
      },
    ],
    "kind": "youtubeAnalytics#batchReportDefinitionList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportDefinitionList.
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1beta1.batchReports.html000066400000000000000000000066401300622755700303130ustar00rootroot00000000000000

YouTube Analytics API . batchReports

Instance Methods

list(batchReportDefinitionId, onBehalfOfContentOwner)

Retrieves a list of processed batch reports.

Method Details

list(batchReportDefinitionId, onBehalfOfContentOwner) 
Retrieves a list of processed batch reports.

Args:
  batchReportDefinitionId: string, The batchReportDefinitionId parameter specifies the ID of the batch reportort definition for which you are retrieving reports. (required)
  onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)

Returns:
  An object of the form:

    { # A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.
    "items": [ # A list of batchReport resources that match the request criteria.
      { # Contains single batchReport resource.
        "kind": "youtubeAnalytics#batchReport", # This value specifies the type of data of this item. For batch report the kind property value is youtubeAnalytics#batchReport.
        "timeSpan": { # Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.
          "endTime": "A String", # End of the period included in the report. Inclusive. For reports containing all entities endTime is not set.
          "startTime": "A String", # Start of the period included in the report. Inclusive.
        },
        "outputs": [ # Report outputs.
          {
            "downloadUrl": "A String", # Cloud storage URL to download this report. This URL is valid for 30 minutes.
            "type": "cloudStorageOutput", # Type of the output.
            "format": "A String", # Format of the output.
          },
        ],
        "reportId": "A String", # The ID of the the report definition.
        "timeUpdated": "A String", # The time when the report was updated.
        "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report.
      },
    ],
    "kind": "youtubeAnalytics#batchReportList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportList.
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1beta1.groupItems.html000066400000000000000000000126571300622755700300160ustar00rootroot00000000000000

YouTube Analytics API . groupItems

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Removes an item from a group.

insert(body, onBehalfOfContentOwner=None)

Creates a group item.

list(groupId, onBehalfOfContentOwner=None)

Returns a collection of group items that match the API request parameters.

Method Details

delete(id, onBehalfOfContentOwner=None) 
Removes an item from a group.

Args:
  id: string, The id parameter specifies the YouTube group item ID for the group that is being deleted. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
insert(body, onBehalfOfContentOwner=None) 
Creates a group item.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "kind": "youtube#groupItem",
    "etag": "A String",
    "resource": {
      "kind": "A String",
      "id": "A String",
    },
    "groupId": "A String",
    "id": "A String",
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "kind": "youtube#groupItem",
      "etag": "A String",
      "resource": {
        "kind": "A String",
        "id": "A String",
      },
      "groupId": "A String",
      "id": "A String",
    }
list(groupId, onBehalfOfContentOwner=None) 
Returns a collection of group items that match the API request parameters.

Args:
  groupId: string, The id parameter specifies the unique ID of the group for which you want to retrieve group items. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
    "items": [
      {
          "kind": "youtube#groupItem",
          "etag": "A String",
          "resource": {
            "kind": "A String",
            "id": "A String",
          },
          "groupId": "A String",
          "id": "A String",
        },
    ],
    "kind": "youtube#groupItemListResponse",
    "etag": "A String",
  }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1beta1.groups.html000066400000000000000000000213321300622755700271650ustar00rootroot00000000000000

YouTube Analytics API . groups

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Deletes a group.

insert(body, onBehalfOfContentOwner=None)

Creates a group.

list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(body, onBehalfOfContentOwner=None)

Modifies a group. For example, you could change a group's title.

Method Details

delete(id, onBehalfOfContentOwner=None) 
Deletes a group.

Args:
  id: string, The id parameter specifies the YouTube group ID for the group that is being deleted. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
insert(body, onBehalfOfContentOwner=None) 
Creates a group.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "snippet": {
      "publishedAt": "A String",
      "title": "A String",
    },
    "contentDetails": {
      "itemCount": "A String",
      "itemType": "A String",
    },
    "kind": "youtube#group",
    "etag": "A String",
    "id": "A String",
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "snippet": {
        "publishedAt": "A String",
        "title": "A String",
      },
      "contentDetails": {
        "itemCount": "A String",
        "itemType": "A String",
      },
      "kind": "youtube#group",
      "etag": "A String",
      "id": "A String",
    }
list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None) 
Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

Args:
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.
  mine: boolean, Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
  id: string, The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.

Returns:
  An object of the form:

    { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
    "nextPageToken": "A String",
    "items": [
      {
          "snippet": {
            "publishedAt": "A String",
            "title": "A String",
          },
          "contentDetails": {
            "itemCount": "A String",
            "itemType": "A String",
          },
          "kind": "youtube#group",
          "etag": "A String",
          "id": "A String",
        },
    ],
    "kind": "youtube#groupListResponse",
    "etag": "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.
update(body, onBehalfOfContentOwner=None) 
Modifies a group. For example, you could change a group's title.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "snippet": {
      "publishedAt": "A String",
      "title": "A String",
    },
    "contentDetails": {
      "itemCount": "A String",
      "itemType": "A String",
    },
    "kind": "youtube#group",
    "etag": "A String",
    "id": "A String",
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "snippet": {
        "publishedAt": "A String",
        "title": "A String",
      },
      "contentDetails": {
        "itemCount": "A String",
        "itemType": "A String",
      },
      "kind": "youtube#group",
      "etag": "A String",
      "id": "A String",
    }
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1beta1.html000066400000000000000000000054671300622755700256620ustar00rootroot00000000000000

YouTube Analytics API

Instance Methods

batchReportDefinitions()

Returns the batchReportDefinitions Resource.

batchReports()

Returns the batchReports Resource.

groupItems()

Returns the groupItems Resource.

groups()

Returns the groups Resource.

reports()

Returns the reports Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/youtubeAnalytics_v1beta1.reports.html000066400000000000000000000140601300622755700273440ustar00rootroot00000000000000

YouTube Analytics API . reports

Instance Methods

query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, currency=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, currency=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.
  currency: string, The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.
  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.
      },
    ],
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.activities.html000066400000000000000000001733251300622755700252410ustar00rootroot00000000000000

YouTube Data API . activities

Instance Methods

insert(part, 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, body) 
Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)

Note: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite.

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. (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.
        "forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.
          "A String",
        ],
        "impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.
          "A String",
        ],
        "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.
        "customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override the default button text for the cta_type.
        "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", # Identifies what kind of resource this is. Value: the fixed string "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.
          "forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.
            "A String",
          ],
          "impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.
            "A String",
          ],
          "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.
          "customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override the default button text for the cta_type.
          "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", # Identifies what kind of resource this is. Value: the fixed string "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.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an 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, 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.
  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, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  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. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.
  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:

    {
    "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", # Identifies what kind of resource this is. Value: the fixed string "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.
              "forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.
                "A String",
              ],
              "impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.
                "A String",
              ],
              "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.
              "customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override the default button text for the cta_type.
              "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", # Identifies what kind of resource this is. Value: the fixed string "youtube#activity".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
        },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "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.
google-api-python-client-1.5.5/docs/dyn/youtube_v3.captions.html000066400000000000000000000665541300622755700247220ustar00rootroot00000000000000

YouTube Data API . captions

Instance Methods

delete(id, onBehalfOf=None, onBehalfOfContentOwner=None)

Deletes a specified caption track.

download(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None)

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

download_media(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None)

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

insert(part, body=None, media_body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None)

Uploads a caption track.

list(part, videoId, onBehalfOf=None, onBehalfOfContentOwner=None, id=None)

Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.

update(part, body=None, media_body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None)

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

Method Details

delete(id, onBehalfOf=None, onBehalfOfContentOwner=None) 
Deletes a specified caption track.

Args:
  id: string, The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource. (required)
  onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 must be linked to the specified YouTube content owner.
download(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None) 
Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

Args:
  id: string, The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource. (required)
  onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
  tlang: string, The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 must be linked to the specified YouTube content owner.
  tfmt: string, The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.
    Allowed values
      sbv - SubViewer subtitle.
      scc - Scenarist Closed Caption format.
      srt - SubRip subtitle.
      ttml - Timed Text Markup Language caption.
      vtt - Web Video Text Tracks caption.
download_media(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None) 
Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

Args:
  id: string, The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource. (required)
  onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
  tlang: string, The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 must be linked to the specified YouTube content owner.
  tfmt: string, The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.
    Allowed values
      sbv - SubViewer subtitle.
      scc - Scenarist Closed Caption format.
      srt - SubRip subtitle.
      ttml - Timed Text Markup Language caption.
      vtt - Web Video Text Tracks caption.
insert(part, body=None, media_body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None) 
Uploads a caption track.

Args:
  part: string, The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. (required)
  body: object, The request body.
    The object takes the form of:

{ # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
    "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
      "status": "A String", # The caption track's status.
      "audioTrackType": "A String", # The type of audio track associated with the caption track.
      "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
      "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
      "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
      "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
      "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
      "trackKind": "A String", # The caption track's type.
      "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
      "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
      "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
      "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
    },
    "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
  sync: boolean, The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.

You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    { # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
      "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
        "status": "A String", # The caption track's status.
        "audioTrackType": "A String", # The type of audio track associated with the caption track.
        "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
        "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
        "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
        "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
        "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
        "trackKind": "A String", # The caption track's type.
        "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
        "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
        "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
        "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
      },
      "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
    }
list(part, videoId, onBehalfOf=None, onBehalfOfContentOwner=None, id=None) 
Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.

Args:
  part: string, The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet. (required)
  videoId: string, The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks. (required)
  onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 must be linked to the specified YouTube content owner.
  id: string, The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.

Returns:
  An object of the form:

    {
    "eventId": "A String", # Serialized EventId of the request which produced this response.
    "items": [ # A list of captions that match the request criteria.
      { # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
          "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
            "status": "A String", # The caption track's status.
            "audioTrackType": "A String", # The type of audio track associated with the caption track.
            "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
            "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
            "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
            "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
            "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
            "trackKind": "A String", # The caption track's type.
            "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
            "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
            "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
            "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
          },
          "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
        },
    ],
    "kind": "youtube#captionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".
    "etag": "A String", # Etag of this resource.
    "visitorId": "A String", # The visitorId identifies the visitor.
  }
update(part, body=None, media_body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None) 
Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

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. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id. (required)
  body: object, The request body.
    The object takes the form of:

{ # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
    "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
      "status": "A String", # The caption track's status.
      "audioTrackType": "A String", # The type of audio track associated with the caption track.
      "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
      "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
      "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
      "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
      "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
      "trackKind": "A String", # The caption track's type.
      "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
      "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
      "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
      "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
    },
    "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
  }

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
  sync: boolean, Note: The API server only processes the parameter value if the request contains an updated caption file.

The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    { # A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
      "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
        "status": "A String", # The caption track's status.
        "audioTrackType": "A String", # The type of audio track associated with the caption track.
        "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
        "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
        "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track.
        "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
        "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
        "trackKind": "A String", # The caption track's type.
        "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
        "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
        "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
        "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
      },
      "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.channelBanners.html000066400000000000000000000072361300622755700260130ustar00rootroot00000000000000

YouTube Data API . channelBanners

Instance Methods

insert(body=None, media_body=None, onBehalfOfContentOwner=None)

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:

Method Details

insert(body=None, media_body=None, onBehalfOfContentOwner=None) 
Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:

- Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.
- Extract the url property's value from the response that the API returns for step 1.
- Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

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", # Identifies what kind of resource this is. Value: the fixed string "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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

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", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource".
      "etag": "A String", # Etag of this resource.
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.channelSections.html000066400000000000000000000536241300622755700262140ustar00rootroot00000000000000

YouTube Data API . channelSections

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Deletes a channelSection.

insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

Adds a channelSection for the authenticated user's channel.

list(part=None, onBehalfOfContentOwner=None, hl=None, channelId=None, mine=None, id=None)

Returns channelSection resources that match the API request criteria.

update(part=None, body, onBehalfOfContentOwner=None)

Update a channelSection.

Method Details

delete(id, onBehalfOfContentOwner=None) 
Deletes a channelSection.

Args:
  id: string, The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection ID. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None) 
Adds a channelSection for the authenticated user's channel.

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:

{
    "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
    "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
      "languages": [ # The language the channel section is targeting.
        "A String",
      ],
      "regions": [ # The region the channel section is targeting.
        "A String",
      ],
      "countries": [ # The country the channel section is targeting.
        "A String",
      ],
    },
    "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
      "channels": [ # The channel ids for type multiple_channels.
        "A String",
      ],
      "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
        "A String",
      ],
    },
    "snippet": { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
      "style": "A String", # The style of the channel section.
      "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
      "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
      "defaultLanguage": "A String", # The language of the channel section's default title and description.
      "position": 42, # The position of the channel section in the channel.
      "type": "A String", # The type of the channel section.
      "localized": { # ChannelSection localization setting # Localized title, read-only.
        "title": "A String", # The localized strings for channel section's title.
      },
    },
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
    "localizations": { # Localizations for different languages
      "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
        "title": "A String", # The localized strings for channel section's title.
      },
    },
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

Returns:
  An object of the form:

    {
      "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
      "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
        "languages": [ # The language the channel section is targeting.
          "A String",
        ],
        "regions": [ # The region the channel section is targeting.
          "A String",
        ],
        "countries": [ # The country the channel section is targeting.
          "A String",
        ],
      },
      "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
        "channels": [ # The channel ids for type multiple_channels.
          "A String",
        ],
        "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
          "A String",
        ],
      },
      "snippet": { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
        "style": "A String", # The style of the channel section.
        "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
        "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
        "defaultLanguage": "A String", # The language of the channel section's default title and description.
        "position": 42, # The position of the channel section in the channel.
        "type": "A String", # The type of the channel section.
        "localized": { # ChannelSection localization setting # Localized title, read-only.
          "title": "A String", # The localized strings for channel section's title.
        },
      },
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
      "localizations": { # Localizations for different languages
        "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
          "title": "A String", # The localized strings for channel section's title.
        },
      },
    }
list(part=None, onBehalfOfContentOwner=None, hl=None, channelId=None, mine=None, id=None) 
Returns channelSection resources that match the API request criteria.

Args:
  part: string, The part parameter specifies a comma-separated list of one or more channelSection 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 channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  hl: string, The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.
  channelId: string, The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections.
  mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.
  id: string, The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.

Returns:
  An object of the form:

    {
    "eventId": "A String", # Serialized EventId of the request which produced this response.
    "items": [ # A list of ChannelSections that match the request criteria.
      {
          "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
          "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
            "languages": [ # The language the channel section is targeting.
              "A String",
            ],
            "regions": [ # The region the channel section is targeting.
              "A String",
            ],
            "countries": [ # The country the channel section is targeting.
              "A String",
            ],
          },
          "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
            "channels": [ # The channel ids for type multiple_channels.
              "A String",
            ],
            "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
              "A String",
            ],
          },
          "snippet": { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
            "style": "A String", # The style of the channel section.
            "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
            "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
            "defaultLanguage": "A String", # The language of the channel section's default title and description.
            "position": 42, # The position of the channel section in the channel.
            "type": "A String", # The type of the channel section.
            "localized": { # ChannelSection localization setting # Localized title, read-only.
              "title": "A String", # The localized strings for channel section's title.
            },
          },
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
          "localizations": { # Localizations for different languages
            "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
              "title": "A String", # The localized strings for channel section's title.
            },
          },
        },
    ],
    "kind": "youtube#channelSectionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse".
    "etag": "A String", # Etag of this resource.
    "visitorId": "A String", # The visitorId identifies the visitor.
  }
update(part=None, body, onBehalfOfContentOwner=None) 
Update a channelSection.

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:

{
    "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
    "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
      "languages": [ # The language the channel section is targeting.
        "A String",
      ],
      "regions": [ # The region the channel section is targeting.
        "A String",
      ],
      "countries": [ # The country the channel section is targeting.
        "A String",
      ],
    },
    "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
      "channels": [ # The channel ids for type multiple_channels.
        "A String",
      ],
      "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
        "A String",
      ],
    },
    "snippet": { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
      "style": "A String", # The style of the channel section.
      "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
      "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
      "defaultLanguage": "A String", # The language of the channel section's default title and description.
      "position": 42, # The position of the channel section in the channel.
      "type": "A String", # The type of the channel section.
      "localized": { # ChannelSection localization setting # Localized title, read-only.
        "title": "A String", # The localized strings for channel section's title.
      },
    },
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
    "localizations": { # Localizations for different languages
      "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
        "title": "A String", # The localized strings for channel section's title.
      },
    },
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Returns:
  An object of the form:

    {
      "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
      "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
        "languages": [ # The language the channel section is targeting.
          "A String",
        ],
        "regions": [ # The region the channel section is targeting.
          "A String",
        ],
        "countries": [ # The country the channel section is targeting.
          "A String",
        ],
      },
      "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
        "channels": [ # The channel ids for type multiple_channels.
          "A String",
        ],
        "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
          "A String",
        ],
      },
      "snippet": { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
        "style": "A String", # The style of the channel section.
        "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
        "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
        "defaultLanguage": "A String", # The language of the channel section's default title and description.
        "position": 42, # The position of the channel section in the channel.
        "type": "A String", # The type of the channel section.
        "localized": { # ChannelSection localization setting # Localized title, read-only.
          "title": "A String", # The localized strings for channel section's title.
        },
      },
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
      "localizations": { # Localizations for different languages
        "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
          "title": "A String", # The localized strings for channel section's title.
        },
      },
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.channels.html000066400000000000000000002060521300622755700246620ustar00rootroot00000000000000

YouTube Data API . channels

Instance Methods

list(part=None, hl=None, mine=None, mySubscribers=None, id=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=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. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties.

Method Details

list(part=None, hl=None, mine=None, mySubscribers=None, id=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=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.

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)
  hl: string, The hl parameter should be used for filter out the properties that are not in the given language. Used for the brandingSettings part.
  mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
  mySubscribers: boolean, Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers 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.
  managedByMe: boolean, Note: This parameter is intended exclusively for YouTube content partners.

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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must 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.

Returns:
  An object of the form:

    {
    "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", # Identifies what kind of resource this is. Value: the fixed string "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.
          "longUploadsStatus": "A String", # The long uploads status of this channel. See
        },
        "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.
              },
              "promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.
              "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.
                "recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.
                "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.
              },
            },
          ],
          "useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each 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", # Identifies what kind of resource this is. Value: the fixed string "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.
          "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
          "viewCount": "A String", # The number of times the channel has been viewed.
        },
        "contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
          "contentOwner": "A String", # The ID of the content owner linked to the channel.
          "timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        },
        "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.
            "largeBrandedBannerImageImapScript": { # The image map script for the large banner image.
              "default": "A String",
              "localized": [
                {
                  "value": "A String",
                  "language": "A String",
                },
              ],
              "defaultLanguage": { # The language of the default property.
                "value": "A String",
              },
            },
            "smallBrandedBannerImageUrl": { # 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",
              "localized": [
                {
                  "value": "A String",
                  "language": "A String",
                },
              ],
              "defaultLanguage": { # The language of the default property.
                "value": "A String",
              },
            },
            "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
            "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
            "largeBrandedBannerImageUrl": { # 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",
              "localized": [
                {
                  "value": "A String",
                  "language": "A String",
                },
              ],
              "defaultLanguage": { # The language of the default property.
                "value": "A String",
              },
            },
            "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
            "backgroundImageUrl": { # 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",
              "localized": [
                {
                  "value": "A String",
                  "language": "A String",
                },
              ],
              "defaultLanguage": { # The language of the default property.
                "value": "A String",
              },
            },
            "smallBrandedBannerImageImapScript": { # The image map script for the small banner image.
              "default": "A String",
              "localized": [
                {
                  "value": "A String",
                  "language": "A String",
                },
              ],
              "defaultLanguage": { # The language of the default property.
                "value": "A String",
              },
            },
            "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.
            "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.
            "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
            "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
            "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
            "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
            "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.
            "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
            "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
            "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
            "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
            "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
            "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
            "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
          },
          "watch": { # Branding properties for the watch. All deprecated. # 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.
            "country": "A String", # The country of the channel.
            "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
            "featuredChannelsTitle": "A String", # Title for the featured channels tab.
            "defaultLanguage": "A String",
            "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.
            "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.
            "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. Next available id: 15. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
          "description": "A String", # The description of the channel.
          "title": "A String", # The channel's title.
          "country": "A String", # The country of the channel.
          "customUrl": "A String", # The custom url 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.
          "defaultLanguage": "A String", # The language of the channel's default title and description.
          "localized": { # Channel localization setting # Localized title and description, read-only.
            "description": "A String", # The localized strings for channel's description.
            "title": "A String", # The localized strings for channel's title.
          },
          "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.
            },
          },
        },
        "auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
          "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
          "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
          "overallGoodStanding": True or False, # Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.
          "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
        },
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
        "localizations": { # Localizations for different languages
          "a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.
            "description": "A String", # The localized strings for channel's description.
            "title": "A String", # The localized strings for channel's title.
          },
        },
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "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. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties.

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 API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.)

Note that this method overrides 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.
    "longUploadsStatus": "A String", # The long uploads status of this channel. See
  },
  "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.
        },
        "promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.
        "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.
          "recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.
          "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.
        },
      },
    ],
    "useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each 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", # Identifies what kind of resource this is. Value: the fixed string "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.
    "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
    "viewCount": "A String", # The number of times the channel has been viewed.
  },
  "contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
    "contentOwner": "A String", # The ID of the content owner linked to the channel.
    "timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
  },
  "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.
      "largeBrandedBannerImageImapScript": { # The image map script for the large banner image.
        "default": "A String",
        "localized": [
          {
            "value": "A String",
            "language": "A String",
          },
        ],
        "defaultLanguage": { # The language of the default property.
          "value": "A String",
        },
      },
      "smallBrandedBannerImageUrl": { # 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",
        "localized": [
          {
            "value": "A String",
            "language": "A String",
          },
        ],
        "defaultLanguage": { # The language of the default property.
          "value": "A String",
        },
      },
      "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
      "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
      "largeBrandedBannerImageUrl": { # 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",
        "localized": [
          {
            "value": "A String",
            "language": "A String",
          },
        ],
        "defaultLanguage": { # The language of the default property.
          "value": "A String",
        },
      },
      "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
      "backgroundImageUrl": { # 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",
        "localized": [
          {
            "value": "A String",
            "language": "A String",
          },
        ],
        "defaultLanguage": { # The language of the default property.
          "value": "A String",
        },
      },
      "smallBrandedBannerImageImapScript": { # The image map script for the small banner image.
        "default": "A String",
        "localized": [
          {
            "value": "A String",
            "language": "A String",
          },
        ],
        "defaultLanguage": { # The language of the default property.
          "value": "A String",
        },
      },
      "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.
      "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.
      "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
      "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
      "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
      "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
      "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.
      "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
      "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
      "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
      "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
      "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
      "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
      "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
    },
    "watch": { # Branding properties for the watch. All deprecated. # 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.
      "country": "A String", # The country of the channel.
      "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
      "featuredChannelsTitle": "A String", # Title for the featured channels tab.
      "defaultLanguage": "A String",
      "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.
      "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.
      "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. Next available id: 15. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
    "description": "A String", # The description of the channel.
    "title": "A String", # The channel's title.
    "country": "A String", # The country of the channel.
    "customUrl": "A String", # The custom url 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.
    "defaultLanguage": "A String", # The language of the channel's default title and description.
    "localized": { # Channel localization setting # Localized title and description, read-only.
      "description": "A String", # The localized strings for channel's description.
      "title": "A String", # The localized strings for channel's title.
    },
    "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.
      },
    },
  },
  "auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
    "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
    "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
    "overallGoodStanding": True or False, # Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.
    "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
  },
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
  "localizations": { # Localizations for different languages
    "a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.
      "description": "A String", # The localized strings for channel's description.
      "title": "A String", # The localized strings for channel's title.
    },
  },
}

  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.
      "longUploadsStatus": "A String", # The long uploads status of this channel. See
    },
    "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.
          },
          "promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.
          "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.
            "recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.
            "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.
          },
        },
      ],
      "useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each 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", # Identifies what kind of resource this is. Value: the fixed string "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.
      "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
      "viewCount": "A String", # The number of times the channel has been viewed.
    },
    "contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
      "contentOwner": "A String", # The ID of the content owner linked to the channel.
      "timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    },
    "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.
        "largeBrandedBannerImageImapScript": { # The image map script for the large banner image.
          "default": "A String",
          "localized": [
            {
              "value": "A String",
              "language": "A String",
            },
          ],
          "defaultLanguage": { # The language of the default property.
            "value": "A String",
          },
        },
        "smallBrandedBannerImageUrl": { # 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",
          "localized": [
            {
              "value": "A String",
              "language": "A String",
            },
          ],
          "defaultLanguage": { # The language of the default property.
            "value": "A String",
          },
        },
        "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
        "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
        "largeBrandedBannerImageUrl": { # 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",
          "localized": [
            {
              "value": "A String",
              "language": "A String",
            },
          ],
          "defaultLanguage": { # The language of the default property.
            "value": "A String",
          },
        },
        "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
        "backgroundImageUrl": { # 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",
          "localized": [
            {
              "value": "A String",
              "language": "A String",
            },
          ],
          "defaultLanguage": { # The language of the default property.
            "value": "A String",
          },
        },
        "smallBrandedBannerImageImapScript": { # The image map script for the small banner image.
          "default": "A String",
          "localized": [
            {
              "value": "A String",
              "language": "A String",
            },
          ],
          "defaultLanguage": { # The language of the default property.
            "value": "A String",
          },
        },
        "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.
        "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.
        "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
        "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
        "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
        "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
        "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.
        "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
        "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
        "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
        "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
        "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
        "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
        "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
      },
      "watch": { # Branding properties for the watch. All deprecated. # 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.
        "country": "A String", # The country of the channel.
        "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
        "featuredChannelsTitle": "A String", # Title for the featured channels tab.
        "defaultLanguage": "A String",
        "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.
        "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.
        "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. Next available id: 15. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
      "description": "A String", # The description of the channel.
      "title": "A String", # The channel's title.
      "country": "A String", # The country of the channel.
      "customUrl": "A String", # The custom url 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.
      "defaultLanguage": "A String", # The language of the channel's default title and description.
      "localized": { # Channel localization setting # Localized title and description, read-only.
        "description": "A String", # The localized strings for channel's description.
        "title": "A String", # The localized strings for channel's title.
      },
      "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.
        },
      },
    },
    "auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
      "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
      "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
      "overallGoodStanding": True or False, # Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.
      "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
    },
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
    "localizations": { # Localizations for different languages
      "a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.
        "description": "A String", # The localized strings for channel's description.
        "title": "A String", # The localized strings for channel's title.
      },
    },
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.commentThreads.html000066400000000000000000001305071300622755700260450ustar00rootroot00000000000000

YouTube Data API . commentThreads

Instance Methods

insert(part, body)

Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.

list(part, channelId=None, id=None, pageToken=None, allThreadsRelatedToChannelId=None, moderationStatus=None, videoId=None, maxResults=None, searchTerms=None, textFormat=None, order=None)

Returns a list of comment threads that match the API request parameters.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(part, body)

Modifies the top-level comment in a comment thread.

Method Details

insert(part, body) 
Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.

Args:
  part: string, The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
    "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
      "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
      "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
      "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
      "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
      "totalReplyCount": 42, # The total number of replies (not including the top level comment).
      "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
        "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
          "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
          "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
          "authorDisplayName": "A String", # The name of the user who posted the comment.
          "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
          "videoId": "A String", # The ID of the video the comment refers to, if any.
          "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
          "likeCount": 42, # The total number of likes this comment has received.
          "authorChannelId": "", # The id of the author's YouTube channel, if any.
          "parentId": "A String", # The unique id of the parent comment, only set for replies.
          "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
          "canRate": True or False, # Whether the current viewer can rate this comment.
          "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
          "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
          "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
          "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
          "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        },
        "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      },
    },
    "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
    "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
      "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
        { # A comment represents a single YouTube comment.
          "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
            "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
            "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
            "authorDisplayName": "A String", # The name of the user who posted the comment.
            "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
            "videoId": "A String", # The ID of the video the comment refers to, if any.
            "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
            "likeCount": 42, # The total number of likes this comment has received.
            "authorChannelId": "", # The id of the author's YouTube channel, if any.
            "parentId": "A String", # The unique id of the parent comment, only set for replies.
            "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "canRate": True or False, # Whether the current viewer can rate this comment.
            "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
            "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
            "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
            "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
          },
          "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
        },
      ],
    },
  }


Returns:
  An object of the form:

    { # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
      "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
        "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
        "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
        "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
        "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
        "totalReplyCount": 42, # The total number of replies (not including the top level comment).
        "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
          "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
            "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
            "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
            "authorDisplayName": "A String", # The name of the user who posted the comment.
            "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
            "videoId": "A String", # The ID of the video the comment refers to, if any.
            "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
            "likeCount": 42, # The total number of likes this comment has received.
            "authorChannelId": "", # The id of the author's YouTube channel, if any.
            "parentId": "A String", # The unique id of the parent comment, only set for replies.
            "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "canRate": True or False, # Whether the current viewer can rate this comment.
            "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
            "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
            "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
            "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
          },
          "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
        },
      },
      "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
      "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
        "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
          { # A comment represents a single YouTube comment.
            "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
              "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
              "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
              "authorDisplayName": "A String", # The name of the user who posted the comment.
              "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
              "videoId": "A String", # The ID of the video the comment refers to, if any.
              "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
              "likeCount": 42, # The total number of likes this comment has received.
              "authorChannelId": "", # The id of the author's YouTube channel, if any.
              "parentId": "A String", # The unique id of the parent comment, only set for replies.
              "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
              "canRate": True or False, # Whether the current viewer can rate this comment.
              "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
              "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
              "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
              "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
              "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
            },
            "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
            "etag": "A String", # Etag of this resource.
            "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
          },
        ],
      },
    }
list(part, channelId=None, id=None, pageToken=None, allThreadsRelatedToChannelId=None, moderationStatus=None, videoId=None, maxResults=None, searchTerms=None, textFormat=None, order=None) 
Returns a list of comment threads that match the API request parameters.

Args:
  part: string, The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. (required)
  channelId: string, The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.)
  id: string, The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.
  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.

Note: This parameter is not supported for use in conjunction with the id parameter.
  allThreadsRelatedToChannelId: string, The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.
  moderationStatus: string, Set this parameter to limit the returned comment threads to a particular moderation state.

Note: This parameter is not supported for use in conjunction with the id parameter.
    Allowed values
      heldForReview - Retrieve comment threads that are awaiting review by a moderator. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment are awaiting review.
      likelySpam - Retrieve comment threads classified as likely to be spam. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment is considered likely to be spam.
      published - Retrieve threads of published comments. This is the default value. A comment thread can be included in the response if its top-level comment has been published.
  videoId: string, The videoId parameter instructs the API to return comment threads associated with the specified video ID.
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is not supported for use in conjunction with the id parameter.
  searchTerms: string, The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.

Note: This parameter is not supported for use in conjunction with the id parameter.
  textFormat: string, Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.
    Allowed values
      html - Returns the comments in HTML format. This is the default value.
      plainText - Returns the comments in plain text format.
  order: string, The order parameter specifies the order in which the API response should list comment threads. Valid values are: 
- time - Comment threads are ordered by time. This is the default behavior.
- relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.
    Allowed values
      relevance - Order by relevance.
      time - Order by time.

Returns:
  An object of the form:

    {
    "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#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "items": [ # A list of comment threads that match the request criteria.
      { # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
          "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
            "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
            "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
            "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
            "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
            "totalReplyCount": 42, # The total number of replies (not including the top level comment).
            "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
              "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
                "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
                "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
                "authorDisplayName": "A String", # The name of the user who posted the comment.
                "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
                "videoId": "A String", # The ID of the video the comment refers to, if any.
                "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
                "likeCount": 42, # The total number of likes this comment has received.
                "authorChannelId": "", # The id of the author's YouTube channel, if any.
                "parentId": "A String", # The unique id of the parent comment, only set for replies.
                "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
                "canRate": True or False, # Whether the current viewer can rate this comment.
                "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
                "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
                "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
                "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
                "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
              },
              "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
              "etag": "A String", # Etag of this resource.
              "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
            },
          },
          "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
          "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
            "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
              { # A comment represents a single YouTube comment.
                "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
                  "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
                  "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
                  "authorDisplayName": "A String", # The name of the user who posted the comment.
                  "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
                  "videoId": "A String", # The ID of the video the comment refers to, if any.
                  "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
                  "likeCount": 42, # The total number of likes this comment has received.
                  "authorChannelId": "", # The id of the author's YouTube channel, if any.
                  "parentId": "A String", # The unique id of the parent comment, only set for replies.
                  "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
                  "canRate": True or False, # Whether the current viewer can rate this comment.
                  "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
                  "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
                  "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
                  "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
                  "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
                },
                "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
                "etag": "A String", # Etag of this resource.
                "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
              },
            ],
          },
        },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
      "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, body) 
Modifies the top-level comment in a comment thread.

Args:
  part: string, The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
    "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
      "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
      "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
      "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
      "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
      "totalReplyCount": 42, # The total number of replies (not including the top level comment).
      "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
        "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
          "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
          "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
          "authorDisplayName": "A String", # The name of the user who posted the comment.
          "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
          "videoId": "A String", # The ID of the video the comment refers to, if any.
          "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
          "likeCount": 42, # The total number of likes this comment has received.
          "authorChannelId": "", # The id of the author's YouTube channel, if any.
          "parentId": "A String", # The unique id of the parent comment, only set for replies.
          "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
          "canRate": True or False, # Whether the current viewer can rate this comment.
          "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
          "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
          "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
          "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
          "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        },
        "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      },
    },
    "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
    "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
      "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
        { # A comment represents a single YouTube comment.
          "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
            "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
            "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
            "authorDisplayName": "A String", # The name of the user who posted the comment.
            "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
            "videoId": "A String", # The ID of the video the comment refers to, if any.
            "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
            "likeCount": 42, # The total number of likes this comment has received.
            "authorChannelId": "", # The id of the author's YouTube channel, if any.
            "parentId": "A String", # The unique id of the parent comment, only set for replies.
            "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "canRate": True or False, # Whether the current viewer can rate this comment.
            "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
            "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
            "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
            "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
          },
          "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
        },
      ],
    },
  }


Returns:
  An object of the form:

    { # A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
      "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
        "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
        "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
        "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
        "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
        "totalReplyCount": 42, # The total number of replies (not including the top level comment).
        "topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.
          "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
            "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
            "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
            "authorDisplayName": "A String", # The name of the user who posted the comment.
            "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
            "videoId": "A String", # The ID of the video the comment refers to, if any.
            "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
            "likeCount": 42, # The total number of likes this comment has received.
            "authorChannelId": "", # The id of the author's YouTube channel, if any.
            "parentId": "A String", # The unique id of the parent comment, only set for replies.
            "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "canRate": True or False, # Whether the current viewer can rate this comment.
            "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
            "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
            "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
            "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
          },
          "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
        },
      },
      "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
      "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
        "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
          { # A comment represents a single YouTube comment.
            "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
              "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
              "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
              "authorDisplayName": "A String", # The name of the user who posted the comment.
              "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
              "videoId": "A String", # The ID of the video the comment refers to, if any.
              "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
              "likeCount": 42, # The total number of likes this comment has received.
              "authorChannelId": "", # The id of the author's YouTube channel, if any.
              "parentId": "A String", # The unique id of the parent comment, only set for replies.
              "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
              "canRate": True or False, # Whether the current viewer can rate this comment.
              "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
              "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
              "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
              "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
              "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
            },
            "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
            "etag": "A String", # Etag of this resource.
            "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
          },
        ],
      },
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.comments.html000066400000000000000000000525441300622755700247210ustar00rootroot00000000000000

YouTube Data API . comments

Instance Methods

delete(id)

Deletes a comment.

insert(part, body)

Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.

list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None)

Returns a list of comments that match the API request parameters.

list_next(previous_request, previous_response)

Retrieves the next page of results.

markAsSpam(id)

Expresses the caller's opinion that one or more comments should be flagged as spam.

setModerationStatus(id, moderationStatus, banAuthor=None)

Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.

update(part, body)

Modifies a comment.

Method Details

delete(id) 
Deletes a comment.

Args:
  id: string, The id parameter specifies the comment ID for the resource that is being deleted. (required)
insert(part, body) 
Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.

Args:
  part: string, The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A comment represents a single YouTube comment.
  "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
    "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
    "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
    "authorDisplayName": "A String", # The name of the user who posted the comment.
    "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
    "videoId": "A String", # The ID of the video the comment refers to, if any.
    "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
    "likeCount": 42, # The total number of likes this comment has received.
    "authorChannelId": "", # The id of the author's YouTube channel, if any.
    "parentId": "A String", # The unique id of the parent comment, only set for replies.
    "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    "canRate": True or False, # Whether the current viewer can rate this comment.
    "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
    "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
    "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
    "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
  },
  "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
}


Returns:
  An object of the form:

    { # A comment represents a single YouTube comment.
    "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
      "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
      "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
      "authorDisplayName": "A String", # The name of the user who posted the comment.
      "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
      "videoId": "A String", # The ID of the video the comment refers to, if any.
      "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
      "likeCount": 42, # The total number of likes this comment has received.
      "authorChannelId": "", # The id of the author's YouTube channel, if any.
      "parentId": "A String", # The unique id of the parent comment, only set for replies.
      "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "canRate": True or False, # Whether the current viewer can rate this comment.
      "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
      "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
      "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
      "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
    },
    "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
  }
list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None) 
Returns a list of comments that match the API request parameters.

Args:
  part: string, The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include. (required)
  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.

Note: This parameter is not supported for use in conjunction with the id parameter.
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is not supported for use in conjunction with the id parameter.
  id: string, The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.
  parentId: string, The parentId parameter specifies the ID of the comment for which replies should be retrieved.

Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.
  textFormat: string, This parameter indicates whether the API should return comments formatted as HTML or as plain text.
    Allowed values
      html - Returns the comments in HTML format. This is the default value.
      plainText - Returns the comments in plain text format.

Returns:
  An object of the form:

    {
    "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#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "items": [ # A list of comments that match the request criteria.
      { # A comment represents a single YouTube comment.
        "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
          "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
          "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
          "authorDisplayName": "A String", # The name of the user who posted the comment.
          "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
          "videoId": "A String", # The ID of the video the comment refers to, if any.
          "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
          "likeCount": 42, # The total number of likes this comment has received.
          "authorChannelId": "", # The id of the author's YouTube channel, if any.
          "parentId": "A String", # The unique id of the parent comment, only set for replies.
          "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
          "canRate": True or False, # Whether the current viewer can rate this comment.
          "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
          "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
          "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
          "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
          "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        },
        "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
      "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.
markAsSpam(id) 
Expresses the caller's opinion that one or more comments should be flagged as spam.

Args:
  id: string, The id parameter specifies a comma-separated list of IDs of comments that the caller believes should be classified as spam. (required)
setModerationStatus(id, moderationStatus, banAuthor=None) 
Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.

Args:
  id: string, The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status. (required)
  moderationStatus: string, Identifies the new moderation status of the specified comments. (required)
    Allowed values
      heldForReview - Marks a comment as awaiting review by a moderator.
      published - Clears a comment for public display.
      rejected - Rejects a comment as being unfit for display. This action also effectively hides all replies to the rejected comment.

Note: The API does not currently provide a way to list or otherwise discover rejected comments. However, you can change the moderation status of a rejected comment if you still know its ID. If you were to change the moderation status of a rejected comment, the comment replies would subsequently be discoverable again as well.
  banAuthor: boolean, The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author.

Note: This parameter is only valid if the moderationStatus parameter is also set to rejected.
update(part, body) 
Modifies a comment.

Args:
  part: string, The part parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A comment represents a single YouTube comment.
  "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
    "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
    "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
    "authorDisplayName": "A String", # The name of the user who posted the comment.
    "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
    "videoId": "A String", # The ID of the video the comment refers to, if any.
    "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
    "likeCount": 42, # The total number of likes this comment has received.
    "authorChannelId": "", # The id of the author's YouTube channel, if any.
    "parentId": "A String", # The unique id of the parent comment, only set for replies.
    "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    "canRate": True or False, # Whether the current viewer can rate this comment.
    "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
    "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
    "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
    "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
  },
  "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
}


Returns:
  An object of the form:

    { # A comment represents a single YouTube comment.
    "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
      "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
      "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
      "authorDisplayName": "A String", # The name of the user who posted the comment.
      "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
      "videoId": "A String", # The ID of the video the comment refers to, if any.
      "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
      "likeCount": 42, # The total number of likes this comment has received.
      "authorChannelId": "", # The id of the author's YouTube channel, if any.
      "parentId": "A String", # The unique id of the parent comment, only set for replies.
      "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "canRate": True or False, # Whether the current viewer can rate this comment.
      "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
      "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
      "authorGoogleplusProfileUrl": "A String", # Link to the author's Google+ profile, if any.
      "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
    },
    "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.fanFundingEvents.html000066400000000000000000000134621300622755700263340ustar00rootroot00000000000000

YouTube Data API . fanFundingEvents

Instance Methods

list(part, pageToken=None, hl=None, maxResults=None)

Lists fan funding events for a channel.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(part, pageToken=None, hl=None, maxResults=None) 
Lists fan funding events for a channel.

Args:
  part: string, The part parameter specifies the fanFundingEvent resource parts that the API response will include. Supported values are id and snippet. (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.
  hl: string, The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Returns:
  An object of the form:

    {
    "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#fanFundingEventListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#fanFundingEventListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "items": [ # A list of fan funding events that match the request criteria.
      { # A fanFundingEvent resource represents a fan funding event on a YouTube channel. Fan funding events occur when a user gives one-time monetary support to the channel owner.
        "snippet": { # The snippet object contains basic details about the fan funding event.
          "commentText": "A String", # The text contents of the comment left by the user.
          "channelId": "A String", # Channel id where the funding event occurred.
          "supporterDetails": { # Details about the supporter. Only filled if the event was made public by the user.
            "channelId": "A String", # The YouTube channel ID.
            "displayName": "A String", # The channel's display name.
            "profileImageUrl": "A String", # The channels's avatar URL.
            "channelUrl": "A String", # The channel's URL.
          },
          "amountMicros": "A String", # The amount of funding in micros of fund_currency. e.g., 1 is represented
          "currency": "A String", # The currency in which the fund was made. ISO 4217.
          "displayString": "A String", # A rendered string that displays the fund amount and currency (e.g., "$1.00"). The string is rendered for the given language.
          "createdAt": "A String", # The date and time when the funding occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        },
        "kind": "youtube#fanFundingEvent", # Identifies what kind of resource this is. Value: the fixed string "youtube#fanFundingEvent".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube assigns to uniquely identify the fan funding event.
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
      "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.
google-api-python-client-1.5.5/docs/dyn/youtube_v3.guideCategories.html000066400000000000000000000105641300622755700261730ustar00rootroot00000000000000

YouTube Data API . guideCategories

Instance Methods

list(part, regionCode=None, hl=None, id=None)

Returns a list of categories that can be associated with YouTube channels.

Method Details

list(part, 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 the guideCategory resource properties that the API response will include. Set the parameter value to snippet. (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:

    {
    "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#guideCategoryListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "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", # Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the guide category.
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "totalResults": 42, # The total number of results in the result set.
      "resultsPerPage": 42, # The number of results included in the API response.
    },
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.html000066400000000000000000000141221300622755700230630ustar00rootroot00000000000000

YouTube Data API

Instance Methods

activities()

Returns the activities Resource.

captions()

Returns the captions Resource.

channelBanners()

Returns the channelBanners Resource.

channelSections()

Returns the channelSections Resource.

channels()

Returns the channels Resource.

commentThreads()

Returns the commentThreads Resource.

comments()

Returns the comments Resource.

fanFundingEvents()

Returns the fanFundingEvents Resource.

guideCategories()

Returns the guideCategories Resource.

i18nLanguages()

Returns the i18nLanguages Resource.

i18nRegions()

Returns the i18nRegions Resource.

liveBroadcasts()

Returns the liveBroadcasts Resource.

liveChatBans()

Returns the liveChatBans Resource.

liveChatMessages()

Returns the liveChatMessages Resource.

liveChatModerators()

Returns the liveChatModerators Resource.

liveStreams()

Returns the liveStreams Resource.

playlistItems()

Returns the playlistItems Resource.

playlists()

Returns the playlists Resource.

search()

Returns the search Resource.

sponsors()

Returns the sponsors Resource.

subscriptions()

Returns the subscriptions Resource.

thumbnails()

Returns the thumbnails Resource.

videoAbuseReportReasons()

Returns the videoAbuseReportReasons Resource.

videoCategories()

Returns the videoCategories Resource.

videos()

Returns the videos Resource.

watermarks()

Returns the watermarks Resource.

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

Method Details

new_batch_http_request() 
Create a BatchHttpRequest object based on the discovery document.

        Args:
          callback: callable, A callback to be called for each response, of the
            form callback(id, response, exception). The first parameter is the
            request id, and the second is the deserialized response object. The
            third is an apiclient.errors.HttpError exception object if an HTTP
            error occurred while processing the request, or None if no error
            occurred.

        Returns:
          A BatchHttpRequest object based on the discovery document.
google-api-python-client-1.5.5/docs/dyn/youtube_v3.i18nLanguages.html000066400000000000000000000061011300622755700254660ustar00rootroot00000000000000

YouTube Data API . i18nLanguages

Instance Methods

list(part, hl=None)

Returns a list of application languages that the YouTube website supports.

Method Details

list(part, hl=None) 
Returns a list of application languages that the YouTube website supports.

Args:
  part: string, The part parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet. (required)
  hl: string, The hl parameter specifies the language that should be used for text values in the API response.

Returns:
  An object of the form:

    {
    "eventId": "A String", # Serialized EventId of the request which produced this response.
    "items": [ # A list of supported i18n languages. In this map, the i18n language ID is the map key, and its value is the corresponding i18nLanguage resource.
      { # An i18nLanguage resource identifies a UI language currently supported by YouTube.
        "snippet": { # Basic details about an i18n language, such as language code and human-readable name. # The snippet object contains basic details about the i18n language, such as language code and human-readable name.
          "name": "A String", # The human-readable name of the language in the language itself.
          "hl": "A String", # A short BCP-47 code that uniquely identifies a language.
        },
        "kind": "youtube#i18nLanguage", # Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguage".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the i18n language.
      },
    ],
    "kind": "youtube#i18nLanguageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguageListResponse".
    "etag": "A String", # Etag of this resource.
    "visitorId": "A String", # The visitorId identifies the visitor.
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.i18nRegions.html000066400000000000000000000057651300622755700252050ustar00rootroot00000000000000

YouTube Data API . i18nRegions

Instance Methods

list(part, hl=None)

Returns a list of content regions that the YouTube website supports.

Method Details

list(part, hl=None) 
Returns a list of content regions that the YouTube website supports.

Args:
  part: string, The part parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet. (required)
  hl: string, The hl parameter specifies the language that should be used for text values in the API response.

Returns:
  An object of the form:

    {
    "eventId": "A String", # Serialized EventId of the request which produced this response.
    "items": [ # A list of regions where YouTube is available. In this map, the i18n region ID is the map key, and its value is the corresponding i18nRegion resource.
      { # A i18nRegion resource identifies a region where YouTube is available.
        "snippet": { # Basic details about an i18n region, such as region code and human-readable name. # The snippet object contains basic details about the i18n region, such as region code and human-readable name.
          "gl": "A String", # The region code as a 2-letter ISO country code.
          "name": "A String", # The human-readable name of the region.
        },
        "kind": "youtube#i18nRegion", # Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegion".
        "etag": "A String", # Etag of this resource.
        "id": "A String", # The ID that YouTube uses to uniquely identify the i18n region.
      },
    ],
    "kind": "youtube#i18nRegionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegionListResponse".
    "etag": "A String", # Etag of this resource.
    "visitorId": "A String", # The visitorId identifies the visitor.
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.liveBroadcasts.html000066400000000000000000003377551300622755700260530ustar00rootroot00000000000000

YouTube Data API . liveBroadcasts

Instance Methods

bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=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, though a video stream may be bound to more than one broadcast.

control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)

Controls the settings for a slate that can be displayed in the broadcast stream.

delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

Deletes a broadcast.

insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

Creates a broadcast.

list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, broadcastType=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, onBehalfOfContentOwnerChannel=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. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.

update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=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, onBehalfOfContentOwnerChannel=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, though a video stream may be bound to more than one broadcast.

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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
  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.
      "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
    },
    "topicDetails": {
      "topics": [
        {
          "snippet": { # Information about the topic matched.
            "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
            "name": "A String", # The name of the topic.
          },
          "type": "A String", # The type of the topic.
          "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
        },
      ],
    },
    "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
    "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
      "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
      "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
    },
    "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.
      "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
      "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
      "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.
      },
      "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
      "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.
      "closedCaptionsType": "A String",
      "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.
      "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
    },
    "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.
      "liveChatId": "A String", # The id of the live chat for this broadcast.
      "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.
      "isDefaultBroadcast": True or False,
      "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, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None) 
Controls the settings for a slate that can be displayed in the broadcast stream.

Args:
  id: string, The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated. (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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  displaySlate: boolean, The displaySlate parameter specifies whether the slate is being enabled or disabled.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
  offsetTimeMs: string, The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time.

If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details.

Important: You should only specify a value for this parameter if your broadcast stream is delayed.
  walltime: string, The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.

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.
      "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
    },
    "topicDetails": {
      "topics": [
        {
          "snippet": { # Information about the topic matched.
            "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
            "name": "A String", # The name of the topic.
          },
          "type": "A String", # The type of the topic.
          "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
        },
      ],
    },
    "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
    "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
      "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
      "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
    },
    "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.
      "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
      "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
      "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.
      },
      "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
      "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.
      "closedCaptionsType": "A String",
      "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.
      "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
    },
    "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.
      "liveChatId": "A String", # The id of the live chat for this broadcast.
      "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.
      "isDefaultBroadcast": True or False,
      "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, onBehalfOfContentOwnerChannel=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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=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.
    "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
  },
  "topicDetails": {
    "topics": [
      {
        "snippet": { # Information about the topic matched.
          "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
          "name": "A String", # The name of the topic.
        },
        "type": "A String", # The type of the topic.
        "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
      },
    ],
  },
  "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
  "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
    "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
    "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
  },
  "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.
    "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
    "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
    "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.
    },
    "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
    "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.
    "closedCaptionsType": "A String",
    "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.
    "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
  },
  "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.
    "liveChatId": "A String", # The id of the live chat for this broadcast.
    "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.
    "isDefaultBroadcast": True or False,
    "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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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.
      "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
    },
    "topicDetails": {
      "topics": [
        {
          "snippet": { # Information about the topic matched.
            "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
            "name": "A String", # The name of the topic.
          },
          "type": "A String", # The type of the topic.
          "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
        },
      ],
    },
    "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
    "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
      "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
      "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
    },
    "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.
      "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
      "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
      "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.
      },
      "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
      "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.
      "closedCaptionsType": "A String",
      "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.
      "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
    },
    "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.
      "liveChatId": "A String", # The id of the live chat for this broadcast.
      "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.
      "isDefaultBroadcast": True or False,
      "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, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, broadcastType=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.
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  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.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  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.
  broadcastType: string, The broadcastType parameter filters the API response to only include broadcasts with the specified type. This is only compatible with the mine filter for now.
    Allowed values
      all - Return all broadcasts.
      event - Return only scheduled event broadcasts.
      persistent - Return only persistent broadcasts.
  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:

    {
    "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#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".
    "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.
          "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
        },
        "topicDetails": {
          "topics": [
            {
              "snippet": { # Information about the topic matched.
                "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
                "name": "A String", # The name of the topic.
              },
              "type": "A String", # The type of the topic.
              "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
            },
          ],
        },
        "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
        "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
          "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
          "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
        },
        "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.
          "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
          "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
          "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.
          },
          "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
          "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.
          "closedCaptionsType": "A String",
          "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.
          "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
        },
        "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.
          "liveChatId": "A String", # The id of the live chat for this broadcast.
          "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.
          "isDefaultBroadcast": True or False,
          "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.
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "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, onBehalfOfContentOwnerChannel=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. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.

Args:
  broadcastStatus: string, The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to. (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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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.
      "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
    },
    "topicDetails": {
      "topics": [
        {
          "snippet": { # Information about the topic matched.
            "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
            "name": "A String", # The name of the topic.
          },
          "type": "A String", # The type of the topic.
          "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
        },
      ],
    },
    "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
    "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
      "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
      "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
    },
    "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.
      "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
      "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
      "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.
      },
      "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
      "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.
      "closedCaptionsType": "A String",
      "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.
      "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
    },
    "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.
      "liveChatId": "A String", # The id of the live chat for this broadcast.
      "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.
      "isDefaultBroadcast": True or False,
      "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, onBehalfOfContentOwnerChannel=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.
    "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
  },
  "topicDetails": {
    "topics": [
      {
        "snippet": { # Information about the topic matched.
          "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
          "name": "A String", # The name of the topic.
        },
        "type": "A String", # The type of the topic.
        "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
      },
    ],
  },
  "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
  "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
    "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
    "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
  },
  "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.
    "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
    "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
    "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.
    },
    "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
    "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.
    "closedCaptionsType": "A String",
    "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.
    "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
  },
  "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.
    "liveChatId": "A String", # The id of the live chat for this broadcast.
    "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.
    "isDefaultBroadcast": True or False,
    "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, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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.
      "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
    },
    "topicDetails": {
      "topics": [
        {
          "snippet": { # Information about the topic matched.
            "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
            "name": "A String", # The name of the topic.
          },
          "type": "A String", # The type of the topic.
          "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
        },
      ],
    },
    "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
    "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
      "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
      "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
    },
    "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.
      "projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
      "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
      "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.
      },
      "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 HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
      "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.
      "closedCaptionsType": "A String",
      "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.
      "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
    },
    "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.
      "liveChatId": "A String", # The id of the live chat for this broadcast.
      "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.
      "isDefaultBroadcast": True or False,
      "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.
  }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.liveChatBans.html000066400000000000000000000076461300622755700254420ustar00rootroot00000000000000

YouTube Data API . liveChatBans

Instance Methods

delete(id)

Removes a chat ban.

insert(part, body)

Adds a new ban to the chat.

Method Details

delete(id) 
Removes a chat ban.

Args:
  id: string, The id parameter identifies the chat ban to remove. The value uniquely identifies both the ban and the chat. (required)
insert(part, body) 
Adds a new ban to the chat.

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 returns. Set the parameter value to snippet. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A liveChatBan resource represents a ban for a YouTube live chat.
    "snippet": { # The snippet object contains basic details about the ban.
      "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
      "liveChatId": "A String", # The chat this ban is pertinent to.
      "bannedUserDetails": {
        "channelId": "A String", # The YouTube channel ID.
        "displayName": "A String", # The channel's display name.
        "profileImageUrl": "A String", # The channels's avatar URL.
        "channelUrl": "A String", # The channel's URL.
      },
      "type": "A String", # The type of ban.
    },
    "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
  }


Returns:
  An object of the form:

    { # A liveChatBan resource represents a ban for a YouTube live chat.
      "snippet": { # The snippet object contains basic details about the ban.
        "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
        "liveChatId": "A String", # The chat this ban is pertinent to.
        "bannedUserDetails": {
          "channelId": "A String", # The YouTube channel ID.
          "displayName": "A String", # The channel's display name.
          "profileImageUrl": "A String", # The channels's avatar URL.
          "channelUrl": "A String", # The channel's URL.
        },
        "type": "A String", # The type of ban.
      },
      "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.liveChatMessages.html000066400000000000000000000467131300622755700263240ustar00rootroot00000000000000

YouTube Data API . liveChatMessages

Instance Methods

delete(id)

Deletes a chat message.

insert(part, body)

Adds a message to a live chat.

list(liveChatId, part, profileImageSize=None, hl=None, maxResults=None, pageToken=None)

Lists live chat messages for a specific chat.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(id) 
Deletes a chat message.

Args:
  id: string, The id parameter specifies the YouTube chat message ID of the resource that is being deleted. (required)
insert(part, body) 
Adds a message to a live chat.

Args:
  part: string, The part parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A liveChatMessage resource represents a chat message in a YouTube Live Chat.
    "snippet": { # The snippet object contains basic details about the message.
      "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
      "messageRetractedDetails": {
        "retractedMessageId": "A String",
      },
      "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
        "currency": "A String", # The currency in which the fund was made.
        "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
        "userComment": "A String", # The comment added by the user to this fan funding event.
        "amountMicros": "A String", # The amount of the fund.
      },
      "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
      "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
      "userBannedDetails": {
        "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
        "bannedUserDetails": { # The details of the user that was banned.
          "channelId": "A String", # The YouTube channel ID.
          "displayName": "A String", # The channel's display name.
          "profileImageUrl": "A String", # The channels's avatar URL.
          "channelUrl": "A String", # The channel's URL.
        },
        "banType": "A String", # The type of ban.
      },
      "liveChatId": "A String",
      "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action
      "pollEditedDetails": {
        "items": [
          {
            "itemId": "A String",
            "description": "A String", # Plain text description of the item.
          },
        ],
        "prompt": "A String",
        "id": "A String",
      },
      "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
        "messageText": "A String", # The user's message.
      },
      "messageDeletedDetails": {
        "deletedMessageId": "A String",
      },
      "pollVotedDetails": {
        "itemId": "A String", # The poll item the user chose.
        "pollId": "A String", # The poll the user voted on.
      },
      "pollOpenedDetails": {
        "items": [
          {
            "itemId": "A String",
            "description": "A String", # Plain text description of the item.
          },
        ],
        "prompt": "A String",
        "id": "A String",
      },
      "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
      "pollClosedDetails": {
        "pollId": "A String", # The id of the poll that was closed.
      },
    },
    "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
    "etag": "A String", # Etag of this resource.
    "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
      "displayName": "A String", # The channel's display name.
      "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
      "channelId": "A String", # The YouTube channel ID.
      "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
      "profileImageUrl": "A String", # The channels's avatar URL.
      "isChatOwner": True or False, # Whether the author is the owner of the live chat.
      "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
      "channelUrl": "A String", # The channel's URL.
    },
    "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
  }


Returns:
  An object of the form:

    { # A liveChatMessage resource represents a chat message in a YouTube Live Chat.
      "snippet": { # The snippet object contains basic details about the message.
        "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
        "messageRetractedDetails": {
          "retractedMessageId": "A String",
        },
        "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
          "currency": "A String", # The currency in which the fund was made.
          "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
          "userComment": "A String", # The comment added by the user to this fan funding event.
          "amountMicros": "A String", # The amount of the fund.
        },
        "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
        "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
        "userBannedDetails": {
          "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
          "bannedUserDetails": { # The details of the user that was banned.
            "channelId": "A String", # The YouTube channel ID.
            "displayName": "A String", # The channel's display name.
            "profileImageUrl": "A String", # The channels's avatar URL.
            "channelUrl": "A String", # The channel's URL.
          },
          "banType": "A String", # The type of ban.
        },
        "liveChatId": "A String",
        "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action
        "pollEditedDetails": {
          "items": [
            {
              "itemId": "A String",
              "description": "A String", # Plain text description of the item.
            },
          ],
          "prompt": "A String",
          "id": "A String",
        },
        "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
          "messageText": "A String", # The user's message.
        },
        "messageDeletedDetails": {
          "deletedMessageId": "A String",
        },
        "pollVotedDetails": {
          "itemId": "A String", # The poll item the user chose.
          "pollId": "A String", # The poll the user voted on.
        },
        "pollOpenedDetails": {
          "items": [
            {
              "itemId": "A String",
              "description": "A String", # Plain text description of the item.
            },
          ],
          "prompt": "A String",
          "id": "A String",
        },
        "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
        "pollClosedDetails": {
          "pollId": "A String", # The id of the poll that was closed.
        },
      },
      "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
      "etag": "A String", # Etag of this resource.
      "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
        "displayName": "A String", # The channel's display name.
        "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
        "channelId": "A String", # The YouTube channel ID.
        "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
        "profileImageUrl": "A String", # The channels's avatar URL.
        "isChatOwner": True or False, # Whether the author is the owner of the live chat.
        "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
        "channelUrl": "A String", # The channel's URL.
      },
      "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
    }
list(liveChatId, part, profileImageSize=None, hl=None, maxResults=None, pageToken=None) 
Lists live chat messages for a specific chat.

Args:
  liveChatId: string, The liveChatId parameter specifies the ID of the chat whose messages will be returned. (required)
  part: string, The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required)
  profileImageSize: integer, The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88.
  hl: string, The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
  maxResults: integer, The maxResults parameter specifies the maximum number of messages that should be returned in the result set.
  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.

Returns:
  An object of the form:

    {
    "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#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "items": [ # A list of live chat messages.
      { # A liveChatMessage resource represents a chat message in a YouTube Live Chat.
          "snippet": { # The snippet object contains basic details about the message.
            "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
            "messageRetractedDetails": {
              "retractedMessageId": "A String",
            },
            "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
              "currency": "A String", # The currency in which the fund was made.
              "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
              "userComment": "A String", # The comment added by the user to this fan funding event.
              "amountMicros": "A String", # The amount of the fund.
            },
            "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
            "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
            "userBannedDetails": {
              "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
              "bannedUserDetails": { # The details of the user that was banned.
                "channelId": "A String", # The YouTube channel ID.
                "displayName": "A String", # The channel's display name.
                "profileImageUrl": "A String", # The channels's avatar URL.
                "channelUrl": "A String", # The channel's URL.
              },
              "banType": "A String", # The type of ban.
            },
            "liveChatId": "A String",
            "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action
            "pollEditedDetails": {
              "items": [
                {
                  "itemId": "A String",
                  "description": "A String", # Plain text description of the item.
                },
              ],
              "prompt": "A String",
              "id": "A String",
            },
            "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
              "messageText": "A String", # The user's message.
            },
            "messageDeletedDetails": {
              "deletedMessageId": "A String",
            },
            "pollVotedDetails": {
              "itemId": "A String", # The poll item the user chose.
              "pollId": "A String", # The poll the user voted on.
            },
            "pollOpenedDetails": {
              "items": [
                {
                  "itemId": "A String",
                  "description": "A String", # Plain text description of the item.
                },
              ],
              "prompt": "A String",
              "id": "A String",
            },
            "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
            "pollClosedDetails": {
              "pollId": "A String", # The id of the poll that was closed.
            },
          },
          "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
          "etag": "A String", # Etag of this resource.
          "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
            "displayName": "A String", # The channel's display name.
            "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
            "channelId": "A String", # The YouTube channel ID.
            "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
            "profileImageUrl": "A String", # The channels's avatar URL.
            "isChatOwner": True or False, # Whether the author is the owner of the live chat.
            "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
            "channelUrl": "A String", # The channel's URL.
          },
          "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
        },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "pollingIntervalMillis": 42, # The amount of time the client should wait before polling again.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
      "totalResults": 42, # The total number of results in the result set.
      "resultsPerPage": 42, # The number of results included in the API response.
    },
    "offlineAt": "A String", # The date and time when the underlying stream went offline. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
  }
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.
google-api-python-client-1.5.5/docs/dyn/youtube_v3.liveChatModerators.html000066400000000000000000000174511300622755700266710ustar00rootroot00000000000000

YouTube Data API . liveChatModerators

Instance Methods

delete(id)

Removes a chat moderator.

insert(part, body)

Adds a new moderator for the chat.

list(liveChatId, part, maxResults=None, pageToken=None)

Lists moderators for a live chat.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(id) 
Removes a chat moderator.

Args:
  id: string, The id parameter identifies the chat moderator to remove. The value uniquely identifies both the moderator and the chat. (required)
insert(part, body) 
Adds a new moderator for the chat.

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 returns. Set the parameter value to snippet. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
    "snippet": { # The snippet object contains basic details about the moderator.
      "liveChatId": "A String", # The ID of the live chat this moderator can act on.
      "moderatorDetails": { # Details about the moderator.
        "channelId": "A String", # The YouTube channel ID.
        "displayName": "A String", # The channel's display name.
        "profileImageUrl": "A String", # The channels's avatar URL.
        "channelUrl": "A String", # The channel's URL.
      },
    },
    "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
  }


Returns:
  An object of the form:

    { # A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
      "snippet": { # The snippet object contains basic details about the moderator.
        "liveChatId": "A String", # The ID of the live chat this moderator can act on.
        "moderatorDetails": { # Details about the moderator.
          "channelId": "A String", # The YouTube channel ID.
          "displayName": "A String", # The channel's display name.
          "profileImageUrl": "A String", # The channels's avatar URL.
          "channelUrl": "A String", # The channel's URL.
        },
      },
      "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
    }
list(liveChatId, part, maxResults=None, pageToken=None) 
Lists moderators for a live chat.

Args:
  liveChatId: string, The liveChatId parameter specifies the YouTube live chat for which the API should return moderators. (required)
  part: string, The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet. (required)
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  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.

Returns:
  An object of the form:

    {
    "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#liveChatModeratorListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "items": [ # A list of moderators that match the request criteria.
      { # A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
          "snippet": { # The snippet object contains basic details about the moderator.
            "liveChatId": "A String", # The ID of the live chat this moderator can act on.
            "moderatorDetails": { # Details about the moderator.
              "channelId": "A String", # The YouTube channel ID.
              "displayName": "A String", # The channel's display name.
              "profileImageUrl": "A String", # The channels's avatar URL.
              "channelUrl": "A String", # The channel's URL.
            },
          },
          "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
        },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "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.
google-api-python-client-1.5.5/docs/dyn/youtube_v3.liveStreams.html000066400000000000000000001131051300622755700253610ustar00rootroot00000000000000

YouTube Data API . liveStreams

Instance Methods

delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

Deletes a video stream.

insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

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, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=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, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

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, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None) 
Deletes a video stream.

Args:
  id: string, The id parameter specifies the YouTube live stream ID for the resource that is being deleted. (required)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None) 
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",
      "healthStatus": { # The health status of the stream.
        "status": "A String", # The status code of this stream
        "configurationIssues": [ # The configurations issues on this stream
          {
            "reason": "A String", # The short-form reason for this issue.
            "type": "A String", # The kind of error happening.
            "description": "A String", # The long-form description of the issue and how to resolve it.
            "severity": "A String", # How severe this issue is to the stream.
          },
        ],
        "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
      },
    },
    "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
    "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
      "isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.
          #
          # If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:
          # - A non-reusable stream can only be bound to one broadcast.
          # - A non-reusable stream might be deleted by an automated process after the broadcast ends.
          # - The  liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.
      "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
      },
      "frameRate": "A String", # The frame rate of the inbound video data.
      "resolution": "A String", # The resolution of the inbound video data.
      "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.
      "isDefaultStream": True or False,
      "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.
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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",
        "healthStatus": { # The health status of the stream.
          "status": "A String", # The status code of this stream
          "configurationIssues": [ # The configurations issues on this stream
            {
              "reason": "A String", # The short-form reason for this issue.
              "type": "A String", # The kind of error happening.
              "description": "A String", # The long-form description of the issue and how to resolve it.
              "severity": "A String", # How severe this issue is to the stream.
            },
          ],
          "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
        },
      },
      "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
      "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
        "isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.
            #
            # If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:
            # - A non-reusable stream can only be bound to one broadcast.
            # - A non-reusable stream might be deleted by an automated process after the broadcast ends.
            # - The  liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.
        "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
        },
        "frameRate": "A String", # The frame rate of the inbound video data.
        "resolution": "A String", # The resolution of the inbound video data.
        "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.
        "isDefaultStream": True or False,
        "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, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=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)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  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.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  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.
  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:

    {
    "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#liveStreamListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse".
    "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",
            "healthStatus": { # The health status of the stream.
              "status": "A String", # The status code of this stream
              "configurationIssues": [ # The configurations issues on this stream
                {
                  "reason": "A String", # The short-form reason for this issue.
                  "type": "A String", # The kind of error happening.
                  "description": "A String", # The long-form description of the issue and how to resolve it.
                  "severity": "A String", # How severe this issue is to the stream.
                },
              ],
              "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
            },
          },
          "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
          "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
            "isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.
                #
                # If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:
                # - A non-reusable stream can only be bound to one broadcast.
                # - A non-reusable stream might be deleted by an automated process after the broadcast ends.
                # - The  liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.
            "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
            },
            "frameRate": "A String", # The frame rate of the inbound video data.
            "resolution": "A String", # The resolution of the inbound video data.
            "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.
            "isDefaultStream": True or False,
            "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.
        },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "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, onBehalfOfContentOwnerChannel=None) 
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",
      "healthStatus": { # The health status of the stream.
        "status": "A String", # The status code of this stream
        "configurationIssues": [ # The configurations issues on this stream
          {
            "reason": "A String", # The short-form reason for this issue.
            "type": "A String", # The kind of error happening.
            "description": "A String", # The long-form description of the issue and how to resolve it.
            "severity": "A String", # How severe this issue is to the stream.
          },
        ],
        "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
      },
    },
    "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
    "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
      "isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.
          #
          # If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:
          # - A non-reusable stream can only be bound to one broadcast.
          # - A non-reusable stream might be deleted by an automated process after the broadcast ends.
          # - The  liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.
      "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
      },
      "frameRate": "A String", # The frame rate of the inbound video data.
      "resolution": "A String", # The resolution of the inbound video data.
      "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.
      "isDefaultStream": True or False,
      "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.
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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",
        "healthStatus": { # The health status of the stream.
          "status": "A String", # The status code of this stream
          "configurationIssues": [ # The configurations issues on this stream
            {
              "reason": "A String", # The short-form reason for this issue.
              "type": "A String", # The kind of error happening.
              "description": "A String", # The long-form description of the issue and how to resolve it.
              "severity": "A String", # How severe this issue is to the stream.
            },
          ],
          "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
        },
      },
      "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
      "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
        "isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.
            #
            # If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:
            # - A non-reusable stream can only be bound to one broadcast.
            # - A non-reusable stream might be deleted by an automated process after the broadcast ends.
            # - The  liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.
        "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
        },
        "frameRate": "A String", # The frame rate of the inbound video data.
        "resolution": "A String", # The resolution of the inbound video data.
        "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.
        "isDefaultStream": True or False,
        "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.
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.playlistItems.html000066400000000000000000001243121300622755700257300ustar00rootroot00000000000000

YouTube Data API . playlistItems

Instance Methods

delete(id)

Deletes a playlist item.

insert(part, body, onBehalfOfContentOwner=None)

Adds a resource to a playlist.

list(part=None, onBehalfOfContentOwner=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, body, onBehalfOfContentOwner=None) 
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. (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", # Identifies what kind of resource this is. Value: the fixed string "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.
  }

  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

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", # Identifies what kind of resource this is. Value: the fixed string "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, onBehalfOfContentOwner=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.

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)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
  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.
  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, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  id: string, The id parameter specifies a comma-separated list of one or more unique playlist item IDs.

Returns:
  An object of the form:

    {
    "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#playlistItemListResponse", # Identifies what kind of resource this is. Value: the fixed string "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", # Identifies what kind of resource this is. Value: the fixed string "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.
        },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "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.
      "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.

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", # Identifies what kind of resource this is. Value: the fixed string "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", # Identifies what kind of resource this is. Value: the fixed string "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.
    }
google-api-python-client-1.5.5/docs/dyn/youtube_v3.playlists.html000066400000000000000000001166701300622755700251210ustar00rootroot00000000000000

YouTube Data API . playlists

Instance Methods

delete(id, onBehalfOfContentOwner=None)

Deletes a playlist.

insert(part, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

Creates a playlist.

list(part=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, hl=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, onBehalfOfContentOwner=None)

Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.

Method Details

delete(id, onBehalfOfContentOwner=None) 
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)
  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
insert(part, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None) 
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. (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", # Identifies what kind of resource this is. Value: the fixed string "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.
      "description": "A String", # The playlist's description.
      "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.
      "defaultLanguage": "A String", # The language of the playlist's default title and description.
      "localized": { # Playlist localization setting # Localized title and description, read-only.
        "description": "A String", # The localized strings for playlist's description.
        "title": "A String", # The localized strings for playlist's title.
      },
      "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.
        },
      },
    },
    "player": { # The player object contains information that you would use to play the playlist in an embedded player.
      "embedHtml": "A String", # An